org.sdmxsource.sdmx.api.model.metadata

Interface MetadataReportBean

All Superinterfaces:

SDMXBean, java.io.Serializable

All Known Implementing Classes:

MetadataReportBeanImpl

public interface MetadataReportBean
extends SDMXBean

Method Summary

Methods

Modifier and Type	Method and Description
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 interface org.sdmxsource.sdmx.api.model.beans.base.SDMXBean

deepEquals, getComposites, getComposites, getCrossReferences, getParent, getParent, getStructureType

Method Detail

getId

java.lang.String getId()

getTarget

TargetBean getTarget()

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

Returns:

getReportedAttributes

java.util.List<ReportedAttributeBean> getReportedAttributes()

Returns a copy of the list of the ReportedAttributes

Returns:

getTargets

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

Returns the targets that exist in the targetBean

Returns:

getTargetDatasetId

java.lang.String getTargetDatasetId()

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

Returns:

getTargetReportPeriod

SdmxDate getTargetReportPeriod()

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

Returns:

getTargetIdentifiableReference

CrossReferenceBean getTargetIdentifiableReference()

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

Returns:

getTargetContentConstraintReference

CrossReferenceBean getTargetContentConstraintReference()

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

Returns:

getTargetDataKeys

java.util.List<DataKeyBean> getTargetDataKeys()

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

Returns: