com.ibm.xdms.function
Interface DatastoreXQuery

All Superinterfaces:
Function

public interface DatastoreXQuery
extends Function

Datastore Implementation which uses DB2 Viper's pureXML Engine


Field Summary
 
Fields inherited from interface com.ibm.xdms.function.Function
COPYRIGHT
 
Method Summary
 java.lang.String buildSipXQuery(java.lang.String defaultNamespace, java.lang.String table, java.lang.String serviceUri, boolean includePresPack)
          Used by RlsXdmSipServlet class
 java.lang.String buildUriXQuery(java.lang.String defaultNamespace, java.lang.String table, java.lang.String serviceUri)
          Used by ResourceListConstraintFilter class
 boolean init(ApplicationUsage appUsage)
          Initializes the function.
 com.ibm.xcap.DocumentSelector transformGlobalIndexDocumentSelector(com.ibm.xcap.DocumentSelector documentSelector, java.lang.String globalIndexPM, javax.sql.DataSource dataSource, java.sql.Connection con)
          Transforms a DocumentSelector for a global/index file to a DocumentSelector for an individual file
 java.util.List<java.lang.String> xquery(java.lang.String query, ApplicationUsage appUsage, javax.sql.DataSource dataSource)
          Performs an XQuery
 java.lang.String xquery(XcapServerRequest request, XcapServerResponse response, javax.sql.DataSource dataSource, java.lang.String table, ApplicationUsage appUsage, XcapCaps xcapCaps)
          Performs an XQuery based on a search request from a client
 
Methods inherited from interface com.ibm.xdms.function.Function
getApplicationUsage
 

Method Detail

init

boolean init(ApplicationUsage appUsage)
Description copied from interface: Function
Initializes the function.

Specified by:
init in interface Function
Parameters:
appUsage - The ApplicationUsage information.
Returns:
Returns true if the function successfully initialized.

xquery

java.util.List<java.lang.String> xquery(java.lang.String query,
                                        ApplicationUsage appUsage,
                                        javax.sql.DataSource dataSource)
                                        throws XcapException
Performs an XQuery

Parameters:
query - XQuery string
appUsage - Application Usage
Returns:
List of results
Throws:
XcapException - error retrieving the document from the database

xquery

java.lang.String xquery(XcapServerRequest request,
                        XcapServerResponse response,
                        javax.sql.DataSource dataSource,
                        java.lang.String table,
                        ApplicationUsage appUsage,
                        XcapCaps xcapCaps)
                        throws XdmsException
Performs an XQuery based on a search request from a client

Parameters:
request - XcapServerRequest
response - XcapServerResponse
dataSource -
table -
appUsage -
Returns:
The search result document as a String
Throws:
XdmsException

buildSipXQuery

java.lang.String buildSipXQuery(java.lang.String defaultNamespace,
                                java.lang.String table,
                                java.lang.String serviceUri,
                                boolean includePresPack)
                                throws java.net.MalformedURLException
Used by RlsXdmSipServlet class

Parameters:
defaultNamespace -
table -
serviceUri -
Returns:
Throws:
java.net.MalformedURLException

buildUriXQuery

java.lang.String buildUriXQuery(java.lang.String defaultNamespace,
                                java.lang.String table,
                                java.lang.String serviceUri)
                                throws java.net.MalformedURLException
Used by ResourceListConstraintFilter class

Parameters:
defaultNamespace -
table -
serviceUri -
Returns:
Throws:
java.net.MalformedURLException

transformGlobalIndexDocumentSelector

com.ibm.xcap.DocumentSelector transformGlobalIndexDocumentSelector(com.ibm.xcap.DocumentSelector documentSelector,
                                                                   java.lang.String globalIndexPM,
                                                                   javax.sql.DataSource dataSource,
                                                                   java.sql.Connection con)
                                                                   throws LocalConstraintFailureException,
                                                                          XcapException,
                                                                          java.net.MalformedURLException
Transforms a DocumentSelector for a global/index file to a DocumentSelector for an individual file

Parameters:
documentSelector -
globalIndexPM -
dataSource -
con -
Returns:
Throws:
LocalConstraintFailureException
XcapException
java.net.MalformedURLException