Xindice API
version 1.1

org.apache.xindice.core.query
Interface Query


public interface Query

Query represents a compiled (parsed and primed) query.

Version:
$Revision: 511426 $, $Date: 2007-02-25 04:25:02 +0100 (Sun, 25 Feb 2007) $

Method Summary
 NodeSet execute()
          execute actually Executes the query and returns the resulting NodeSet.
 Key[] getKeySet()
          getKeySet returns the initial set of Keys for this Query.
 NamespaceMap getNamespaceMap()
          getNamespaceMap returns the Map for prefixed namespace resolution in relation to this Query.
 Collection getQueryContext()
          getQueryContext returns the Collection context for this query.
 String getQueryString()
          getQueryString returns the String that was used to create the Query instance.
 String getQueryStyle()
          getQueryStyle returns the QueryStyle (ex: XPath) for this Query instance.
 

Method Detail

getQueryStyle

String getQueryStyle()
getQueryStyle returns the QueryStyle (ex: XPath) for this Query instance.

Returns:
The Query style

getQueryContext

Collection getQueryContext()
getQueryContext returns the Collection context for this query.

Returns:
The Collection context

getQueryString

String getQueryString()
getQueryString returns the String that was used to create the Query instance.

Returns:
The Query String

getNamespaceMap

NamespaceMap getNamespaceMap()
getNamespaceMap returns the Map for prefixed namespace resolution in relation to this Query.

Returns:
The namespace Map (if any)

getKeySet

Key[] getKeySet()
getKeySet returns the initial set of Keys for this Query.

Returns:
The initial Key set (if any)

execute

NodeSet execute()
                throws QueryException
execute actually Executes the query and returns the resulting NodeSet.

Returns:
The NodeSet
Throws:
QueryException

Xindice API
version 1.1

Copyright (c) 1999-2007 The Apache Software Foundation. All Rights Reserved.