|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface defines eXist's SOAP service for (read-only) queries on the database.
Method Summary | |
java.lang.String |
connect(java.lang.String user,
java.lang.String password)
Create a new user session. |
void |
disconnect(java.lang.String sessionId)
Release a user session. |
java.lang.String |
getResource(java.lang.String sessionId,
java.lang.String path,
boolean indent,
boolean xinclude)
Retrieve a document from the database. |
Collection |
listCollection(java.lang.String sessionId,
java.lang.String path)
Get information on the specified collection. |
QueryResponse |
query(java.lang.String sessionId,
java.lang.String xpath)
|
java.lang.String[] |
retrieve(java.lang.String sessionId,
int start,
int howmany,
boolean indent,
boolean xinclude,
java.lang.String highlight)
Retrieve a set of query results from the last query executed within the current session. |
java.lang.String[] |
retrieveByDocument(java.lang.String sessionId,
int start,
int howmany,
java.lang.String path,
boolean indent,
boolean xinclude,
java.lang.String highlight)
For the specified document, retrieve a set of query results from the last query executed within the current session. |
Method Detail |
public java.lang.String connect(java.lang.String user, java.lang.String password) throws java.rmi.RemoteException
user
- password
-
java.rmi.RemoteException
- if the user cannot log inpublic void disconnect(java.lang.String sessionId) throws java.rmi.RemoteException
sessionId
- a valid session id as returned by connect().
java.rmi.RemoteException
public java.lang.String getResource(java.lang.String sessionId, java.lang.String path, boolean indent, boolean xinclude) throws java.rmi.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?
java.rmi.RemoteException
public QueryResponse query(java.lang.String sessionId, java.lang.String xpath) throws java.rmi.RemoteException
sessionId
- a valid session id as returned by connect().xpath
- XPath query string.
java.rmi.RemoteException
public java.lang.String[] retrieve(java.lang.String sessionId, int start, int howmany, boolean indent, boolean xinclude, java.lang.String highlight) throws java.rmi.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 "||".
java.rmi.RemoteException
public java.lang.String[] retrieveByDocument(java.lang.String sessionId, int start, int howmany, java.lang.String path, boolean indent, boolean xinclude, java.lang.String highlight) throws java.rmi.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 "||".
java.rmi.RemoteException
public Collection listCollection(java.lang.String sessionId, java.lang.String path) throws java.rmi.RemoteException
sessionId
- a valid session id as returned by connect().path
- the full path to the collection.
java.rmi.RemoteException
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |