org.exist.xmldb
Class LocalXPathQueryService

java.lang.Object
  org.exist.xmldb.LocalXPathQueryService

All Implemented Interfaces:

XPathQueryServiceImpl, XQueryService

public class LocalXPathQueryService

extends java.lang.Object

implements XPathQueryServiceImpl, XQueryService

Field Summary

protected AccessContext	accessCtx
protected BrokerPool	brokerPool
protected LocalCollection	collection
protected boolean	lockDocuments
protected DocumentSet	lockedDocuments
protected java.lang.String	moduleLoadPath
protected java.util.TreeMap	namespaceDecls
protected java.util.Properties	properties
protected User	user
protected java.util.TreeMap	variableDecls
protected boolean	xpathCompatible

Constructor Summary

LocalXPathQueryService(User user, BrokerPool pool, LocalCollection collection, AccessContext accessCtx)

Method Summary

void	beginProtected() Execute all following queries in a protected environment.
void	clearNamespaces()
CompiledExpression	compile(java.lang.String query) Compiles the specified XQuery and returns a handle to the compiled code, which can then be passed to execute(CompiledExpression).
CompiledExpression	compileAndCheck(java.lang.String query) Tries to compile the specified XQuery and returns a handle to the compiled code, which can then be passed to execute(CompiledExpression).
void	declareVariable(java.lang.String qname, java.lang.Object initialValue) Declare an external XPath variable and assign a value to it.
void	dump(CompiledExpression expression, java.io.Writer writer) Return a diagnostic dump of the query.
void	endProtected() Close the protected environment.
ResourceSet	execute(CompiledExpression expression)
ResourceSet	execute(XMLResource res, CompiledExpression expression)
java.lang.String	getName()
java.lang.String	getNamespace(java.lang.String prefix) Returns the URI string associated with prefix from the internal namespace map.
java.lang.String	getProperty(java.lang.String property)
java.lang.String	getVersion()
ResourceSet	query(java.lang.String query) Execute the specified query and return the results as a ResourceSet.
ResourceSet	query(XMLResource res, java.lang.String query) Process an XPath query based on the result of a previous query.
ResourceSet	query(XMLResource res, java.lang.String query, java.lang.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(java.lang.String resource, java.lang.String query)
void	removeNamespace(java.lang.String ns) Removes the namespace mapping associated with prefix from the internal namespace map.
void	setCollection(Collection col)
void	setModuleLoadPath(java.lang.String path)
void	setNamespace(java.lang.String prefix, java.lang.String namespace) Sets a namespace mapping in the internal namespace map used to evaluate queries.
void	setProperty(java.lang.String property, java.lang.String value)
protected void	setupContext(XQueryContext context)
void	setXPathCompatibility(boolean backwardsCompatible) Enable or disable XPath 1.0 compatibility mode.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.exist.xmldb.XQueryService

execute

Field Detail

brokerPool

protected BrokerPool brokerPool

collection

protected LocalCollection collection

user

protected User user

namespaceDecls

protected java.util.TreeMap namespaceDecls

variableDecls

protected java.util.TreeMap variableDecls

xpathCompatible

protected boolean xpathCompatible

moduleLoadPath

protected java.lang.String moduleLoadPath

properties

protected java.util.Properties properties

lockDocuments

protected boolean lockDocuments

lockedDocuments

protected DocumentSet lockedDocuments

accessCtx

protected AccessContext accessCtx

Constructor Detail

LocalXPathQueryService

public LocalXPathQueryService(User user,
                              BrokerPool pool,
                              LocalCollection collection,
                              AccessContext accessCtx)

Method Detail

clearNamespaces

public void clearNamespaces()
                     throws XMLDBException

Throws:

XMLDBException

getName

public java.lang.String getName()
                         throws XMLDBException

Throws:

XMLDBException

getNamespace

public java.lang.String getNamespace(java.lang.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 XQueryService

Parameters:

prefix - The prefix to retrieve from the namespace map.

Returns:

The URI associated with prefix

Throws:

XMLDBException

getProperty

public java.lang.String getProperty(java.lang.String property)
                             throws XMLDBException

Throws:

XMLDBException

getVersion

public java.lang.String getVersion()
                            throws XMLDBException

Throws:

XMLDBException

query

public ResourceSet query(java.lang.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 XQueryService

Parameters:

query -

Returns:

Throws:

XMLDBException

query

public ResourceSet query(XMLResource res,
                         java.lang.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(XMLResource res,
                         java.lang.String query,
                         java.lang.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

Throws:

XMLDBException

execute

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

Specified by:

execute in interface XQueryService

Throws:

XMLDBException

compile

public CompiledExpression compile(java.lang.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 #execute(CompiledExpression).

Specified by:

compile in interface XQueryService

Parameters:

query -

Returns:

Throws:

XMLDBException

compileAndCheck

public CompiledExpression compileAndCheck(java.lang.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 #execute(CompiledExpression). If a static error is detected, an XPathException will be thrown.

Specified by:

compileAndCheck in interface XQueryService

Parameters:

query -

Returns:

Throws:

XMLDBException

XPathException

queryResource

public ResourceSet queryResource(java.lang.String resource,
                                 java.lang.String query)
                          throws XMLDBException

Throws:

XMLDBException

setupContext

protected void setupContext(XQueryContext context)
                     throws XMLDBException,
                            XPathException

Throws:

XMLDBException

XPathException

beginProtected

public void beginProtected()

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

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(java.lang.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 XQueryService

Throws:

XMLDBException

setCollection

public void setCollection(Collection col)
                   throws XMLDBException

Throws:

XMLDBException

setNamespace

public void setNamespace(java.lang.String prefix,
                         java.lang.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 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.

Throws:

XMLDBException

setProperty

public void setProperty(java.lang.String property,
                        java.lang.String value)
                 throws XMLDBException

Throws:

XMLDBException

declareVariable

public void declareVariable(java.lang.String qname,
                            java.lang.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

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

Parameters:

backwardsCompatible -

setModuleLoadPath

public void setModuleLoadPath(java.lang.String path)

Specified by:

setModuleLoadPath in interface XQueryService

dump

public void dump(CompiledExpression expression,
                 java.io.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.

Specified by:

dump in interface XQueryService

Parameters:

expression -

writer -

Throws:

XMLDBException