org.dvb.tvanytime.metadata
Interface ControlledTerm


public interface ControlledTerm

Interface for encapsulating one term from a classification scheme.


Method Summary
 java.lang.String getClassificationScheme()
          Get the URI scheme of the classification scheme that this controlled term belongs to.
 Mpeg7Text[] getDefinition()
          Get the description of this controlled term.
 java.lang.String getDefinition(java.util.Locale locale)
          Get the definition of a controlled term in the specified language.
 java.lang.String getID()
          Get the termID of this controlled term.
 Mpeg7Text[] getName()
          Get the names of this controlled term.
 java.lang.String getName(java.util.Locale locale)
          Get the name of a controlled term in the specified language.
 

Method Detail

getID

java.lang.String getID()
Get the termID of this controlled term. This is the ID that will be found in a TV Anytime metadata document. For example, for the controlled term representing:

    <Genre href="urn:tva:metadata:cs:ContentCS:2002:3.4.11">

the getID() function will return "3.4.11"

Returns:
a String representing the termID

getName

Mpeg7Text[] getName()
Get the names of this controlled term. There may be multiple names, to allow for names in multiple languages. Using the example from getID(), the getName() function will return {text="Comedy", lang="en"}

Returns:
an array of Mpeg7Text objects representing a name

getName

java.lang.String getName(java.util.Locale locale)
Get the name of a controlled term in the specified language.

Parameters:
locale - the Locale of the language to request (e.g. "de")
Returns:
the name (in the requested language) or null if a name is not available in the requested language.

getDefinition

Mpeg7Text[] getDefinition()
Get the description of this controlled term. There may be multiple definitions, to allow for descriptions in multiple languages. E.g. {text="Drama in a humourous style", lang="en"}

Returns:
an array of Mpeg7Text objects carrying a description

getDefinition

java.lang.String getDefinition(java.util.Locale locale)
Get the definition of a controlled term in the specified language.

Parameters:
locale - The Locale of the language to request (e.g. "de")
Returns:
the definition (in the requested language) or null if a name is not available in the requested language.

getClassificationScheme

java.lang.String getClassificationScheme()
Get the URI scheme of the classification scheme that this controlled term belongs to. E.g. "urn:tva:metadata:cs:ContentCS:2002"

Returns:
the URI scheme