org.sdmxsource.sdmx.sdmxbeans.model.beans.codelist

Class HierarchicalCodeBeanImpl

java.lang.Object

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SDMXBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SdmxStructureBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.AnnotableBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.base.IdentifiableBeanImpl

org.sdmxsource.sdmx.sdmxbeans.model.beans.codelist.HierarchicalCodeBeanImpl

All Implemented Interfaces:

java.io.Serializable, AnnotableBean, IdentifiableBean, SDMXBean, SdmxStructureBean, HierarchicalCodeBean

public class HierarchicalCodeBeanImpl
extends IdentifiableBeanImpl
implements HierarchicalCodeBean

CodeRefBean represents a Codelist item in a HierarchicalCodelistBean, named from the 2.0 SDMX Schema (in 2.1 it is called a HierarchicalCode). It can have child CodeRefBeans.

Author:

richard

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HierarchicalCodeBeanImpl(CodeRefMutableBean bean, SdmxStructureBean parent)
HierarchicalCodeBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.structure.CodeRefType codeRef, SdmxStructureBean parent)
HierarchicalCodeBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.HierarchicalCodeType codeRef, SdmxStructureBean parent)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	deepEquals(SDMXBean bean, boolean includeFinalProperties) Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration) This method calls deepEquals on any SdmxBean composites.
java.lang.String	getCodeId() Returns the code id of the code being referenced, to be used in conjunction with the codelist alias ref
java.lang.String	getCodelistAliasRef() Returns the codelist alias used to resolve this codelist reference, returns null if the reference is achieved by using the CrossReferenceBean (getCodeReference() returns a value)
CrossReferenceBean	getCodeReference() Returns the code referenced by this CodeRef, this will never be null as it will be resolved from the codelist alias and code id
java.util.List<HierarchicalCodeBean>	getCodeRefs() Returns any child HierarchicalCodeBean beans as a copy of the underlying list.
LevelBean	getLevel(boolean acceptDefault)
int	getLevelInHierarchy() Returns the level of this code ref bean in the hierarchy, 1 indexed
SdmxDate	getValidFrom()
SdmxDate	getValidTo()

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.IdentifiableBeanImpl

asReference, equals, getAllTextTypes, getFullIdPath, getId, getUri, getUrn, hashCode, toString

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.AnnotableBeanImpl

getAnnotations, getAnnotationsByTitle, getAnnotationsByType, hasAnnotationType

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SdmxStructureBeanImpl

getIdentifiableComposites, getIdentifiableParent, getMaintainableParent, getParent, getStructureType

Methods inherited from class org.sdmxsource.sdmx.sdmxbeans.model.beans.base.SDMXBeanImpl

getComposites, getComposites, getCrossReferences, getParent

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

asReference, getAllTextTypes, getFullIdPath, getId, getUri, getUrn

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

getAnnotations, getAnnotationsByTitle, getAnnotationsByType, hasAnnotationType

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

getComposites, getComposites, getCrossReferences, getParent, getStructureType

Constructor Detail

HierarchicalCodeBeanImpl

public HierarchicalCodeBeanImpl(CodeRefMutableBean bean,
                        SdmxStructureBean parent)

HierarchicalCodeBeanImpl

public HierarchicalCodeBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.HierarchicalCodeType codeRef,
                        SdmxStructureBean parent)

HierarchicalCodeBeanImpl

public HierarchicalCodeBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.structure.CodeRefType codeRef,
                        SdmxStructureBean parent)

Method Detail

deepEquals

public boolean deepEquals(SDMXBean bean,
                 boolean includeFinalProperties)

Description copied from interface: SDMXBean

Returns true if this SdmxBean equals the given bean in every respect (except for the validTo property of a maintainable artefact, this is not taken into consideration)

This method calls deepEquals on any SdmxBean composites.

Specified by:

deepEquals in interface SDMXBean

Overrides:

deepEquals in class SDMXBeanImpl

Parameters:

bean - if null, then false will be returned

includeFinalProperties - - if true, then this method will check every single property from this bean is equal to the passed in bean. If false, then this method will ignore the following properties:

• Name
• Description
• Annotation
• Valid From (Start Date)
• Valid To (End Date)
• Structure URL
• Service URL
• URI
• Is External Reference

Returns:

getCodeRefs

public java.util.List<HierarchicalCodeBean> getCodeRefs()

Description copied from interface: HierarchicalCodeBean

Returns any child HierarchicalCodeBean beans as a copy of the underlying list.

Returns an empty list if there are no child beans

Specified by:

getCodeRefs in interface HierarchicalCodeBean

getLevelInHierarchy

public int getLevelInHierarchy()

Description copied from interface: HierarchicalCodeBean

Returns the level of this code ref bean in the hierarchy, 1 indexed

Specified by:

getLevelInHierarchy in interface HierarchicalCodeBean

Returns:

getLevel

public LevelBean getLevel(boolean acceptDefault)

Specified by:

getLevel in interface HierarchicalCodeBean

Parameters:

acceptDefault - - if this code reference was not explicitly assigned a level, but the hierarchy is leveled then this code reference will default the level to that of the level in the same hierarchical level. If true then will pass out the defaulted level if the level was not explicitly set on creation, if false, then will return the level if it was explicitly set, and will return null if it wasn't.

Returns:

the level associated with this code

getCodeReference

public CrossReferenceBean getCodeReference()

Description copied from interface: HierarchicalCodeBean

Returns the code referenced by this CodeRef, this will never be null as it will be resolved from the codelist alias and code id

Specified by:

getCodeReference in interface HierarchicalCodeBean

Returns:

getCodelistAliasRef

public java.lang.String getCodelistAliasRef()

Description copied from interface: HierarchicalCodeBean

Returns the codelist alias used to resolve this codelist reference, returns null if the reference is achieved by using the CrossReferenceBean (getCodeReference() returns a value)

Specified by:

getCodelistAliasRef in interface HierarchicalCodeBean

Returns:

getCodeId

public java.lang.String getCodeId()

Description copied from interface: HierarchicalCodeBean

Returns the code id of the code being referenced, to be used in conjunction with the codelist alias ref

Specified by:

getCodeId in interface HierarchicalCodeBean

Returns:

getValidFrom

public SdmxDate getValidFrom()

Specified by:

getValidFrom in interface HierarchicalCodeBean

getValidTo

public SdmxDate getValidTo()

Specified by:

getValidTo in interface HierarchicalCodeBean