org.apache.xindice.core.query
Class TextQueryResolver

java.lang.Object
  org.apache.xindice.util.SimpleConfigurable
      org.apache.xindice.core.query.TextQueryResolver

All Implemented Interfaces:

Configurable, QueryResolver

public class TextQueryResolver

extends SimpleConfigurable

implements QueryResolver

Query resolver for full text queries. Requires existing full text index to work.

Version:

$Revision: 577512 $, $Date: 2007-09-19 22:27:54 -0400 (Wed, 19 Sep 2007) $

Author:

Andy Armstrong

See Also:

LuceneIndexer

Field Summary

static String

STYLE_FT

Fields inherited from class org.apache.xindice.util.SimpleConfigurable

config

Constructor Summary

TextQueryResolver()

Method Summary

Query	compileQuery(Collection context, String query, NamespaceMap nsMap, Key[] keys) compileQuery compiles a Query against the specified Collection context and returns the compiled Query.
String	getQueryStyle() getQueryStyle returns the Query style supported by this Resolver.
NodeSet	query(Collection context, String query, NamespaceMap nsMap, Key[] keys) query compiles a Query against the specified Collection context and returns the query results.
void	setQueryEngine(QueryEngine engine) setQueryEngine hands a reference for the QueryEngine to the Resolver.

Methods inherited from class org.apache.xindice.util.SimpleConfigurable

getConfig, setConfig

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.xindice.util.Configurable

getConfig, setConfig

Field Detail

STYLE_FT

public static final String STYLE_FT

See Also:

Constant Field Values

Constructor Detail

TextQueryResolver

public TextQueryResolver()

Method Detail

setQueryEngine

public void setQueryEngine(QueryEngine engine)

Description copied from interface: QueryResolver

setQueryEngine hands a reference for the QueryEngine to the Resolver.

Specified by:

setQueryEngine in interface QueryResolver

Parameters:

engine - The QueryEngine

getQueryStyle

public String getQueryStyle()

Description copied from interface: QueryResolver

getQueryStyle returns the Query style supported by this Resolver.

Specified by:

getQueryStyle in interface QueryResolver

Returns:

The query style

compileQuery

public Query compileQuery(Collection context,
                          String query,
                          NamespaceMap nsMap,
                          Key[] keys)
                   throws QueryException

Description copied from interface: QueryResolver

compileQuery compiles a Query against the specified Collection context and returns the compiled Query. This DOES NOT actually run the query, merely just parses it and primes any possible Indexers that the query might need.

Specified by:

compileQuery in interface QueryResolver

Parameters:

context - The Collection Context

query - The Query

nsMap - The namespace Map (if any)

keys - The initial Key set to use (if any)

Returns:

The compiled Query

Throws:

QueryException

query

public NodeSet query(Collection context,
                     String query,
                     NamespaceMap nsMap,
                     Key[] keys)
              throws QueryException

Description copied from interface: QueryResolver

query compiles a Query against the specified Collection context and returns the query results.

Specified by:

query in interface QueryResolver

Parameters:

context - The Collection Context

query - The Query

nsMap - The namespace Map (if any)

keys - The initial Key set to use (if any)

Returns:

The resulting NodeSet

Throws:

QueryException