triana.types.clipins

Class SequenceClipIn

java.lang.Object

triana.types.clipins.SequenceClipIn

public class SequenceClipIn
extends java.lang.Object

A index clip-in specifies the position of an object in a index, and optionally either the total number of objects in that index and when this is the last item in the index.

As with arrays in Java, the indexes of a sequence clipins start a 0 and finish at (length - 1). If the length is not specified then it is set to -1.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SEQUENCE_CLIPIN_TAG

Constructor Summary

Constructors

Constructor and Description
SequenceClipIn(java.lang.String groupid, int index) Constructs a SequenceClipIn with the specified index number
SequenceClipIn(java.lang.String groupid, int index, boolean last) Constructs a SequenceClipIn with the specified index number and a flag indicating this is the last in the index.
SequenceClipIn(java.lang.String groupid, int index, int length) Constructs a SequenceClipIn with the specified index number and a maximum index number.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getComponentType()
java.lang.String	getGroupID()
int	getIndex()
int	getLength()
SequenceClipIn	getSubSequenceClipIn()
boolean	isLastInSequence()
void	setComponentType(java.lang.String classname) Sets the java type for components in this sequence
void	setSubSequenceClipIn(SequenceClipIn subclipin) Sets the sequence clipin for a subsequence

Methods inherited from class java.lang.Object

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

Field Detail

SEQUENCE_CLIPIN_TAG

public static final java.lang.String SEQUENCE_CLIPIN_TAG

See Also:

Constant Field Values

Constructor Detail

SequenceClipIn

public SequenceClipIn(java.lang.String groupid,
              int index)

Constructs a SequenceClipIn with the specified index number

SequenceClipIn

public SequenceClipIn(java.lang.String groupid,
              int index,
              int length)

Constructs a SequenceClipIn with the specified index number and a maximum index number.

SequenceClipIn

public SequenceClipIn(java.lang.String groupid,
              int index,
              boolean last)

Constructs a SequenceClipIn with the specified index number and a flag indicating this is the last in the index.

Method Detail

getGroupID

public java.lang.String getGroupID()

Returns:

the unique group id identifying which sequence this clip-in belongs to

getIndex

public int getIndex()

Returns:

the current index integer (0 <= index < lenght)

getLength

public int getLength()

Returns:

the length of the sequence (or -1 if unknown)

isLastInSequence

public boolean isLastInSequence()

Returns:

true if this is the last in the sequence

getComponentType

public java.lang.String getComponentType()

Returns:

the java type for components in this sequence (null if unknown)

setComponentType

public void setComponentType(java.lang.String classname)

Sets the java type for components in this sequence

getSubSequenceClipIn

public SequenceClipIn getSubSequenceClipIn()

Returns:

the sequence clipin for the subsequence (null if none)

setSubSequenceClipIn

public void setSubSequenceClipIn(SequenceClipIn subclipin)

Sets the sequence clipin for a subsequence