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

Class AnnotationBeanImpl

java.lang.Object

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

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

All Implemented Interfaces:

java.io.Serializable, AnnotationBean, SDMXBean

public class AnnotationBeanImpl
extends SDMXBeanImpl
implements AnnotationBean

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AnnotationBeanImpl(AnnotationMutableBean annotationMutable, SDMXBean parent)
AnnotationBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.common.AnnotationType annotation, SDMXBean parent)
AnnotationBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.common.AnnotationType annotation, SDMXBean parent)
AnnotationBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.common.AnnotationType annotation, SDMXBean parent)

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)
java.lang.String	getId() Returns the id of the annotation, this is a free text field.
java.util.List<TextTypeWrapper>	getText() This is a language-specific string which holds the text of the annotation.
java.lang.String	getTitle() Returns the title of the annotation, this is a free text field.
java.lang.String	getType() Returns the type of annotation, this is a free text field.
java.net.URI	getUri() Returns a URI - typically a URL - which points to an external resource which may contain or supplement the annotation.
int	hashCode()
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, 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

AnnotationBeanImpl

public AnnotationBeanImpl(AnnotationMutableBean annotationMutable,
                  SDMXBean parent)

AnnotationBeanImpl

public AnnotationBeanImpl(org.sdmx.resources.sdmxml.schemas.v21.common.AnnotationType annotation,
                  SDMXBean parent)

AnnotationBeanImpl

public AnnotationBeanImpl(org.sdmx.resources.sdmxml.schemas.v20.common.AnnotationType annotation,
                  SDMXBean parent)

AnnotationBeanImpl

public AnnotationBeanImpl(org.sdmx.resources.sdmxml.schemas.v10.xmlbeans.common.AnnotationType annotation,
                  SDMXBean parent)

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:

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getTitle

public java.lang.String getTitle()

Description copied from interface: AnnotationBean

Returns the title of the annotation, this is a free text field.

Specified by:

getTitle in interface AnnotationBean

Returns:

getId

public java.lang.String getId()

Description copied from interface: AnnotationBean

Returns the id of the annotation, this is a free text field.

Specified by:

getId in interface AnnotationBean

Returns:

getType

public java.lang.String getType()

Description copied from interface: AnnotationBean

Returns the type of annotation, this is a free text field.

Is used to distinguish between annotations designed to support various uses. The types are not enumerated, as these can be specified by the user or creator of the annotations. The definitions and use of annotation types should be documented by their creator.

Specified by:

getType in interface AnnotationBean

Returns:

getUri

public java.net.URI getUri()

Description copied from interface: AnnotationBean

Returns a URI - typically a URL - which points to an external resource which may contain or supplement the annotation.

If a specific behaviour is desired, an annotation type should be defined which specifies the use of this field more exactly.

Specified by:

getUri in interface AnnotationBean

Returns:

getText

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

Description copied from interface: AnnotationBean

This is a language-specific string which holds the text of the annotation.

NOTEThe list is a copy so modify the returned list will not be reflected in the AnnotableBean instance.

Specified by:

getText in interface AnnotationBean

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object