|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.util.AbstractCollection<E>
java.util.AbstractList<E>
java.util.ArrayList<org.apache.uima.jcas.tcas.Annotation>
efxtools.filtering.Scope
public class Scope
This class represents the set of all scopes. A scope defines a set of portions of
an input text that are possibly relevant with respect to one or more types of
information that refer to an extraction problem.
Technically, a scope is realized as an ordered list of instances of the most
general UIMA annotation type Annotation. The
ordering ensures that the original ordering of the portions of the input text is
maintained.
The filtering framework uses scopes that permanently refer to one or more
information types of a given query as well as temporary scopes that are e.g. used
to compute the portions of text that have to be analyzed by a concrete (primitive)
analysis engine.
All scopes have a unique scope ID. If a scope refers to the information types of
a query, its text units have an explicitly defined annotation type. Moreover, a
scope has a root scope and a set of descendant scopes according to the hierarchical
structure of AScopedQuery.
| Constructor Summary | |
|---|---|
Scope()
The constructor creates an empty scope. |
|
| Method Summary | |
|---|---|
void |
addDescendants(java.util.Collection<Scope> descendants)
Adds all given descendant scopes to the descendant scopes of this scope. |
boolean |
equals(java.lang.Object object)
|
java.util.Set<Scope> |
getAllDescendants()
Returns all descendant scopes of this scope in the tree structure of the query this scope refers to. |
int |
getCoveredCharacters()
Returns the number of characters currently covered by this scope. |
Scope |
getRoot()
Returns the root scope of this scope in the tree structure of the query this scope refers to. |
long |
getScopeID()
Returns the scope ID of this scope. |
org.apache.uima.cas.Type |
getType()
Returns the annotation type of the text units of this scope. |
void |
setDescendants(java.util.Set<Scope> descendants)
Sets the descendant scopes of this scope in the tree structure of the query this scope refers to. |
void |
setRoot(Scope root)
Sets the root scope of this scope in the tree structure of the query the scope refers to. |
void |
setScopeID(long scopeID)
Sets the scope ID of the scope. |
void |
setType(org.apache.uima.cas.Type type)
Sets the annotation type of the text units of this scope to the given type. |
| Methods inherited from class java.util.ArrayList |
|---|
add, add, addAll, addAll, clear, clone, contains, ensureCapacity, get, indexOf, isEmpty, lastIndexOf, remove, remove, set, size, toArray, toArray, trimToSize |
| Methods inherited from class java.util.AbstractList |
|---|
hashCode, iterator, listIterator, listIterator, subList |
| Methods inherited from class java.util.AbstractCollection |
|---|
containsAll, removeAll, retainAll, toString |
| Methods inherited from class java.lang.Object |
|---|
getClass, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface java.util.List |
|---|
containsAll, hashCode, iterator, listIterator, listIterator, removeAll, retainAll, subList |
| Constructor Detail |
|---|
public Scope()
| Method Detail |
|---|
public void setScopeID(long scopeID)
scopeID - The scope IDpublic void setRoot(Scope root)
root - The root scopepublic void setType(org.apache.uima.cas.Type type)
type - The type to be setpublic void setDescendants(java.util.Set<Scope> descendants)
descendants - The descendant scopespublic void addDescendants(java.util.Collection<Scope> descendants)
descendants - The descendant scopes to be addedpublic long getScopeID()
public Scope getRoot()
public org.apache.uima.cas.Type getType()
public java.util.Set<Scope> getAllDescendants()
public boolean equals(java.lang.Object object)
equals in interface java.util.Collection<org.apache.uima.jcas.tcas.Annotation>equals in interface java.util.List<org.apache.uima.jcas.tcas.Annotation>equals in class java.util.AbstractList<org.apache.uima.jcas.tcas.Annotation>public int getCoveredCharacters()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||