org.exist.xmldb
Class LocalXPathQueryService

java.lang.Object
  extended by org.exist.xmldb.LocalXPathQueryService
All Implemented Interfaces:
XPathQueryServiceImpl, Configurable, Service, XPathQueryService, XQueryService

public class LocalXPathQueryService
extends Object
implements XPathQueryServiceImpl, XQueryService


Constructor Summary
LocalXPathQueryService(Subject user, BrokerPool pool, LocalCollection collection, AccessContext accessCtx)
           
 
Method Summary
 void beginProtected()
          Execute all following queries in a protected environment.
 void clearNamespaces()
           
 CompiledExpression compile(String query)
          Compiles the specified XQuery and returns a handle to the compiled code, which can then be passed to XQueryService.execute(CompiledExpression).
 CompiledExpression compileAndCheck(String query)
          Tries to compile the specified XQuery and returns a handle to the compiled code, which can then be passed to XQueryService.execute(CompiledExpression).
 void declareVariable(String qname, Object initialValue)
          Declare an external XPath variable and assign a value to it.
 void dump(CompiledExpression expression, Writer writer)
          Return a diagnostic dump of the query.
 void endProtected()
          Close the protected environment.
 ResourceSet execute(CompiledExpression expression)
          Execute a compiled XQuery.
 ResourceSet execute(Source source)
           
 ResourceSet execute(XMLResource res, CompiledExpression expression)
           
 ResourceSet executeStoredQuery(String uri)
          Executes a query which is already stored in the database
 String getName()
           
 String getNamespace(String prefix)
          Returns the URI string associated with prefix from the internal namespace map.
 String getProperty(String property)
           
 String getVersion()
           
 ResourceSet query(String query)
          Execute the specified query and return the results as a ResourceSet.
 ResourceSet query(String query, String sortBy)
          Process an XPath query and sort the results by applying a second XPath expression to each of the search results.
 ResourceSet query(XMLResource res, String query)
          Process an XPath query based on the result of a previous query.
 ResourceSet query(XMLResource res, String query, String sortBy)
          Process an XPath query based on the result of a previous query and sort the results using the second XPath expression.
 ResourceSet queryResource(String resource, String query)
           
 void removeNamespace(String ns)
          Removes the namespace mapping associated with prefix from the internal namespace map.
 void setCollection(Collection col)
           
 void setModuleLoadPath(String path)
           
 void setNamespace(String prefix, String namespace)
          Sets a namespace mapping in the internal namespace map used to evaluate queries.
 void setProperty(String property, String value)
           
 void setXPathCompatibility(boolean backwardsCompatible)
          Enable or disable XPath 1.0 compatibility mode.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LocalXPathQueryService

public LocalXPathQueryService(Subject user,
                              BrokerPool pool,
                              LocalCollection collection,
                              AccessContext accessCtx)
Method Detail

clearNamespaces

public void clearNamespaces()
                     throws XMLDBException
Specified by:
clearNamespaces in interface XPathQueryService
Specified by:
clearNamespaces in interface XQueryService
Throws:
XMLDBException

getName

public String getName()
               throws XMLDBException
Specified by:
getName in interface Service
Throws:
XMLDBException

getNamespace

public String getNamespace(String prefix)
                    throws XMLDBException
Description copied from interface: XQueryService
Returns the URI string associated with prefix from the internal namespace map. If prefix is null or empty the URI for the default namespace will be returned. If a mapping for the prefix can not be found null is returned.

Specified by:
getNamespace in interface XPathQueryService
Specified by:
getNamespace in interface XQueryService
Parameters:
prefix - The prefix to retrieve from the namespace map.
Returns:
The URI associated with prefix
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getProperty

public String getProperty(String property)
                   throws XMLDBException
Specified by:
getProperty in interface Configurable
Throws:
XMLDBException

getVersion

public String getVersion()
                  throws XMLDBException
Specified by:
getVersion in interface Service
Throws:
XMLDBException

query

public ResourceSet query(String query)
                  throws XMLDBException
Description copied from interface: XQueryService
Execute the specified query and return the results as a ResourceSet.

Specified by:
query in interface XPathQueryService
Specified by:
query in interface XQueryService
Throws:
XMLDBException

query

public ResourceSet query(XMLResource res,
                         String query)
                  throws XMLDBException
Description copied from interface: XPathQueryServiceImpl
Process an XPath query based on the result of a previous query. The XMLResource contains the result received from a previous query.

Specified by:
query in interface XPathQueryServiceImpl
Parameters:
res - an XMLResource as obtained from a previous query.
query - the XPath query
Throws:
XMLDBException

query

public ResourceSet query(String query,
                         String sortBy)
                  throws XMLDBException
Description copied from interface: XPathQueryServiceImpl
Process an XPath query and sort the results by applying a second XPath expression to each of the search results. The result of applying the sort expression is converted into a string, which is then used to sort the set of results.

Specified by:
query in interface XPathQueryServiceImpl
Parameters:
query - the XPath query
sortBy - another XPath expression, which is executed relative to the results of the primary expression.
Throws:
XMLDBException

query

public ResourceSet query(XMLResource res,
                         String query,
                         String sortBy)
                  throws XMLDBException
Description copied from interface: XPathQueryServiceImpl
Process an XPath query based on the result of a previous query and sort the results using the second XPath expression. The XMLResource contains the result received from a previous query.

Specified by:
query in interface XPathQueryServiceImpl
Parameters:
res - an XMLResource as obtained from a previous query
query - the XPath query
sortBy - another XPath expression, which is executed relative to the results of the primary expression. The result of applying sortExpr is converted to a string value, which is then used to sort the results.
Throws:
XMLDBException

execute

public ResourceSet execute(CompiledExpression expression)
                    throws XMLDBException
Description copied from interface: XQueryService
Execute a compiled XQuery. The implementation should pass all namespaces and variables declared through XQueryService to the compiled XQuery code. Note: CompiledExpression is not thread safe. Please make sure you don't call the same compiled expression from two threads at the same time.

Specified by:
execute in interface XQueryService
Throws:
XMLDBException

execute

public ResourceSet execute(XMLResource res,
                           CompiledExpression expression)
                    throws XMLDBException
Throws:
XMLDBException

execute

public ResourceSet execute(Source source)
                    throws XMLDBException
Throws:
XMLDBException

executeStoredQuery

public ResourceSet executeStoredQuery(String uri)
                               throws XMLDBException
Description copied from interface: XPathQueryServiceImpl
Executes a query which is already stored in the database

Specified by:
executeStoredQuery in interface XPathQueryServiceImpl
Parameters:
uri - The URI of the query in the database
Throws:
XMLDBException

compile

public CompiledExpression compile(String query)
                           throws XMLDBException
Description copied from interface: XQueryService
Compiles the specified XQuery and returns a handle to the compiled code, which can then be passed to XQueryService.execute(CompiledExpression). Note: CompiledExpression is not thread safe. Please make sure you don't call the same compiled expression from two threads at the same time.

Specified by:
compile in interface XQueryService
Throws:
XMLDBException

compileAndCheck

public CompiledExpression compileAndCheck(String query)
                                   throws XMLDBException,
                                          XPathException
Description copied from interface: XQueryService
Tries to compile the specified XQuery and returns a handle to the compiled code, which can then be passed to XQueryService.execute(CompiledExpression). If a static error is detected, an XPathException will be thrown.

Throws:
XMLDBException
XPathException

queryResource

public ResourceSet queryResource(String resource,
                                 String query)
                          throws XMLDBException
Specified by:
queryResource in interface XPathQueryService
Specified by:
queryResource in interface XQueryService
Throws:
XMLDBException

beginProtected

public void beginProtected()
                    throws XMLDBException
Execute all following queries in a protected environment. Protected means: it is guaranteed that documents referenced by the query or the result set are not modified by other threads until endProtected() is called.

Specified by:
beginProtected in interface XPathQueryServiceImpl
Throws:
XMLDBException

endProtected

public void endProtected()
Close the protected environment. All locks held by the current thread are released. The result set is no longer guaranteed to be stable.

Specified by:
endProtected in interface XPathQueryServiceImpl

removeNamespace

public void removeNamespace(String ns)
                     throws XMLDBException
Description copied from interface: XQueryService
Removes the namespace mapping associated with prefix from the internal namespace map. If prefix is null or empty the mapping for the default namespace will be removed.

Specified by:
removeNamespace in interface XPathQueryService
Specified by:
removeNamespace in interface XQueryService
Parameters:
ns - The prefix to remove from the namespace map. If prefix is null or empty the mapping for the default namespace will be removed.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

setCollection

public void setCollection(Collection col)
                   throws XMLDBException
Specified by:
setCollection in interface Service
Throws:
XMLDBException

setNamespace

public void setNamespace(String prefix,
                         String namespace)
                  throws XMLDBException
Description copied from interface: XQueryService
Sets a namespace mapping in the internal namespace map used to evaluate queries. If prefix is null or empty the default namespace is associated with the provided URI. A null or empty uri results in an exception being thrown.

Specified by:
setNamespace in interface XPathQueryService
Specified by:
setNamespace in interface XQueryService
Parameters:
prefix - The prefix to set in the map. If prefix is empty or null the default namespace will be associated with the provided URI.
namespace - The URI for the namespace to be associated with prefix.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.
TODO: probably need some special error here.

setProperty

public void setProperty(String property,
                        String value)
                 throws XMLDBException
Specified by:
setProperty in interface Configurable
Throws:
XMLDBException

declareVariable

public void declareVariable(String qname,
                            Object initialValue)
                     throws XMLDBException
Description copied from interface: XPathQueryServiceImpl
Declare an external XPath variable and assign a value to it. A variable can be referenced inside an XPath expression as $variable. For example, if you declare a variable with
        declareVariable("name", "HAMLET");
 
you may use the variable in an XPath expression as follows:
        //SPEECH[SPEAKER=$name]
 
Any Java object may be passed as initial value. The query engine will try to map this into a corresponding XPath value. You may also pass an XMLResource as obtained from another XPath expression. This will be converted into a node.

Specified by:
declareVariable in interface XPathQueryServiceImpl
Specified by:
declareVariable in interface XQueryService
Parameters:
qname - a valid QName by which the variable is identified. Any prefix should have been mapped to a namespace, i.e. if a variable is called x:name, there should be a prefix/namespace mapping for the prefix x
initialValue - the initial value, which is assigned to the variable
Throws:
XMLDBException

setXPathCompatibility

public void setXPathCompatibility(boolean backwardsCompatible)
Description copied from interface: XQueryService
Enable or disable XPath 1.0 compatibility mode. In XPath 1.0 compatibility mode, some XQuery expressions will behave different. In particular, additional automatic type conversions will be applied to the operands of numeric operators.

Specified by:
setXPathCompatibility in interface XQueryService

setModuleLoadPath

public void setModuleLoadPath(String path)
Specified by:
setModuleLoadPath in interface XQueryService

dump

public void dump(CompiledExpression expression,
                 Writer writer)
          throws XMLDBException
Description copied from interface: XQueryService
Return a diagnostic dump of the query. The query should have been executed before calling this function.

Throws:
XMLDBException


Copyright (C) The eXist-db Project. All rights reserved.