org.apache.ctakes.core.cc.pretty.textspan

Class DefaultTextSpan

java.lang.Object

org.apache.ctakes.core.cc.pretty.textspan.DefaultTextSpan

All Implemented Interfaces:

TextSpan

@Immutable
public final class DefaultTextSpan
extends Object
implements TextSpan

Holder for begin and end text span offsets within a containing sentence

Constructor Summary

Constructors

Constructor and Description
DefaultTextSpan(org.apache.uima.cas.text.AnnotationFS annotation, int sentenceOffset)
DefaultTextSpan(int begin, int end)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
int	getBegin()
int	getEnd()
int	getWidth()
int	hashCode()
boolean	overlaps(TextSpan textSpan) NOTE: TextSpans are begin inclusive end exclusive.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTextSpan

public DefaultTextSpan(org.apache.uima.cas.text.AnnotationFS annotation,
                       int sentenceOffset)

Parameters:

annotation - -

sentenceOffset - begin span offset of the containing sentence

DefaultTextSpan

public DefaultTextSpan(int begin,
                       int end)

Parameters:

begin - begin offset within the containing sentence

end - end offset within the containing sentence

Method Detail

getBegin

public int getBegin()

Specified by:

getBegin in interface TextSpan

Returns:

begin offset

getEnd

public int getEnd()

Specified by:

getEnd in interface TextSpan

Returns:

end offset

getWidth

public int getWidth()

Specified by:

getWidth in interface TextSpan

Returns:

width of the text span

overlaps

public boolean overlaps(TextSpan textSpan)

NOTE: TextSpans are begin inclusive end exclusive. So, 1 is subtracted from the end when comparing to another begin

Specified by:

overlaps in interface TextSpan

Parameters:

textSpan - another textspan

Returns:

true if there is overlap between the two text spans

toString

public String toString()

Overrides:

toString in class Object

Returns:

a representation of the text span offsets as: begin,end

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object