|
Xindice API version 1.2m1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xindice.util.SimpleConfigurable org.apache.xindice.core.query.QueryEngine
QueryEngine is the Xindice Query Engine. Its purpose is to orchestrate query operations against the Xindice repository. The QueryEngine basically just manages a set of QueryResolvers that actually perform the work.
Field Summary |
Fields inherited from class org.apache.xindice.util.SimpleConfigurable |
config |
Constructor Summary | |
QueryEngine(Database db)
|
Method Summary | |
static Key[] |
andKeySets(Key[][] keySets)
andKeySets takes several sets of unique Keys and returns the ANDed set (elements that exist in all sets). |
Query |
compileQuery(Collection col,
String style,
String query,
NamespaceMap nsMap,
Key[] keys)
compileQuery compiles a Query against the specified Collection context and returns the compiled Query. |
static String |
expandEntities(String value)
expandEntities expands the String's pre-defined XML entities (<, >, etc...) into their actual character representations. |
Database |
getDatabase()
|
static Key[] |
getUniqueKeys(IndexMatch[] matches)
getUniqueKeys takes a set of IndexMatch objects and extracts all of its unique Keys in sorted order. |
String[] |
listStyles()
listStyles returns a list of styles supported by the QueryEngine (ex: XPath, XUpdate) |
static String |
normalizeString(String value)
normalizeString normalizes the specific String by stripping all leading, trailing, and continuous runs of white space. |
static Key[] |
orKeySets(Key[][] keySets)
orKeySets takes several sets of unique Keys and returns the ORed set (all unique elements). |
NodeSet |
query(Collection col,
String style,
String query,
NamespaceMap nsMap,
Key[] keys)
query performs the specified query and returns a NodeSet with any possible results from that query. |
void |
setConfig(Configuration config)
setConfig sets the configuration information for the Configurable object instance. |
Methods inherited from class org.apache.xindice.util.SimpleConfigurable |
getConfig |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public QueryEngine(Database db)
Method Detail |
public void setConfig(Configuration config) throws XindiceException
Configurable
setConfig
in interface Configurable
setConfig
in class SimpleConfigurable
XindiceException
public Database getDatabase()
public String[] listStyles()
public NodeSet query(Collection col, String style, String query, NamespaceMap nsMap, Key[] keys) throws DBException, QueryException
col
- The Collection contextstyle
- The query style (XPath, Fulltext, etc...)query
- The QuerynsMap
- The namespace Map (if any)keys
- The initial Key set to use (if any)
DBException
QueryException
public Query compileQuery(Collection col, String style, String query, NamespaceMap nsMap, Key[] keys) throws DBException, QueryException
col
- The Collection contextstyle
- The query style (XPath, Fulltext, etc...)query
- The QuerynsMap
- The namespace Map (if any)keys
- The initial Key set to use (if any)
DBException
QueryException
public static Key[] getUniqueKeys(IndexMatch[] matches)
matches
- The Match Set
public static Key[] andKeySets(Key[][] keySets)
keySets
- 2-dimensional set of Keys
public static Key[] orKeySets(Key[][] keySets)
keySets
- 2-dimensional set of Keys
public static String normalizeString(String value)
value
- The value to normalize
public static String expandEntities(String value)
value
- The value to expand entities for
|
Xindice API version 1.2m1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |