eus.ixa.ixa.pipe.nerc

Class Name

java.lang.Object

eus.ixa.ixa.pipe.nerc.Name

public class Name
extends Object

A Name 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:

2013-03-12

Author:

ragerri

Constructor Summary

Constructors

Constructor and Description
Name() Create a new Name with a null content (i.e., str).
Name(String aStr, String aType) Create a new Name with the given string.
Name(String aStr, String aType, int aStartOffset, int aNameLength) Creates a new Name with the given content.
Name(String aStr, String aType, opennlp.tools.util.Span aNeSpan) Create a new Name with the given string and Span.
Name(String aStr, String aType, opennlp.tools.util.Span aNeSpan, int aStartOffset, int aNameLength) Creates a new Name with the given content.

Method Summary

Modifier and Type	Method and Description
opennlp.tools.util.Span	getSpan() Return the Span (or null if none).
String	getType() Return the type of the Name.
int	nameLength()
void	setFromString(String aStr) Set the label from a String.
void	setNameLength(int aNameLength)
void	setSpan(opennlp.tools.util.Span span) Set the Span for the Name.
void	setStartOffset(int beginPosition)
void	setType(String neType) Set type of the Name.
void	setValue(String value) Set the value for the label.
int	startOffset()
String	toString()
String	value() Return the word value of the label (or null if none).

Methods inherited from class java.lang.Object

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

Constructor Detail

Name

public Name()

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

Name

public Name(String aStr,
            String aType)

Create a new Name with the given string.

Parameters:

aStr - the new label's content

aType - the class of the name

Name

public Name(String aStr,
            String aType,
            opennlp.tools.util.Span aNeSpan)

Create a new Name with the given string and Span.

Parameters:

aStr - the new label's content

aType - the Named Entity class of the Name

aNeSpan - the span of the Name

Name

public Name(String aStr,
            String aType,
            int aStartOffset,
            int aNameLength)

Creates a new Name with the given content.

Parameters:

aStr - The new label's content

aType - Named Entity class of the Name

aStartOffset - Start offset in original text

aNameLength - End offset in original text

Name

public Name(String aStr,
            String aType,
            opennlp.tools.util.Span aNeSpan,
            int aStartOffset,
            int aNameLength)

Creates a new Name with the given content.

Parameters:

aStr - The new label's content

aType - Name Entity class of the Name

aNeSpan - the name span

aStartOffset - Start offset in original text

aNameLength - End offset in original text

Method Detail

value

public final String value()

Return the word value of the label (or null if none).

Returns:

String the word value for the label

getType

public final String getType()

Return the type of the Name.

Returns:

the type of the Name

getSpan

public final opennlp.tools.util.Span getSpan()

Return the Span (or null if none).

Returns:

the Span

setValue

public final void setValue(String value)

Set the value for the label.

Parameters:

value - The value for the label

setType

public final void setType(String neType)

Set type of the Name.

Parameters:

neType - the class of the Name

setSpan

public final void setSpan(opennlp.tools.util.Span span)

Set the Span for the Name.

Parameters:

span - the Span of the name

setFromString

public final void setFromString(String aStr)

Set the label from a String.

Parameters:

aStr - The str for the label

toString

public final String toString()

Overrides:

toString in class Object

startOffset

public final int startOffset()

Returns:

the starting offset

nameLength

public final int nameLength()

Returns:

the length in characters of the name

setStartOffset

public final void setStartOffset(int beginPosition)

Parameters:

beginPosition - the starting character

setNameLength

public final void setNameLength(int aNameLength)

Parameters:

aNameLength - the length of the name