org.sdmxsource.sdmx.api.model.superbeans.base

Interface AnnotationSuperBean

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AnnotationSuperBeanImpl

public interface AnnotationSuperBean
extends java.io.Serializable

An Annotation is a piece of information that can be held against an Annotable Object.

It can be thought of as a placeholder for any extraneous information that needs to be stored, when there is no other appropriate place to store the information.

Author:

Matt Nelson

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getText()
java.lang.String	getText(java.util.Locale locale)
java.util.Map<java.util.Locale,java.lang.String>	getTexts()
java.lang.String	getTitle()
java.lang.String	getType()
java.net.URI	getUri()

Method Detail

getTitle

java.lang.String getTitle()

Returns:

the title of the annotation.

getType

java.lang.String getType()

Returns:

the type of the annotation.

getUri

java.net.URI getUri()

Returns:

the URI of the annotation.

getText

java.lang.String getText(java.util.Locale locale)

Parameters:

locale - Locale to obtain the text for.

Returns:

the text of the annotation in the given locale.

getText

java.lang.String getText()

Returns:

the text of the annotation in the default locale.

getTexts

java.util.Map<java.util.Locale,java.lang.String> getTexts()

Returns:

a Map of all the available texts for this annotation.