eus.ixa.ixa.pipe.ml.sequence

Class SequenceLabel

java.lang.Object

eus.ixa.ixa.pipe.ml.sequence.SequenceLabel

public class SequenceLabel
extends Object

A Sequence object contains a single String, a Span, a startOffset and the length of the String. These attributes are set or returned in response to requests.

Version:

2016-03-14

Author:

ragerri

Constructor Summary

Constructors

Constructor and Description
SequenceLabel() Create a new Sequence with a null content (i.e., str).
SequenceLabel(String aStr, String aType) Create a new Sequence with the given string.
SequenceLabel(String aStr, String aType, int aStartOffset, int aSeqLength) Creates a new Sequence with the given content.
SequenceLabel(String aStr, String aType, Span aSeqSpan) Create a new Sequence with the given string and Span.
SequenceLabel(String aStr, String aType, Span aSeqSpan, int aStartOffset, int aSeqLength) Creates a new Sequence with the given content.

Method Summary

Modifier and Type	Method and Description
Span	getSpan() Return the Span (or null if none).
String	getString() Return the string of the sequence (or null if none).
String	getType() Return the type of the Sequence.
int	sequenceLength()
void	setFromString(String aStr) Set the value from a String.
void	setSequenceLength(int aSeqLength)
void	setSpan(Span span) Set the Span for the Name.
void	setStartOffset(int beginPosition)
void	setType(String neType) Set type of the Sequence.
void	setValue(String value) Set the value for the Sequence.
int	startOffset()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SequenceLabel

public SequenceLabel()

Create a new Sequence with a null content (i.e., str).

SequenceLabel

public SequenceLabel(String aStr,
                     String aType)

Create a new Sequence with the given string.

Parameters:

aStr - the new label's content

aType - the class of the name

SequenceLabel

public SequenceLabel(String aStr,
                     String aType,
                     Span aSeqSpan)

Create a new Sequence with the given string and Span.

Parameters:

aStr - the new label's content

aType - the class of the Span

aSeqSpan - the span of the sequence

SequenceLabel

public SequenceLabel(String aStr,
                     String aType,
                     int aStartOffset,
                     int aSeqLength)

Creates a new Sequence with the given content.

Parameters:

aStr - The new label's content

aType - the class of the Sequence

aStartOffset - Start offset in original text

aSeqLength - End offset in original text

SequenceLabel

public SequenceLabel(String aStr,
                     String aType,
                     Span aSeqSpan,
                     int aStartOffset,
                     int aSeqLength)

Creates a new Sequence with the given content.

Parameters:

aStr - The new label's content

aType - the class of the sequence

aSeqSpan - the sequence span

aStartOffset - Start offset in original text

aSeqLength - End offset in original text

Method Detail

getString

public final String getString()

Return the string of the sequence (or null if none).

Returns:

the string value for the label

getType

public final String getType()

Return the type of the Sequence.

Returns:

the type of the Sequence

getSpan

public final Span getSpan()

Return the Span (or null if none).

Returns:

the Span

setValue

public final void setValue(String value)

Set the value for the Sequence.

Parameters:

value - The value for the Sequence

setType

public final void setType(String neType)

Set type of the Sequence.

Parameters:

neType - the class of the Sequence

setSpan

public final void setSpan(Span span)

Set the Span for the Name.

Parameters:

span - the Span of the name

setFromString

public final void setFromString(String aStr)

Set the value from a String.

Parameters:

aStr - The str for the sequence

toString

public final String toString()

Overrides:

toString in class Object

startOffset

public final int startOffset()

Returns:

the starting offset

sequenceLength

public final int sequenceLength()

Returns:

the length in characters of the sequence

setStartOffset

public final void setStartOffset(int beginPosition)

Parameters:

beginPosition - the starting character

setSequenceLength

public final void setSequenceLength(int aSeqLength)

Parameters:

aSeqLength - the length of the sequence