org.apache.ctakes.dictionary.lookup2.textspan

Class DefaultTextSpan

java.lang.Object

org.apache.ctakes.dictionary.lookup2.textspan.DefaultTextSpan

All Implemented Interfaces:

TextSpan

@Immutable
public final class DefaultTextSpan
extends Object
implements TextSpan

A useful key for hash collections based upon start and end indices. This is faster than using String as String.hashCode() iterates over the internal character array of a new string (new(..), .substring(..), .lowercase(..), ...).

Constructor Summary

Constructors

Constructor and Description
DefaultTextSpan(int start, int end) Given span indices should be ordered start < end, but it is not an absolute requirement.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object object)
int	getEnd()
int	getLength()
int	getStart()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultTextSpan

public DefaultTextSpan(int start,
                       int end)

Given span indices should be ordered start < end, but it is not an absolute requirement.

Parameters:

start - start index of a span, be it of a string or other

end - end index of a span, be it of a string or other

Method Detail

getStart

public int getStart()

Specified by:

getStart in interface TextSpan

Returns:

the start index used for this text span

getEnd

public int getEnd()

Specified by:

getEnd in interface TextSpan

Returns:

the end index used for this text span

getLength

public int getLength()

Specified by:

getLength in interface TextSpan

Returns:

the length of the text span in characters

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Returns:

a hashcode based upon the start and end indices of this span key

equals

public boolean equals(Object object)

Overrides:

equals in class Object

Returns:

true iff the start keys are equal and the end keys are equal

toString

public String toString()

Overrides:

toString in class Object

Returns:

"TextSpan for span [start index] to [end index]"