org.sdmxsource.sdmx.api.model.beans.registry

Interface KeyValues

All Superinterfaces:

SDMXBean, SdmxStructureBean, java.io.Serializable

All Known Subinterfaces:

MetadataTargetKeyValuesBean

All Known Implementing Classes:

KeyValuesImpl, MetadataTargetKeyValuesBeanImpl

public interface KeyValues
extends SdmxStructureBean

Represents an SDMX KeyValues as defined in a SDMX ContentConstraint

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCascadeValues() Returns a list of all the values which are cascade values
java.lang.String	getId() Returns the identifier of the component that the values are for
TimeRangeBean	getTimeRange() Returns the time range that is being constrained, this is mutually exclusive with the getValues()
java.util.List<java.lang.String>	getValues() Returns a copy of the list of the allowed / disallowed values in the constraint.
boolean	isCascadeValue(java.lang.String value) Where the values are coded, and the codes have child codes, if a value if to be cascaded, then include all the child codes in the constraint for inclusion / exclusion

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.SdmxStructureBean

getIdentifiableComposites, getIdentifiableParent, getMaintainableParent, getParent

Methods inherited from interface org.sdmxsource.sdmx.api.model.beans.base.SDMXBean

deepEquals, getComposites, getComposites, getCrossReferences, getParent, getStructureType

Method Detail

getId

java.lang.String getId()

Returns the identifier of the component that the values are for

Returns:

getValues

java.util.List<java.lang.String> getValues()

Returns a copy of the list of the allowed / disallowed values in the constraint.

This is mutually exclusive with the getTimeRange() method, and will return an empty list if getTimeRange() returns a non-null value

Returns:

getCascadeValues

java.util.List<java.lang.String> getCascadeValues()

Returns a list of all the values which are cascade values

Returns:

isCascadeValue

boolean isCascadeValue(java.lang.String value)

Where the values are coded, and the codes have child codes, if a value if to be cascaded, then include all the child codes in the constraint for inclusion / exclusion

Parameters:

value - - the code id to check if it is to be cascaded (must exist in the getValues() list)

Returns:

true if the value is set to be cascaded

getTimeRange

TimeRangeBean getTimeRange()

Returns the time range that is being constrained, this is mutually exclusive with the getValues()

Returns: