Package org.opencastproject.metadata.mpeg7

Class TextAnnotationImpl

java.lang.Object

org.opencastproject.metadata.mpeg7.TextAnnotationImpl

All Implemented Interfaces:

org.opencastproject.mediapackage.XmlElement, TextAnnotation

public class TextAnnotationImpl
extends Object
implements TextAnnotation

Implementation of text annotations.

Field Summary

Fields

Modifier and Type	Field	Description
protected float	confidence	Confidence value
protected List<FreeTextAnnotation>	freeTextAnnotations	Free text annotations
protected List<KeywordAnnotation>	keywordAnnotations	Keyword annotations
protected String	language	Language identifier
protected float	relevance	Relevance value

Constructor Summary

Constructors

Constructor	Description
TextAnnotationImpl(float confidence, float relevance, String language)	Creates a new text annotation.

Method Summary

Modifier and Type	Method	Description
void	addFreeText(String text)	Adds free text to this annotation.
void	addFreeTextAnnotation(FreeTextAnnotation freeTextAnnotation)	Adds a free text annotation.
void	addKeyword(String keyword)	Adds the keyword to this annotation.
void	addKeyword(String keyword, KeywordAnnotation.Type type)	Adds the keyword to this annotation.
void	addKeywordAnnotation(KeywordAnnotation keywordAnnotation)	Adds a new keyword annotation.
Iterator<FreeTextAnnotation>	freeTextAnnotations()	Returns an iteration of the free text annotations.
float	getConfidence()	Returns the confidence of the validity of this annotation.
String	getLanguage()	Returns the language of this annotation in ISO represenatation, e. g.
float	getRelevance()	Returns the relevance of this annotation.
Iterator<KeywordAnnotation>	keywordAnnotations()	Returns an iteration of the keyword annotations.
Node	toXml(Document document)

Methods inherited from class java.lang.Object

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

Field Details

confidence

protected float confidence

Confidence value

relevance

protected float relevance

Relevance value

language

protected String language

Language identifier

keywordAnnotations

protected List<KeywordAnnotation> keywordAnnotations

Keyword annotations

freeTextAnnotations

protected List<FreeTextAnnotation> freeTextAnnotations

Free text annotations

Constructor Details

TextAnnotationImpl

public TextAnnotationImpl(float confidence,
 float relevance,
 String language)

Creates a new text annotation.

Parameters:

confidence - the confidence value [0.0..1.0]

relevance - the relevance value [0.0..1.0]

language - the language identifier

Method Details

addKeyword

public void addKeyword(String keyword)

Adds the keyword to this annotation.

Parameters:

keyword - the keyword

addKeyword

public void addKeyword(String keyword,
 KeywordAnnotation.Type type)

Adds the keyword to this annotation.

Parameters:

keyword - the keyword

type - the keyword type

addKeywordAnnotation

public void addKeywordAnnotation(KeywordAnnotation keywordAnnotation)

Description copied from interface: TextAnnotation

Adds a new keyword annotation.

Specified by:

addKeywordAnnotation in interface TextAnnotation

Parameters:

keywordAnnotation - the annotation

See Also:

• TextAnnotation.addKeywordAnnotation(org.opencastproject.metadata.mpeg7.KeywordAnnotation)

addFreeText

public void addFreeText(String text)

Adds free text to this annotation.

Parameters:

text - the free text

addFreeTextAnnotation

public void addFreeTextAnnotation(FreeTextAnnotation freeTextAnnotation)

Description copied from interface: TextAnnotation

Adds a free text annotation.

Specified by:

addFreeTextAnnotation in interface TextAnnotation

Parameters:

freeTextAnnotation - the annotation

See Also:

• TextAnnotation.addFreeTextAnnotation(org.opencastproject.metadata.mpeg7.FreeTextAnnotation)

getConfidence

public float getConfidence()

Description copied from interface: TextAnnotation

Returns the confidence of the validity of this annotation. The value will be in the range of 0.0 and 1.0. The confidence may vary with the technique that was used to create the annotation. For example, extracting a word using optical character recognition usually has a better confidence value than speech recognition.

Specified by:

getConfidence in interface TextAnnotation

Returns:

the confidence value

See Also:

• TextAnnotation.getConfidence()

getLanguage

public String getLanguage()

Description copied from interface: TextAnnotation

Returns the language of this annotation in ISO represenatation, e. g. en for annotations in English.

Specified by:

getLanguage in interface TextAnnotation

Returns:

the language

See Also:

• TextAnnotation.getLanguage()

getRelevance

public float getRelevance()

Description copied from interface: TextAnnotation

Returns the relevance of this annotation.

Specified by:

getRelevance in interface TextAnnotation

Returns:

the relevance value

See Also:

• TextAnnotation.getRelevance()

keywordAnnotations

public Iterator<KeywordAnnotation> keywordAnnotations()

Description copied from interface: TextAnnotation

Returns an iteration of the keyword annotations.

Specified by:

keywordAnnotations in interface TextAnnotation

Returns:

the keyword annotations

See Also:

• TextAnnotation.keywordAnnotations()

freeTextAnnotations

public Iterator<FreeTextAnnotation> freeTextAnnotations()

Description copied from interface: TextAnnotation

Returns an iteration of the free text annotations.

Specified by:

freeTextAnnotations in interface TextAnnotation

Returns:

the free text annotations

See Also:

• TextAnnotation.freeTextAnnotations()

toXml

public Node toXml(Document document)

Specified by:

toXml in interface org.opencastproject.mediapackage.XmlElement

See Also:

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