Package org.opencastproject.metadata.mpeg7

Class TemporalDecompositionImpl<T extends Segment>

java.lang.Object

org.opencastproject.metadata.mpeg7.TemporalDecompositionImpl<T>

All Implemented Interfaces:

XmlElement, TemporalDecomposition<T>

public class TemporalDecompositionImpl<T extends Segment>
extends Object
implements TemporalDecomposition<T>

Default implementation of the temporal decomposition.

Nested Class Summary

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

TemporalDecomposition.DecompositionCriteria

Field Summary

Fields

Modifier and Type	Field	Description
protected TemporalDecomposition.DecompositionCriteria	criteria	The decomposition criteria
protected boolean	gap	True if there is a gap
protected boolean	hasGap	Indicator for the presence of gaps in between segments
protected boolean	isOverlapping	Indicator for the presence of overlapping segments
protected boolean	overlap	True if the segment overlaps
protected List<T>	segments	The list of segments in this temporal decomposition

Constructor Summary

Constructors

Constructor	Description
TemporalDecompositionImpl(Segment.Type segmentType)	Creates a new temporal decomposition container.

Method Summary

Modifier and Type	Method	Description
T	createSegment(String id)	Creates a new segment and returns it.
TemporalDecomposition.DecompositionCriteria	getCriteria()	Returns the decomposition criteria.
T	getSegmentById(String segmentId)	Returns the segment with the given identifier or null if the segment does not exist.
boolean	hasGap()	Returns true if the segment has a gap.
boolean	hasSegments()	Returns true if the composition actually contains segments.
boolean	isOverlapping()	Returns true if the segment overlaps with another one.
Iterator<T>	segments()	Returns an iteration of the video's segments.
void	setCriteria(TemporalDecomposition.DecompositionCriteria criteria)	Sets the decomposition criteria.
void	setGap(boolean hasGap)	Set the hasGap property indicating that there may be gaps in between the segments.
void	setOverlapping(boolean isOverlapping)	Set the isOverlapping property indicating that some segments may be overlapping.
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

gap

protected boolean gap

True if there is a gap

overlap

protected boolean overlap

True if the segment overlaps

criteria

protected TemporalDecomposition.DecompositionCriteria criteria

The decomposition criteria

segments

protected List<T extends Segment> segments

The list of segments in this temporal decomposition

hasGap

protected boolean hasGap

Indicator for the presence of gaps in between segments

isOverlapping

protected boolean isOverlapping

Indicator for the presence of overlapping segments

Constructor Details

TemporalDecompositionImpl

public TemporalDecompositionImpl(Segment.Type segmentType)

Creates a new temporal decomposition container.

Parameters:

segmentType - the segment type

Method Details

setGap

public void setGap(boolean hasGap)

Description copied from interface: TemporalDecomposition

Set the hasGap property indicating that there may be gaps in between the segments.

Specified by:

setGap in interface TemporalDecomposition<T extends Segment>

Parameters:

hasGap - true if there are gaps

See Also:

• TemporalDecomposition.setGap(boolean)

hasGap

public boolean hasGap()

Description copied from interface: TemporalDecomposition

Returns true if the segment has a gap.

Specified by:

hasGap in interface TemporalDecomposition<T extends Segment>

Returns:

true if the segment has a gap

See Also:

• TemporalDecomposition.hasGap()

createSegment

public T createSegment(String id)

Description copied from interface: TemporalDecomposition

Creates a new segment and returns it.

Specified by:

createSegment in interface TemporalDecomposition<T extends Segment>

Parameters:

id - the segment identifier

Returns:

the new segment

hasSegments

public boolean hasSegments()

Description copied from interface: TemporalDecomposition

Returns true if the composition actually contains segments.

Specified by:

hasSegments in interface TemporalDecomposition<T extends Segment>

Returns:

true if there are segments

See Also:

• TemporalDecomposition.hasSegments()

setOverlapping

public void setOverlapping(boolean isOverlapping)

Description copied from interface: TemporalDecomposition

Set the isOverlapping property indicating that some segments may be overlapping.

Specified by:

setOverlapping in interface TemporalDecomposition<T extends Segment>

Parameters:

isOverlapping - true if elements are overlapping

See Also:

• TemporalDecomposition.setOverlapping(boolean)

setCriteria

public void setCriteria(TemporalDecomposition.DecompositionCriteria criteria)

Description copied from interface: TemporalDecomposition

Sets the decomposition criteria.

Specified by:

setCriteria in interface TemporalDecomposition<T extends Segment>

Parameters:

criteria - the criteria

See Also:

• TemporalDecomposition.setCriteria(org.opencastproject.metadata.mpeg7.TemporalDecomposition.DecompositionCriteria)

isOverlapping

public boolean isOverlapping()

Description copied from interface: TemporalDecomposition

Returns true if the segment overlaps with another one.

Specified by:

isOverlapping in interface TemporalDecomposition<T extends Segment>

Returns:

true if the segment overlaps

See Also:

• TemporalDecomposition.isOverlapping()

getCriteria

public TemporalDecomposition.DecompositionCriteria getCriteria()

Description copied from interface: TemporalDecomposition

Returns the decomposition criteria.

Specified by:

getCriteria in interface TemporalDecomposition<T extends Segment>

Returns:

the criteria

See Also:

• TemporalDecomposition.getCriteria()

getSegmentById

public T getSegmentById(String segmentId)

Description copied from interface: TemporalDecomposition

Returns the segment with the given identifier or null if the segment does not exist.

Specified by:

getSegmentById in interface TemporalDecomposition<T extends Segment>

Parameters:

segmentId - the segment identifier

Returns:

the segment

See Also:

• TemporalDecomposition.getSegmentById(java.lang.String)

segments

public Iterator<T> segments()

Description copied from interface: TemporalDecomposition

Returns an iteration of the video's segments.

Specified by:

segments in interface TemporalDecomposition<T extends Segment>

Returns:

the video segments

See Also:

• TemporalDecomposition.segments()

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)