org.sdmxsource.sdmx.sdmxbeans.model.metadata

Class MetadataReportBeanImpl

java.lang.Object

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

org.sdmxsource.sdmx.sdmxbeans.model.metadata.MetadataReportBeanImpl

All Implemented Interfaces:

java.io.Serializable, SDMXBean, MetadataReportBean

public class MetadataReportBeanImpl
extends SDMXBeanImpl
implements MetadataReportBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetadataReportBeanImpl(MetadataSetBean parent, org.sdmx.resources.sdmxml.schemas.v21.metadata.generic.ReportType bean)

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	getId()
java.util.List<ReportedAttributeBean>	getReportedAttributes() Returns a copy of the list of the ReportedAttributes
TargetBean	getTarget() Returns the target, defining what this metadata report attaches to.
CrossReferenceBean	getTargetContentConstraintReference() This will search the Target.ReportedAttributeBeans for any that contain a constraint reference, and will return null if none do.
java.util.List<DataKeyBean>	getTargetDataKeys() This will search the Target.ReportedAttributeBeans for any that contain data keys, and will return null if none do.
java.lang.String	getTargetDatasetId() This will search the Target.ReportedAttributeBeans for any that contain a datasetid, and will return null if none do.
CrossReferenceBean	getTargetIdentifiableReference() This will search the Target.ReportedAttributeBeans for any that contain a identifiable refernce, and will return null if none do.
SdmxDate	getTargetReportPeriod() This will search the Target.ReportedAttributeBeans for any that contain a reportPeriod, and will return null if none do.
java.util.Set<ReferenceValueBean.TARGET_TYPE>	getTargets() Returns the targets that exist in the targetBean

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

getComposites, getComposites, getCrossReferences, getParent, getParent, getStructureType

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getComposites, getComposites, getCrossReferences, getParent, getParent, getStructureType

Constructor Detail

MetadataReportBeanImpl

public MetadataReportBeanImpl(MetadataSetBean parent,
                      org.sdmx.resources.sdmxml.schemas.v21.metadata.generic.ReportType bean)

Method Detail

getId

public java.lang.String getId()

Specified by:

getId in interface MetadataReportBean

getTarget

public TargetBean getTarget()

Description copied from interface: MetadataReportBean

Returns the target, defining what this metadata report attaches to. The same information can be found using the getTarget...() methods on this interface.

Specified by:

getTarget in interface MetadataReportBean

Returns:

getReportedAttributes

public java.util.List<ReportedAttributeBean> getReportedAttributes()

Description copied from interface: MetadataReportBean

Returns a copy of the list of the ReportedAttributes

Specified by:

getReportedAttributes in interface MetadataReportBean

Returns:

getTargets

public java.util.Set<ReferenceValueBean.TARGET_TYPE> getTargets()

Description copied from interface: MetadataReportBean

Returns the targets that exist in the targetBean

Specified by:

getTargets in interface MetadataReportBean

Returns:

getTargetDatasetId

public java.lang.String getTargetDatasetId()

Description copied from interface: MetadataReportBean

This will search the Target.ReportedAttributeBeans for any that contain a datasetid, and will return null if none do.

Returns the id of the dataset this bean is referencing, returns null if this is not a dataset reference.

NOTE : This is to be used in conjunction with the getIdentifiableReference() which will return the data provider reference

Specified by:

getTargetDatasetId in interface MetadataReportBean

Returns:

getTargetReportPeriod

public SdmxDate getTargetReportPeriod()

Description copied from interface: MetadataReportBean

This will search the Target.ReportedAttributeBeans for any that contain a reportPeriod, and will return null if none do.

Returns the date for which this report is relevant

Specified by:

getTargetReportPeriod in interface MetadataReportBean

Returns:

getTargetIdentifiableReference

public CrossReferenceBean getTargetIdentifiableReference()

Description copied from interface: MetadataReportBean

This will search the Target.ReportedAttributeBeans for any that contain a identifiable refernce, and will return null if none do.

Returns null if there is no reference to an identifiable structure

Specified by:

getTargetIdentifiableReference in interface MetadataReportBean

Returns:

getTargetContentConstraintReference

public CrossReferenceBean getTargetContentConstraintReference()

Description copied from interface: MetadataReportBean

This will search the Target.ReportedAttributeBeans for any that contain a constraint reference, and will return null if none do.

Returns the reference to the content constraint, if there is one

Specified by:

getTargetContentConstraintReference in interface MetadataReportBean

Returns:

getTargetDataKeys

public java.util.List<DataKeyBean> getTargetDataKeys()

Description copied from interface: MetadataReportBean

This will search the Target.ReportedAttributeBeans for any that contain data keys, and will return null if none do.

Returns a list of data keys, will return an empty list if isDatasetReference() is false

Specified by:

getTargetDataKeys in interface MetadataReportBean

Returns:

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: