net.sf.xaj
Interface XmlDb.XQuerySearchCriteria

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

BasicXQuerySearchCriteria

Enclosing interface:

XmlDb

public static interface XmlDb.XQuerySearchCriteria
extends java.io.Serializable

XQuery search criteria.

Method Summary

boolean	expectDocument() If true then a single XML document is expected as the results of the XQuery, otherwise a set of results is expected.
int	getPage() Get the page of search results to return.
int	getPageSize() Get the desired page size.
java.util.Map<java.lang.String,java.lang.Object>	getVariables() Get a Map of XQuery variable names to their associated values.
java.lang.String	getXQuery() Get the XQuery to execute.
boolean	queryPlan() If true then return just an implementation-specific query plan for the XQuery.

Method Detail

getXQuery

java.lang.String getXQuery()

Get the XQuery to execute.

Returns:

the XQuery

expectDocument

boolean expectDocument()

If true then a single XML document is expected as the results of the XQuery, otherwise a set of results is expected.

Returns:

true if expect a single XML document

queryPlan

boolean queryPlan()

If true then return just an implementation-specific query plan for the XQuery. The XQuery need not be executed.

Returns:

true just to generate the query plan

getVariables

java.util.Map<java.lang.String,java.lang.Object> getVariables()

Get a Map of XQuery variable names to their associated values.

Returns:

Map of variables

getPage

int getPage()

Get the page of search results to return.

Returns:

the page

getPageSize

int getPageSize()

Get the desired page size.

Returns:

page size (results per page)