efxtools.filtering
Class AScopedQuery

java.lang.Object
  extended by efxtools.filtering.AScopedQuery
Direct Known Subclasses:
EfXScopedQuery

public abstract class AScopedQuery
extends java.lang.Object

Abstract superclass of all scoped query classes. A scoped query represents the extraction problem that shall be addressed by the (aggregate) analysis engine at hand.

A scoped query defines the annotation types, features, and relations between these types and features that shall be extracted from the given input texts. Also, it contains information about the degrees of filtering that refer to each of the given types of information. Technically, a (parsed) scoped query is given by an ordered tree structure of QueryNodes that defines the dependencies between the different relevant information types. The query nodes are ordered in order to maintain the original ordering of a stated query. However, the form, in which a scoped query has to be stated in an application, is not specified in this abstract class. The only information that a query is forced to have is a set of root nodes as well as a type system the requested information types are taken from.

A reference implementation of this class is given in EfXScopedQuery.

Author:
Author of EfXTools

Constructor Summary
AScopedQuery(org.apache.uima.cas.TypeSystem typeSystem, java.lang.Object query)
          Creates an empty set of roots of the query.
 
Method Summary
 java.util.List<QueryNode> getRoots()
          Returns the root nodes of the query.
 org.apache.uima.cas.TypeSystem getTypeSystem()
          Returns the type system.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

AScopedQuery

public AScopedQuery(org.apache.uima.cas.TypeSystem typeSystem,
                    java.lang.Object query)
Creates an empty set of roots of the query. The two parameters for a type system and an input query (in whatever form) are set here in order to force child classes to have such parameters.

Parameters:
typeSystem - The type system
query - The query
Method Detail

getTypeSystem

public org.apache.uima.cas.TypeSystem getTypeSystem()
Returns the type system.

Returns:
The type system

getRoots

public java.util.List<QueryNode> getRoots()
Returns the root nodes of the query.

Returns:
The root nodes

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object