Package org.opencastproject.metadata.mpeg7

Class TextualImpl

java.lang.Object

org.opencastproject.metadata.mpeg7.TextualImpl

All Implemented Interfaces:

XmlElement, Textual

public class TextualImpl
extends Object
implements Textual

Default implementation of a TextualBase mpeg-7 element.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alphabet	The phonetic alphabet
static final String	DEFAULT_PHONETIC_ALPHABET	The default phonetic alphabet
protected String	language	The text
protected String	text	The text
protected String	transcription	The phonetic transcription

Constructor Summary

Constructors

Constructor	Description
TextualImpl()	Creates a new textual base element.
TextualImpl(String text)	Creates a new textual base element.
TextualImpl(String[] words)	Creates a new Textual element from a number of words.
TextualImpl(String[] words, String language)	Creates a new textual base element.
TextualImpl(String text, String language)	Creates a new textual base element.

Method Summary

Modifier and Type	Method	Description
String	getLanguage()	Returns the text's language.
String	getPhoneticAlphabet()	Returns the optional phonetic alphabet or the default value sampa if no alphabet has been specified.
String	getPhoneticTranscription()	Returns the optional phonetic transcription.
String	getText()	Returns the actual text.
void	setLanguage(String language)	Sets the language, which must correspond to the defininition of xml:lang.
void	setPhoneticTranscription(String transcription, String alphabet)	Sets the phonetic transcription and specifies which alphabet was used to produce it.
void	setText(String text)	Sets the text.
Node	toXml(Document document)	Returns an xml node representation of this element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_PHONETIC_ALPHABET

public static final String DEFAULT_PHONETIC_ALPHABET

The default phonetic alphabet

See Also:

• Constant Field Values

text

protected String text

The text

language

protected String language

The text

transcription

protected String transcription

The phonetic transcription

alphabet

protected String alphabet

The phonetic alphabet

Constructor Details

TextualImpl

public TextualImpl()

Creates a new textual base element.

TextualImpl

public TextualImpl(String text)

Creates a new textual base element.

Parameters:

text - the text

Throws:

IllegalArgumentException - if the text is null or empty

TextualImpl

public TextualImpl(String[] words)

Creates a new Textual element from a number of words.

Parameters:

words - the words

TextualImpl

public TextualImpl(String text,
 String language)

Creates a new textual base element.

Parameters:

text - the text

Throws:

IllegalArgumentException - if the text is null or empty

TextualImpl

public TextualImpl(String[] words,
 String language)

Creates a new textual base element.

Parameters:

words - the words

Throws:

IllegalArgumentException - if the words is null or empty

Method Details

getLanguage

public String getLanguage()

Returns the text's language.

Specified by:

getLanguage in interface Textual

Returns:

the language

See Also:

• Textual.getLanguage()

getPhoneticAlphabet

public String getPhoneticAlphabet()

Returns the optional phonetic alphabet or the default value sampa if no alphabet has been specified.

Specified by:

getPhoneticAlphabet in interface Textual

Returns:

the phonetic alphabet

See Also:

• Textual.getPhoneticAlphabet()

getPhoneticTranscription

public String getPhoneticTranscription()

Returns the optional phonetic transcription.

Specified by:

getPhoneticTranscription in interface Textual

Returns:

the phonetic transcription

See Also:

• Textual.getPhoneticTranscription()

setText

public void setText(String text)

Sets the text.

Specified by:

setText in interface Textual

Parameters:

text - the text

See Also:

• Textual.setText(java.lang.String)

getText

public String getText()

Returns the actual text.

Specified by:

getText in interface Textual

Returns:

the text

See Also:

• Textual.getText()

setLanguage

public void setLanguage(String language)

Sets the language, which must correspond to the defininition of xml:lang.

Specified by:

setLanguage in interface Textual

Parameters:

language - the language

See Also:

• Textual.setLanguage(java.lang.String)

setPhoneticTranscription

public void setPhoneticTranscription(String transcription,
 String alphabet)

Sets the phonetic transcription and specifies which alphabet was used to produce it.

Specified by:

setPhoneticTranscription in interface Textual

Parameters:

transcription - the transcription

alphabet - the alphabet

See Also:

• Textual.setPhoneticTranscription(java.lang.String, java.lang.String)

toXml

public Node toXml(Document document)

Returns an xml node representation of this element.

Specified by:

toXml in interface XmlElement

Parameters:

document - the enclosing xml document

Returns:

the xml node

See Also:

• XmlElement.toXml(org.w3c.dom.Document)