org.sdmxsource.sdmx.api.model.beans.base

Interface AnnotationBean

All Superinterfaces:

SDMXBean, java.io.Serializable

All Known Implementing Classes:

AnnotationBeanImpl

public interface AnnotationBean
extends SDMXBean

Contains annotation information

Provides for non-documentation notes and annotations to be embedded in data and structure messages. It provides optional fields for providing a title, a type description, a URI, and the text of the annotation.

This is an immutable bean - this bean can not be modified

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

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

Returns:

getTitle

java.lang.String getTitle()

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

Returns:

getType

java.lang.String getType()

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.

Returns:

getText

java.util.List<TextTypeWrapper> getText()

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.

Returns:

getUri

java.net.URI getUri()

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.

Returns: