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

Class HierarchyBeanImpl

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.base.NameableBeanImpl

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

All Implemented Interfaces:

java.io.Serializable, AnnotableBean, IdentifiableBean, ItemBean, NameableBean, SDMXBean, SdmxStructureBean, HierarchyBean

public class HierarchyBeanImpl
extends NameableBeanImpl
implements HierarchyBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HierarchyBeanImpl(HierarchicalCodelistBean parent, HierarchyMutableBean hierarchy)
HierarchyBeanImpl(HierarchicalCodelistBean parent, org.sdmx.resources.sdmxml.schemas.v21.structure.HierarchyType hierarchy)
HierarchyBeanImpl(HierarchicalCodelistBean parent, org.sdmx.resources.sdmxml.schemas.v20.structure.HierarchyType hierarchy)

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.util.List<HierarchicalCodeBean>	getHierarchicalCodeBeans()
LevelBean	getLevel()
LevelBean	getLevelAtPosition(int levelPos) Returns the LevelBean at the position indicated, by recursing the LevelBean hierarchy of this Hierarchy bean, returns null if there is no level
HierarchicalCodelistBean	getMaintainableParent() Recurses up the parent tree to find the maintainable parent.
boolean	hasFormalLevels() If true this indicates that the hierarchy has formal levels.

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

getAllTextTypes, getDescription, getDescriptions, getName, getNames

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

asReference, equals, 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, 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.NameableBean

getDescription, getDescriptions, getName, getNames

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, getParent

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

getComposites, getComposites, getCrossReferences, getParent, getStructureType

Constructor Detail

HierarchyBeanImpl

public HierarchyBeanImpl(HierarchicalCodelistBean parent,
                 HierarchyMutableBean hierarchy)

HierarchyBeanImpl

public HierarchyBeanImpl(HierarchicalCodelistBean parent,
                 org.sdmx.resources.sdmxml.schemas.v21.structure.HierarchyType hierarchy)

HierarchyBeanImpl

public HierarchyBeanImpl(HierarchicalCodelistBean parent,
                 org.sdmx.resources.sdmxml.schemas.v20.structure.HierarchyType hierarchy)

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:

getHierarchicalCodeBeans

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

Specified by:

getHierarchicalCodeBeans in interface HierarchyBean

Returns:

the child Hierarchical Codes for this hierarchy, returns an empty list if there are no children

getLevel

public LevelBean getLevel()

Specified by:

getLevel in interface HierarchyBean

Returns:

the level for this hierarchy, returns null if there is no level

getLevelAtPosition

public LevelBean getLevelAtPosition(int levelPos)

Description copied from interface: HierarchyBean

Returns the LevelBean at the position indicated, by recursing the LevelBean hierarchy of this Hierarchy bean, returns null if there is no level

Specified by:

getLevelAtPosition in interface HierarchyBean

Returns:

the level at the given hierarchical position (1 indexed) - returns null if there is no level at that position

hasFormalLevels

public boolean hasFormalLevels()

Description copied from interface: HierarchyBean

If true this indicates that the hierarchy has formal levels. In this case, every code should have a level associated with it. If false this does not have formal levels. This hierarchy may still have levels, getLevel() may still return a value, the levels are not formal and the call to a code for its level may return null.

Specified by:

hasFormalLevels in interface HierarchyBean

getMaintainableParent

public HierarchicalCodelistBean getMaintainableParent()

Description copied from interface: SdmxStructureBean

Recurses up the parent tree to find the maintainable parent. If this is a maintainable then it will return a reference to itself

Specified by:

getMaintainableParent in interface SdmxStructureBean

Specified by:

getMaintainableParent in interface HierarchyBean

Overrides:

getMaintainableParent in class SdmxStructureBeanImpl

Returns: