Package org.opencastproject.metadata.mpeg7

Class SegmentImpl

java.lang.Object

org.opencastproject.metadata.mpeg7.SegmentImpl

All Implemented Interfaces:

XmlElement, AudioSegment, AudioVisualSegment, Segment, VideoSegment

public class SegmentImpl
extends Object
implements Segment, AudioSegment, VideoSegment, AudioVisualSegment

Default implementation of the SegmentType.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.metadata.mpeg7.Segment

Segment.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected List<TextAnnotation>	annotations	The text annotations
protected String	id	The content element identifier
protected MediaTime	mediaTime	The content time contraints
protected SpatioTemporalDecomposition	spatioTemporalDecomposition	An optional spatio-temporal decomposition
protected Segment.Type	type	The content type

Constructor Summary

Constructors

Constructor	Description
SegmentImpl(Segment.Type type, String id)	Creates a new content segment.

Method Summary

Modifier and Type	Method	Description
SpatioTemporalDecomposition	createSpatioTemporalDecomposition(boolean gap, boolean overlap)	Creates a spatio temporal decomposition in this video segment.
TextAnnotation	createTextAnnotation(float relevance, float confidence, String language)	Creates a new text annotation that will hold keywords and free text comments.
boolean	equals(Object obj)
String	getIdentifier()	Returns the segment identifier.
MediaTime	getMediaTime()	Returns the segment's time constraints.
SpatioTemporalDecomposition	getSpatioTemporalDecomposition()	Returns the spatio temporal decomposition that contains information about elements on the segment such as text elements.
int	getTextAnnotationCount()	Returns the number of text annotations.
int	hashCode()
boolean	hasSpatioTemporalDecomposition()	Returns true if there is a spatio temporal decomposition as part of this segment.
boolean	hasTextAnnotations()	Returns true if the segment contains any text annotations.
boolean	hasTextAnnotations(float relevance, float confidence)	Returns true if the segment contains text annotations that satisfy the given relevance and confidence values.
boolean	hasTextAnnotations(float relevance, float confidence, String language)	Returns true if the segment contains text annotations that satisfy the given relevance, confidence and language constraints.
boolean	hasTextAnnotations(String language)	Returns true if the segment contains text annotations in the specified language.
void	setMediaTime(MediaTime mediaTime)	Sets the segment's media time constraints.
Iterator<TextAnnotation>	textAnnotations()	Returns this segment's text annotations.
Iterator<TextAnnotation>	textAnnotationsByConfidence()	Returns this segment's text annotations, sorted by relevance.
Iterator<TextAnnotation>	textAnnotationsByRelevance()	Returns this segment's text annotations, sorted by relevance.
Node	toXml(Document document)	Returns an xml node representation of this element.

Methods inherited from class java.lang.Object

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

Field Details

type

protected Segment.Type type

The content type

id

protected String id

The content element identifier

mediaTime

protected MediaTime mediaTime

The content time contraints

annotations

protected List<TextAnnotation> annotations

The text annotations

spatioTemporalDecomposition

protected SpatioTemporalDecomposition spatioTemporalDecomposition

An optional spatio-temporal decomposition

Constructor Details

SegmentImpl

public SegmentImpl(Segment.Type type,
 String id)

Creates a new content segment.

Parameters:

type - the segment type

id - the segment identifier

Method Details

getIdentifier

public String getIdentifier()

Description copied from interface: Segment

Returns the segment identifier.

Specified by:

getIdentifier in interface Segment

Returns:

the identifier

See Also:

• Segment.getIdentifier()

setMediaTime

public void setMediaTime(MediaTime mediaTime)

Description copied from interface: Segment

Sets the segment's media time constraints.

Specified by:

setMediaTime in interface Segment

Parameters:

mediaTime - the media time

See Also:

• Segment.setMediaTime(org.opencastproject.metadata.mpeg7.MediaTime)

getMediaTime

public MediaTime getMediaTime()

Description copied from interface: Segment

Returns the segment's time constraints.

Specified by:

getMediaTime in interface Segment

Returns:

the media time

See Also:

• Segment.getMediaTime()

hasTextAnnotations

public boolean hasTextAnnotations()

Description copied from interface: Segment

Returns true if the segment contains any text annotations.

Specified by:

hasTextAnnotations in interface Segment

Returns:

true if there are text annotations

See Also:

• Segment.hasTextAnnotations()

hasTextAnnotations

public boolean hasTextAnnotations(String language)

Description copied from interface: Segment

Returns true if the segment contains text annotations in the specified language.

Specified by:

hasTextAnnotations in interface Segment

Returns:

true if there are text annotations

See Also:

• Segment.hasTextAnnotations(java.lang.String)

hasTextAnnotations

public boolean hasTextAnnotations(float relevance,
 float confidence)

Description copied from interface: Segment

Returns true if the segment contains text annotations that satisfy the given relevance and confidence values.

Specified by:

hasTextAnnotations in interface Segment

Returns:

true if there are text annotations

See Also:

• Segment.hasTextAnnotations(float, float)

hasTextAnnotations

public boolean hasTextAnnotations(float relevance,
 float confidence,
 String language)

Description copied from interface: Segment

Returns true if the segment contains text annotations that satisfy the given relevance, confidence and language constraints.

Specified by:

hasTextAnnotations in interface Segment

Returns:

true if there are text annotations

See Also:

• Segment.hasTextAnnotations(float, float, java.lang.String)

getTextAnnotationCount

public int getTextAnnotationCount()

Description copied from interface: Segment

Returns the number of text annotations. Note that text annotations are containers themselves, containing a number of keywords and free text entries.

Specified by:

getTextAnnotationCount in interface Segment

Returns:

the number of text annotations

See Also:

• Segment.getTextAnnotationCount()

textAnnotationsByConfidence

public Iterator<TextAnnotation> textAnnotationsByConfidence()

Description copied from interface: Segment

Returns this segment's text annotations, sorted by relevance.

Specified by:

textAnnotationsByConfidence in interface Segment

Returns:

the text annotations

See Also:

• Segment.textAnnotationsByConfidence()

textAnnotationsByRelevance

public Iterator<TextAnnotation> textAnnotationsByRelevance()

Description copied from interface: Segment

Returns this segment's text annotations, sorted by relevance.

Specified by:

textAnnotationsByRelevance in interface Segment

Returns:

the text annotations

See Also:

• Segment.textAnnotationsByRelevance()

createTextAnnotation

public TextAnnotation createTextAnnotation(float relevance,
 float confidence,
 String language)

Description copied from interface: Segment

Creates a new text annotation that will hold keywords and free text comments.

Specified by:

createTextAnnotation in interface Segment

Parameters:

relevance - the relevance value

confidence - the confidence

language - the language identifier

Returns:

the new text annotation

See Also:

• Segment.createTextAnnotation(float, float, String)

textAnnotations

public Iterator<TextAnnotation> textAnnotations()

Description copied from interface: Segment

Returns this segment's text annotations.

Specified by:

textAnnotations in interface Segment

Returns:

the text annotations

See Also:

• Segment.textAnnotations()

createSpatioTemporalDecomposition

public SpatioTemporalDecomposition createSpatioTemporalDecomposition(boolean gap,
 boolean overlap)
                                                              throws IllegalStateException

Creates a spatio temporal decomposition in this video segment.

Specified by:

createSpatioTemporalDecomposition in interface AudioVisualSegment

Specified by:

createSpatioTemporalDecomposition in interface VideoSegment

Parameters:

gap - true if there may be gap between the elements

overlap - true if elements may overlap

Returns:

the new decomposition

Throws:

IllegalStateException - if there is already such a decomposition

See Also:

• VideoSegment.createSpatioTemporalDecomposition(boolean, boolean)

getSpatioTemporalDecomposition

public SpatioTemporalDecomposition getSpatioTemporalDecomposition()

Returns the spatio temporal decomposition that contains information about elements on the segment such as text elements.

Specified by:

getSpatioTemporalDecomposition in interface AudioVisualSegment

Specified by:

getSpatioTemporalDecomposition in interface VideoSegment

Returns:

the spatio temporal decomposition

See Also:

• AudioVisualSegment.getSpatioTemporalDecomposition()

hasSpatioTemporalDecomposition

public boolean hasSpatioTemporalDecomposition()

Returns true if there is a spatio temporal decomposition as part of this segment.

Specified by:

hasSpatioTemporalDecomposition in interface AudioVisualSegment

Specified by:

hasSpatioTemporalDecomposition in interface VideoSegment

Returns:

true if there is a spatio temporal decomposition

See Also:

• AudioVisualSegment.hasSpatioTemporalDecomposition()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

• Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

• Object.equals(java.lang.Object)

toXml

public Node toXml(Document document)

Description copied from interface: XmlElement

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)