org.sdmxsource.sdmx.sdmxbeans.model.beans.registry

Class RegistrationBeanImpl

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

org.sdmxsource.sdmx.sdmxbeans.model.beans.registry.RegistrationBeanImpl

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MaintainableBean>, AnnotableBean, ConstrainableBean, IdentifiableBean, MaintainableBean, NameableBean, SDMXBean, SdmxStructureBean, RegistrationBean

public class RegistrationBeanImpl
extends MaintainableBeanImpl
implements RegistrationBean

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.sdmxsource.sdmx.api.model.beans.base.MaintainableBean

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor and Description
RegistrationBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.registry.ProvisionAgreementRefType provRef, org.sdmx.resources.sdmxml.schemas.v20.registry.DatasourceType datasourceType)
RegistrationBeanImpl(RegistrationMutableBean registrationMutable)
RegistrationBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.registry.RegistrationType registrationType)
RegistrationBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.registry.RegistrationType registrationType)

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<CrossReferenceBean>	getCrossReferencedConstrainables() Returns a reference to any referenced structures that can also be constrained, examples are: Registration would return reference to a provision agreement Provision Agreement would return a reference to a dataflow and a Data Provider Dataflow would return a reference to a data structure Data Structure would return null (example a provision agreement would return a reference to a dataflow)
DataSourceBean	getDataSource()
TERTIARY_BOOL	getIndexAttributes() The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each attribute of the data set or the presence of the metadata attributes of the metadata set (as indicated in the set's structure definition).
TERTIARY_BOOL	getIndexDataset() The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each dimension of the data set or identifier component of the metadata set (as indicated in the set's structure definition).
TERTIARY_BOOL	getIndexReportingPeriod() The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source.
TERTIARY_BOOL	getIndexTimeSeries() The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data.
SdmxDate	getLastUpdated() Returns when the registration was last updated
RegistrationMutableBean	getMutableInstance() Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the RegistrationMutableBean.
CrossReferenceBean	getProvisionAgreementRef()
MaintainableBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.
SdmxDate	getValidFrom()
SdmxDate	getValidTo()
boolean	isIndexed() Returns true if one of the index getters is set to true

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

addAnnotations, compareTo, getAgencyId, getEndDate, getServiceURL, getStartDate, getStructureURL, getVersion, isExternalReference, isFinal

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, 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.MaintainableBean

addAnnotations, getAgencyId, getEndDate, getServiceURL, getStartDate, getStructureURL, getVersion, isExternalReference, isFinal

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

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

getComposites, getComposites, getCrossReferences, getParent, getStructureType

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

RegistrationBeanImpl

public RegistrationBeanImpl(RegistrationMutableBean registrationMutable)

RegistrationBeanImpl

public RegistrationBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.registry.RegistrationType registrationType)

RegistrationBeanImpl

public RegistrationBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.registry.RegistrationType registrationType)

RegistrationBeanImpl

public RegistrationBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.registry.ProvisionAgreementRefType provRef,
                    org.sdmx.resources.sdmxml.schemas.v20.registry.DatasourceType datasourceType)

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:

isIndexed

public boolean isIndexed()

Description copied from interface: RegistrationBean

Returns true if one of the index getters is set to true

Specified by:

isIndexed in interface RegistrationBean

Returns:

getStub

public MaintainableBean getStub(java.net.URL actualLocation,
                       boolean isServiceUrl)

Description copied from interface: MaintainableBean

Returns a stub reference of itself.

A stub bean only contains Maintainable and Identifiable Attributes, not the composite Objects that are contained within the Maintainable

Specified by:

getStub in interface MaintainableBean

Parameters:

actualLocation - the URL indicating where the full structure can be returned from

isServiceUrl - if true this URL will be present on the serviceURL attribute, otherwise it will be treated as a structureURL attribute

Returns:

getMutableInstance

public RegistrationMutableBean getMutableInstance()

Description copied from interface: RegistrationBean

Returns a representation of itself in a bean which can be modified, modifications to the mutable bean are not reflected in the instance of the RegistrationMutableBean.

Specified by:

getMutableInstance in interface MaintainableBean

Specified by:

getMutableInstance in interface RegistrationBean

Returns:

getIndexTimeSeries

public TERTIARY_BOOL getIndexTimeSeries()

Description copied from interface: RegistrationBean

The indexTimeSeries, if true, indicates that the registry must index all time series for the registered data.

The index will create a Keyset Constraint

The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.

Specified by:

getIndexTimeSeries in interface RegistrationBean

Returns:

getIndexDataset

public TERTIARY_BOOL getIndexDataset()

Description copied from interface: RegistrationBean

The indexDataSet, if true, indicates that the registry must index the range of actual (present) values for each dimension of the data set or identifier component of the metadata set (as indicated in the set's structure definition).

The index will create a Cube Region Constraint

The default value is false.

Specified by:

getIndexDataset in interface RegistrationBean

Returns:

getIndexAttributes

public TERTIARY_BOOL getIndexAttributes()

Description copied from interface: RegistrationBean

The indexAttributes, if true, indicates that the registry must index the range of actual (present) values for each attribute of the data set or the presence of the metadata attributes of the metadata set (as indicated in the set's structure definition).

The default value is false.

Specified by:

getIndexAttributes in interface RegistrationBean

Returns:

getIndexReportingPeriod

public TERTIARY_BOOL getIndexReportingPeriod()

Description copied from interface: RegistrationBean

The indexReportingPeriod, if true, indicates that the registry must index the time period ranges for which data is present for the data source.

The default value is false, and the attribute will always be assumed false when the provision agreement references a metadata flow.

Specified by:

getIndexReportingPeriod in interface RegistrationBean

Returns:

getDataSource

public DataSourceBean getDataSource()

Specified by:

getDataSource in interface RegistrationBean

getLastUpdated

public SdmxDate getLastUpdated()

Description copied from interface: RegistrationBean

Returns when the registration was last updated

Specified by:

getLastUpdated in interface RegistrationBean

Returns:

getCrossReferencedConstrainables

public java.util.List<CrossReferenceBean> getCrossReferencedConstrainables()

Description copied from interface: ConstrainableBean

Returns a reference to any referenced structures that can also be constrained, examples are:

• Registration would return reference to a provision agreement
• Provision Agreement would return a reference to a dataflow and a Data Provider
• Dataflow would return a reference to a data structure
• Data Structure would return null
(example a provision agreement would return a reference to a dataflow)

Specified by:

getCrossReferencedConstrainables in interface ConstrainableBean

Returns:

getProvisionAgreementRef

public CrossReferenceBean getProvisionAgreementRef()

Specified by:

getProvisionAgreementRef in interface RegistrationBean

getValidFrom

public SdmxDate getValidFrom()

Specified by:

getValidFrom in interface RegistrationBean

getValidTo

public SdmxDate getValidTo()

Specified by:

getValidTo in interface RegistrationBean