org.sdmxsource.sdmx.sdmxbeans.model.beans.categoryscheme

Class CategorisationBeanImpl

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.categoryscheme.CategorisationBeanImpl

All Implemented Interfaces:

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

public class CategorisationBeanImpl
extends MaintainableBeanImpl
implements CategorisationBean

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
CategorisationBeanImpl(CategorisationMutableBean bean)
CategorisationBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.CategorisationType cs)
CategorisationBeanImpl(CategoryBean category, org.sdmx.resources.sdmxml.schemas.v20.structure.DataflowRefType df) Constructs a categorisation from a category that contains a dataflow ref
CategorisationBeanImpl(CategoryBean category, org.sdmx.resources.sdmxml.schemas.v20.structure.MetadataflowRefType mdf) Constructs a categorisation from a category that contains a metadataflow ref
CategorisationBeanImpl(MaintainableBean referencedFrom, org.sdmx.resources.sdmxml.schemas.v20.structure.CategoryRefType currentRef) Constructs a categorisation from a dataflow that contains a category ref

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.
CrossReferenceBean	getCategoryReference() Returns a reference to the category that is categorising the structure - this can not be null
CategorisationMutableBean	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 MaintainableBean.
CrossReferenceBean	getStructureReference() Returns a reference to the structure that this is categorising - this can not be null
CategorisationBean	getStub(java.net.URL actualLocation, boolean isServiceUrl) Returns a stub reference of itself.

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

CategorisationBeanImpl

public CategorisationBeanImpl(CategorisationMutableBean bean)

CategorisationBeanImpl

public CategorisationBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.structure.CategorisationType cs)

CategorisationBeanImpl

public CategorisationBeanImpl(CategoryBean category,
                      org.sdmx.resources.sdmxml.schemas.v20.structure.MetadataflowRefType mdf)

Constructs a categorisation from a category that contains a metadataflow ref

Parameters:

category -

mdf -

CategorisationBeanImpl

public CategorisationBeanImpl(CategoryBean category,
                      org.sdmx.resources.sdmxml.schemas.v20.structure.DataflowRefType df)

Constructs a categorisation from a category that contains a dataflow ref

Parameters:

category -

df -

CategorisationBeanImpl

public CategorisationBeanImpl(MaintainableBean referencedFrom,
                      org.sdmx.resources.sdmxml.schemas.v20.structure.CategoryRefType currentRef)

Constructs a categorisation from a dataflow that contains a category ref

Parameters:

cateogryRef -

referencedFrom -

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:

getStub

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

Description copied from interface: CategorisationBean

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

Specified by:

getStub in interface CategorisationBean

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 CategorisationMutableBean getMutableInstance()

Description copied from interface: CategorisationBean

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

Specified by:

getMutableInstance in interface MaintainableBean

Specified by:

getMutableInstance in interface CategorisationBean

Returns:

getCategoryReference

public CrossReferenceBean getCategoryReference()

Description copied from interface: CategorisationBean

Returns a reference to the category that is categorising the structure - this can not be null

Specified by:

getCategoryReference in interface CategorisationBean

Returns:

getStructureReference

public CrossReferenceBean getStructureReference()

Description copied from interface: CategorisationBean

Returns a reference to the structure that this is categorising - this can not be null

Specified by:

getStructureReference in interface CategorisationBean

Returns: