public interface IDfXQuery
Modifier and Type | Interface and Description |
---|---|
static class |
IDfXQuery.FtQueryDebugOptions |
static class |
IDfXQuery.FtQueryOptions
These options are used when executing the xquery against a target of IDfXQueryTargets.DF_FULLTEXT.
|
Modifier and Type | Method and Description |
---|---|
void |
addStore(java.lang.String store_name)
Specifies a storage area to query against.
|
void |
close(IDfSession session)
Closes the XQuery results stream.
|
void |
execute(IDfSession session)
Executes the XQuery.
|
void |
execute(IDfSession session,
com.documentum.xml.xquery.IDfXQueryTargets target)
Executes the XQuery on targets passed in as the parameter.
|
java.lang.String |
getCutoffMessage()
Retrieve the cutoff messages from ESS after the query is executed.
|
java.lang.String |
getDebugInfo(IDfSession session,
IDfXQuery.FtQueryDebugOptions debugOption)
Retrieve debugging information associated with this query
|
java.lang.String |
getExecutionPlan(IDfSession session)
Retrieve the xquery execution plan from ESS after the query is executed.
|
java.io.InputStream |
getInputStream(IDfSession session)
Return an InputStream object that applications can use it to retrieve the xquery results.
|
java.lang.String |
getOption(IDfXQuery.FtQueryOptions option)
To get the value of the option that was set.
|
void |
getXMLFile(java.lang.String filename)
Writes the XQuery results to a file.
|
void |
getXMLOutputStream(java.io.OutputStream outputStream)
Writes the XQuery results to an OutputStream object.
|
java.lang.String |
getXMLString()
Returns the XQuery results as a Java String object.
|
int |
readResults(byte[] buffer)
Fills the given buffer with the next set of XQuery results.
|
int |
readResults(byte[] buffer,
IDfSession session)
Fills the given buffer with the next set of XQuery results.
|
void |
setBooleanOption(IDfXQuery.FtQueryOptions option,
boolean value)
Set an FtQueryOption to apply to the xquery.
|
void |
setIntegerOption(IDfXQuery.FtQueryOptions option,
int value)
Set an FtQueryOption to apply to the xquery.
|
void |
setMapOption(IDfXQuery.FtQueryOptions option,
java.util.Map<java.lang.String,java.lang.String> value)
Set an FtQueryOption to apply to the xquery.
|
void |
setStringOption(IDfXQuery.FtQueryOptions option,
java.lang.String value)
Set an FtQueryOption to apply to the xquery.
|
void |
setXQueryString(java.lang.String xqueryString)
Assigns a XQuery statement to a query.
|
void setXQueryString(java.lang.String xqueryString)
Queries are written with the XQuery Language. This API must be called before executing the query.
xqueryString
- the XQuery statementvoid addStore(java.lang.String store_name)
Used for xqueries directed toward xml store only. This method can be called multiple times to query against multiple storage areas. If no storage areas are specified, the query is executed against all XML storage areas. Call this method before executing the query.
store_name
- the name of the storage areavoid execute(IDfSession session) throws DfException
session
- DFC session identifier that has to be established (connected)
before "execute" is called.DfException
- exceptionvoid execute(IDfSession session, com.documentum.xml.xquery.IDfXQueryTargets target) throws DfException
session
- DFC session identifier that has to be established (connected)target
- DfStoreXQueryTargets or DfFullTextXQueryTargetsDfException
- exceptionint readResults(byte[] buffer) throws DfException
buffer
- The buffer in which XQuery results are written toDfException
- exceptionint readResults(byte[] buffer, IDfSession session) throws DfException
buffer
- The buffer in which XQuery results are written tosession
- The DFC session identifier that has to be established (connected).DfException
- exceptionvoid close(IDfSession session) throws DfException
session
- DFC session identifier that has to be established (connected)DfException
- exceptionvoid getXMLFile(java.lang.String filename) throws DfException
filename
- The path to the file where the results are writtenDfException
- exceptionvoid getXMLOutputStream(java.io.OutputStream outputStream) throws DfException
The method will flush the outputstream after the results are written. The outputstream is not closed by this method.
outputStream
- The output stream in which the results are writtenDfException
- exceptionjava.lang.String getXMLString() throws DfException
DfException
- exceptionvoid setBooleanOption(IDfXQuery.FtQueryOptions option, boolean value) throws DfException
option
- FtQueryOptions optionvalue
- true/falseDfException
- exceptionvoid setIntegerOption(IDfXQuery.FtQueryOptions option, int value) throws DfException
option
- FtQueryOptions optionvalue
- integer valueDfException
- exceptionvoid setMapOption(IDfXQuery.FtQueryOptions option, java.util.Map<java.lang.String,java.lang.String> value) throws DfException
option
- FtQueryOptions optionvalue
- Map valueDfException
- exceptionvoid setStringOption(IDfXQuery.FtQueryOptions option, java.lang.String value) throws DfException
option
- FtQueryOptions optionvalue
- String valueDfException
- exceptionjava.lang.String getOption(IDfXQuery.FtQueryOptions option) throws DfException
option
- FtQueryOptions optionDfException
- exceptionjava.lang.String getExecutionPlan(IDfSession session) throws DfException
session
- - DFC session identifier that has to be established (connected).DfException
- exceptionjava.lang.String getCutoffMessage() throws DfException
DfException
- exceptionjava.lang.String getDebugInfo(IDfSession session, IDfXQuery.FtQueryDebugOptions debugOption) throws DfException
session
- - DFC session identifier that has to be established (connected).debugOption
- - FtQueryDebugOptions optionDfException
- exceptionjava.io.InputStream getInputStream(IDfSession session)
session
- - DFC session identifier that has to be established (connected).Copyright 1994-2023 OpenText Corporation. All rights reserved.