org.sdmxsource.sdmx.sdmxbeans.model.metadata

Class MetadataSetBeanImpl

java.lang.Object

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

org.sdmxsource.sdmx.sdmxbeans.model.metadata.MetadataSetBeanImpl

All Implemented Interfaces:

java.io.Serializable, SDMXBean, MetadataSetBean

public class MetadataSetBeanImpl
extends SDMXBeanImpl
implements MetadataSetBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetadataSetBeanImpl(MetadataBean parent, org.sdmx.resources.sdmxml.schemas.v21.metadata.generic.MetadataSetType createdFrom)

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.
boolean	equals(java.lang.Object obj)
CrossReferenceBean	getDataProviderReference() Optional
CrossReferenceBean	getMsdReference() Mandatory returns a reference to the metadata structure that defines the structure of this metadata set
java.util.List<TextTypeWrapper>	getNames() Returns a list of names for this component - will return an empty list if no Names exist.
java.lang.Object	getPublicationPeriod() Optional
SdmxDate	getPublicationYear() Optional
SdmxDate	getReportingBeginDate() Optional
SdmxDate	getReportingEndDate() Optional
java.util.List<MetadataReportBean>	getReports()
java.lang.String	getSetId() Returns an identification for the metadata set
SdmxDate	getValidFromDate() Optional
SdmxDate	getValidToDate() Optional
java.util.List<MetadataSetBean>	splitReports() Returns a list of metadata sets, built from this metadata set and metadata reports.
java.lang.String	toString()

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

getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getComposites, getComposites, getCrossReferences, getParent, getParent, getStructureType

Constructor Detail

MetadataSetBeanImpl

public MetadataSetBeanImpl(MetadataBean parent,
                   org.sdmx.resources.sdmxml.schemas.v21.metadata.generic.MetadataSetType createdFrom)

Method Detail

splitReports

public java.util.List<MetadataSetBean> splitReports()

Description copied from interface: MetadataSetBean

Returns a list of metadata sets, built from this metadata set and metadata reports. Each metadata set has one metadata report in it.

Specified by:

splitReports in interface MetadataSetBean

Returns:

a metadataset for each metadata report contained in the metadata set

getNames

public java.util.List<TextTypeWrapper> getNames()

Description copied from interface: MetadataSetBean

Returns a list of names for this component - will return an empty list if no Names exist.

NOTE: The list is a copy so modifying the returned list will not be reflected in the IdentifiableBean instance

Specified by:

getNames in interface MetadataSetBean

Returns:

first locale value it finds or null if there are none

getSetId

public java.lang.String getSetId()

Description copied from interface: MetadataSetBean

Returns an identification for the metadata set

Specified by:

getSetId in interface MetadataSetBean

Returns:

getMsdReference

public CrossReferenceBean getMsdReference()

Description copied from interface: MetadataSetBean

Mandatory returns a reference to the metadata structure that defines the structure of this metadata set

Specified by:

getMsdReference in interface MetadataSetBean

getPublicationYear

public SdmxDate getPublicationYear()

Description copied from interface: MetadataSetBean

Optional

Specified by:

getPublicationYear in interface MetadataSetBean

Returns:

the four digit ISO 8601 year of publication

getPublicationPeriod

public java.lang.Object getPublicationPeriod()

Description copied from interface: MetadataSetBean

Optional

Specified by:

getPublicationPeriod in interface MetadataSetBean

Returns:

the publication period

getDataProviderReference

public CrossReferenceBean getDataProviderReference()

Description copied from interface: MetadataSetBean

Optional

Specified by:

getDataProviderReference in interface MetadataSetBean

Returns:

reference to the DataProvider

getReportingBeginDate

public SdmxDate getReportingBeginDate()

Description copied from interface: MetadataSetBean

Optional

Specified by:

getReportingBeginDate in interface MetadataSetBean

Returns:

the inclusive start time of the data reported in the metadata set

getReportingEndDate

public SdmxDate getReportingEndDate()

Description copied from interface: MetadataSetBean

Optional

Specified by:

getReportingEndDate in interface MetadataSetBean

Returns:

the inclusive end time of the data reported in the metadata set

getValidFromDate

public SdmxDate getValidFromDate()

Description copied from interface: MetadataSetBean

Optional

Specified by:

getValidFromDate in interface MetadataSetBean

Returns:

the inclusive start time of the validity of the info in the metadata set

getValidToDate

public SdmxDate getValidToDate()

Description copied from interface: MetadataSetBean

Optional

Specified by:

getValidToDate in interface MetadataSetBean

Returns:

the inclusive end time of the validity of the info in the metadata set

getReports

public java.util.List<MetadataReportBean> getReports()

Specified by:

getReports in interface MetadataSetBean

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:

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object