edu.umass.cs.mallet.base.extract
Interface Span

All Known Implementing Classes:
LabeledSpan, StringSpan

public interface Span

A sub-section of a document, either linear or two-dimensional. Spans are immutable.


Method Summary
 java.lang.Object getDocument()
           
 int getEndIdx()
          Returns an integer index identifying the end of this span.
 int getStartIdx()
          Returns an integer index identifying the start of this span.
 java.lang.String getText()
          Returns a textual representatio of the span, suitable for XML output, e.g.
 Span intersection(Span r)
          Returns a new span that is the intersection of this span and another.
 boolean intersects(Span r)
           
 boolean isSubspan(Span r)
           
 

Method Detail

getText

public java.lang.String getText()
Returns a textual representatio of the span, suitable for XML output, e.g.


intersection

public Span intersection(Span r)
Returns a new span that is the intersection of this span and another.


getDocument

public java.lang.Object getDocument()

intersects

public boolean intersects(Span r)

isSubspan

public boolean isSubspan(Span r)

getStartIdx

public int getStartIdx()
Returns an integer index identifying the start of this span. Beware that in some cases (e.g., for images), this may not correspond directly to a sequence index.


getEndIdx

public int getEndIdx()
Returns an integer index identifying the end of this span. Beware that in some cases (e.g., for images), this may not correspond directly to a sequence index.