Class IntervalTier

java.lang.Object

ca.phon.extensions.ExtendableObject

ca.phon.session.IntervalTier

All Implemented Interfaces:

IExtendable

public final class IntervalTier
extends ExtendableObject

Collection of interval/points

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IntervalTier.InsertionStrategy	Insertion strategy used when adding new intervals to the tier and an overlap occurs.
static class	IntervalTier.Interval	Interval entity for timeline tier
static class	IntervalTier.Point	Point entity for timeline tier

Constructor Summary

Constructors

Constructor	Description
IntervalTier(IntervalTierSPI spi)	Create a new timeline tier

Method Summary

Modifier and Type	Method	Description
IntervalTier.Interval	addInterval(float start, float end, IntervalTier.InsertionStrategy insertionStrategy)	Add new interval to tier
IntervalTier.Interval	addInterval(float start, float end, String label, IntervalTier.InsertionStrategy insertionStrategy)	Add new interval to tier
boolean	addInterval(IntervalTier.Interval interval, IntervalTier.InsertionStrategy insertionStrategy)	Add new interval to tier
List<IntervalTier.Interval>	getIntervals()	Get list of intervals in tier (points included) as an unmodifiable list
String	getName()	Get tier name
boolean	removeInterval(IntervalTier.Interval interval)	Remove interval from tier

Methods inherited from class ca.phon.extensions.ExtendableObject

getExtension, getExtensions, putExtension, removeExtension

Methods inherited from class java.lang.Object

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

Constructor Details

IntervalTier

public IntervalTier(IntervalTierSPI spi)

Create a new timeline tier

Method Details

getName

public String getName()

Get tier name

Returns:

tierName

getIntervals

public List<IntervalTier.Interval> getIntervals()

Get list of intervals in tier (points included) as an unmodifiable list

Returns:

list of all intervals and points in tier in order

addInterval

public IntervalTier.Interval addInterval(float start,
 float end,
 IntervalTier.InsertionStrategy insertionStrategy)

Add new interval to tier

Parameters:

start -

end -

insertionStrategy -

Returns:

new interval if created, null otherwise

Throws:

IllegalArgumentException - if insertionStrategy is ERROR_ON_OVERLAPS and the given interval overlaps an existing interval in the tier

addInterval

public IntervalTier.Interval addInterval(float start,
 float end,
 String label,
 IntervalTier.InsertionStrategy insertionStrategy)

Add new interval to tier

Parameters:

start -

end -

label -

insertionStrategy -

Returns:

new interval if created, null otherwise

Throws:

IllegalArgumentException - if insertionStrategy is ERROR_ON_OVERLAPS and the given interval overlaps an existing interval in the tier

addInterval

public boolean addInterval(IntervalTier.Interval interval,
 IntervalTier.InsertionStrategy insertionStrategy)

Add new interval to tier

Parameters:

interval -

insertionStrategy -

Returns:

boolean if interval was added, false otherwise

Throws:

IllegalArgumentException - if insertionStrategy is ERROR_ON_OVERLAPS and the given interval overlaps an existing interval in the tier

removeInterval

public boolean removeInterval(IntervalTier.Interval interval)

Remove interval from tier

Parameters:

interval -