|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Query
Method Summary | |
---|---|
String |
connect(String userId,
String password)
Create a new user session. |
void |
disconnect(String sessionId)
Release a user session. |
String |
getResource(String sessionId,
String path,
boolean indent,
boolean xinclude)
Retrieve a document from the database. |
byte[] |
getResourceData(String sessionId,
String path,
boolean indent,
boolean xinclude,
boolean processXSLPI)
Retrieve a document from the database. |
Collection |
listCollection(String sessionId,
String path)
Get information on the specified collection. |
QueryResponse |
query(String sessionId,
String xpath)
Deprecated. use xquery(String, byte[]) instead. |
String[] |
retrieve(String sessionId,
int start,
int howmany,
boolean indent,
boolean xinclude,
String highlight)
Retrieve a set of query results from the last query executed within the current session. |
String[] |
retrieveByDocument(String sessionId,
int start,
int howmany,
String path,
boolean indent,
boolean xinclude,
String highlight)
For the specified document, retrieve a set of query results from the last query executed within the current session. |
Base64BinaryArray |
retrieveData(String sessionId,
int start,
int howmany,
boolean indent,
boolean xinclude,
String highlight)
Retrieve a set of query results from the last query executed within the current session. |
QueryResponse |
xquery(String sessionId,
byte[] xquery)
Execute an XQuery. |
Method Detail |
---|
String getResource(String sessionId, String path, boolean indent, boolean xinclude) throws RemoteException
sessionId
- a valid session id as returned by connect().path
- the full path to the document.indent
- should the document be pretty-printed (indented)?xinclude
- should xinclude tags be expanded?
RemoteException
QueryResponse query(String sessionId, String xpath) throws RemoteException
xquery(String, byte[])
instead.
sessionId
- a valid session id as returned by connect().xpath
- XPath query string.
RemoteException
String connect(String userId, String password) throws RemoteException
userId
- password
-
RemoteException
- if the user cannot log inString[] retrieve(String sessionId, int start, int howmany, boolean indent, boolean xinclude, String highlight) throws RemoteException
sessionId
- a valid session id as returned by connect().start
- the first result to retrieve.howmany
- number of results to be returned.indent
- should the XML be pretty-printed?xinclude
- should xinclude tags be expanded?highlight
- highlight matching search terms within elements
or attributes. Possible values are: "elements" for elements only,
"attributes" for attributes only, "both" for elements and attributes,
"none" to disable highlighting. For elements, matching terms are
surrounded by <exist:match> tags. For attributes, terms are
marked with the char sequence "||".
RemoteException
void disconnect(String sessionId) throws RemoteException
sessionId
- a valid session id as returned by connect().
RemoteException
byte[] getResourceData(String sessionId, String path, boolean indent, boolean xinclude, boolean processXSLPI) throws RemoteException
sessionId
- a valid session id as returned by connect().path
- the full path to the document.indent
- should the document be pretty-printed (indented)?xinclude
- should xinclude tags be expanded?processXSLPI
- should XSL processing instructions be processed?
RemoteException
QueryResponse xquery(String sessionId, byte[] xquery) throws RemoteException
sessionId
- a valid session id as returned by connect().xquery
- the XQuery script in binary encoding.
RemoteException
Base64BinaryArray retrieveData(String sessionId, int start, int howmany, boolean indent, boolean xinclude, String highlight) throws RemoteException
sessionId
- a valid session id as returned by connect().start
- the first result to retrieve.howmany
- number of results to be returned.indent
- should the XML be pretty-printed?xinclude
- should xinclude tags be expanded?highlight
- highlight matching search terms within elements
or attributes. Possible values are: "elements" for elements only,
"attributes" for attributes only, "both" for elements and attributes,
"none" to disable highlighting. For elements, matching terms are
surrounded by <exist:match> tags. For attributes, terms are
marked with the char sequence "||".
RemoteException
String[] retrieveByDocument(String sessionId, int start, int howmany, String path, boolean indent, boolean xinclude, String highlight) throws RemoteException
sessionId
- a valid session id as returned by connect().start
- the first result to retrieve.howmany
- number of results to be returned.path
- the full path to the document.indent
- should the XML be pretty-printed?xinclude
- should xinclude tags be expanded?highlight
- highlight matching search terms within elements
or attributes. Possible values are: "elements" for elements only,
"attributes" for attributes only, "both" for elements and attributes,
"none" to disable highlighting. For elements, matching terms are
surrounded by <exist:match> tags. For attributes, terms are
marked with the char sequence "||".
RemoteException
Collection listCollection(String sessionId, String path) throws RemoteException
sessionId
- a valid session id as returned by connect().path
- the full path to the collection.
RemoteException
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |