A B C D E F G H I J K L M N O P R S T U W X

A

acceptsURI(String) - Method in class org.xquark.extractor.ExtractorDriver

acceptsURI(String) - Method in interface org.xquark.xml.xdbc.XMLDriver

Returns true if the driver understand the specified connection string

B

BasicXMLSerializer - class org.xquark.serialize.BasicXMLSerializer.

A simple SAX2 XML serializer implementing SAX ContentHandler and LexicalHandler.

BasicXMLSerializer(OutputStream) - Constructor for class org.xquark.serialize.BasicXMLSerializer

Creates new BasicXMLSerializer

BasicXMLSerializer(Writer) - Constructor for class org.xquark.serialize.BasicXMLSerializer

Creates new BasicXMLSerializer

BasicXMLSerializer(OutputStream, String) - Constructor for class org.xquark.serialize.BasicXMLSerializer

Creates new BasicXMLSerializer

BasicXMLSerializer(Writer, String) - Constructor for class org.xquark.serialize.BasicXMLSerializer

Creates new BasicXMLSerializer

C

COLUMN_NAME - Static variable in class org.xquark.mapping.CompilationContext

This property contains the name of the column where the generator value will be stored.

CompilationContext - class org.xquark.mapping.CompilationContext.

Provide access to the mapping compilation context allowing to use the same generator code for multiple use.

CompilationContext() - Constructor for class org.xquark.mapping.CompilationContext

Configurable - interface org.xquark.xml.xdbc.Configurable.

This interface provides setters and getters for metadata (features or properties) associated to an object.

characters(char[], int, int) - Method in class org.xquark.serialize.BasicXMLSerializer

clearBuffer() - Method in interface org.xquark.bridge.Mapper

Discards the XML data buffered by the filer since the last call to flushBuffer() method.

clearBuffer() - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Discards the XML data buffered by the filer since the last call to flushBuffer() method.

clearVariables() - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

Clears the current parameters values immediately.

close() - Method in interface org.xquark.bridge.Mapper

Closes the object and frees its associated resources.

close() - Method in class org.xquark.bridge.Mapping

Frees all resources associated to the object

close() - Method in class org.xquark.bridge.XQBridge

Closes the extractor and the underlying resources among which the internal JDBC data source except if it was passed at construction time.

close() - Method in class org.xquark.extractor.Extractor

Closes the extractor and the underlying resources among which the internal JDBC data source except if it was passed at construction time.

close() - Method in class org.xquark.extractor.ExtractorConnection

close() - Method in class org.xquark.serialize.BasicXMLSerializer

Closes the user stream.

close() - Method in class org.xquark.serialize.XMLSerializer

Closes the user stream.

close() - Method in interface org.xquark.xml.xdbc.XMLCollection

Closes this XMLCollection.

close() - Method in interface org.xquark.xml.xdbc.XMLConnection

To close the current data source connection.

close() - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Closes the object and frees its associated resources.

close() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Releases this result set object's resources immediately instead of waiting for this to happen when it is automatically closed.

close() - Method in interface org.xquark.xml.xdbc.XMLStatement

Releases the statement XMLDBC resources immediately instead of waiting for this to happen when it is automatically closed.

comment(char[], int, int) - Method in class org.xquark.serialize.BasicXMLSerializer

commit() - Method in class org.xquark.extractor.ExtractorConnection

commit() - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

Makes all changes made since the previous commit/rollback permanent and releases any data source locks currently held by the connection.

commit() - Method in interface org.xquark.xml.xdbc.XMLConnection

Makes all changes made since the previous commit/rollback permanent and releases any data source locks currently held by the Connection.

completeStartTag() - Method in class org.xquark.serialize.BasicXMLSerializer

completeStartTag() - Method in class org.xquark.serialize.XMLSerializer

Closes the potentially open element start tag waiting to know by the following events if the tag is empty.

containsDocument(String) - Method in interface org.xquark.xml.xdbc.XMLCollection

Checks if a named XML document exists in this XML collection.

createCollection(String, String, Configurable) - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To create a new XML collection.

createCollection(String, String, Configurable) - Method in interface org.xquark.xml.xdbc.XMLConnection

Creates a new XML collection.

createCollectionConfig() - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To create a new XML Collection configuration for set features and properties before create a XML Collection.

createCollectionConfig() - Method in interface org.xquark.xml.xdbc.XMLConnection

Creates a new XML Collection configuration for set features and properties before create a XML Collection.

createStatement(short) - Method in class org.xquark.extractor.ExtractorConnection

createStatement() - Method in class org.xquark.extractor.ExtractorConnection

createStatement() - Method in interface org.xquark.xml.xdbc.XMLConnection

Creates a statement object for sending XQuery (query type by default) statements to the data source.

createStatement(short) - Method in interface org.xquark.xml.xdbc.XMLConnection

Creates a statement object for sending XQuery or XPath (according to the specified type) statements to the data source.

D

DBMS_TYPE - Static variable in class org.xquark.mapping.CompilationContext

Returns one of the following constants: DBMSConstants.ORACLE, DBMSConstants.MYSQL, DBMSConstants.SQL_SERVER, DBMSConstants.SYBASE.

DefaultReadOnlyXMLConnection - class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection.

A default implementation of XMLConnection for read-only connections

DefaultReadOnlyXMLConnection() - Constructor for class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

Creates a new instance of DefaultReadOnlyXMLConnection

deleteAllCollections() - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To delete all XML collections of this connection.

deleteAllCollections() - Method in interface org.xquark.xml.xdbc.XMLConnection

Deletes all XML collections of this connection.

deleteCollection(String) - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To delete a XML collection by its name.

deleteCollection(String) - Method in interface org.xquark.xml.xdbc.XMLConnection

Deletes an XML collection by its name.

deregisterDriver(XMLDriver) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Removes the specified driver from the driver manager list.

E

EXTRACTOR_URL_PREFIX - Static variable in class org.xquark.extractor.ExtractorDriver

Extractor - class org.xquark.extractor.Extractor.

Extractor XML/DBC DataSource implementation.

Extractor(String) - Constructor for class org.xquark.extractor.Extractor

Constructor to use with a configuration file URL or a JNDI name referencing a JDBC datasource instance.

Extractor(String, ClassLoader) - Constructor for class org.xquark.extractor.Extractor

Use this constructor when you need a specific classloader that will be used to load JDBC drivers.

Extractor(File) - Constructor for class org.xquark.extractor.Extractor

Constructor to use with an extractor configuration file.

Extractor(File, ClassLoader) - Constructor for class org.xquark.extractor.Extractor

Use this constructor when you need a specific classloader that will be used to load JDBC drivers.

Extractor(DataSource) - Constructor for class org.xquark.extractor.Extractor

Constructor to use with a JDBC data source.

Extractor(DataSource, String) - Constructor for class org.xquark.extractor.Extractor

Constructor to use with a JDBC data source and an extractor configuration file URL.

Extractor(DataSource, File) - Constructor for class org.xquark.extractor.Extractor

Constructor to use with a JDBC data source and an extractor configuration file.

Extractor(String, String, String) - Constructor for class org.xquark.extractor.Extractor

Construction to use when JDBC connection parameters are available.

Extractor(String, String, String, ClassLoader) - Constructor for class org.xquark.extractor.Extractor

Use this constructor when you need a specific classloader that will be used to load JDBC drivers.

Extractor(Connection) - Constructor for class org.xquark.extractor.Extractor

Deprecated. prevents the use of an external or internal data source.

Extractor(Connection, String) - Constructor for class org.xquark.extractor.Extractor

Deprecated. prevents the use of an external or internal data source.

Extractor(Connection, String, ClassLoader) - Constructor for class org.xquark.extractor.Extractor

Deprecated. prevents the use of an external or internal data source.

ExtractorConnection - class org.xquark.extractor.ExtractorConnection.

Extractor implementation of XMLConnection.

ExtractorDriver - class org.xquark.extractor.ExtractorDriver.

endCDATA() - Method in class org.xquark.serialize.BasicXMLSerializer

endDocument() - Method in class org.xquark.serialize.BasicXMLSerializer

endElement(String, String, String) - Method in class org.xquark.serialize.BasicXMLSerializer

error(XMLDBCException) - Method in interface org.xquark.xml.xdbc.XMLErrorHandler

Receive notification of an error that did not prevent the document storage.

errorCode - Variable in class org.xquark.xml.xdbc.XMLDBCException

The error code of this exception.

exception - Variable in class org.xquark.xml.xdbc.XMLDBCException

The underlying exception (or error) of this exception.

execute() - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

Executes the query statement specified when this object was built with the prepareStatement method (see XMLConnection interface) that may return results.

execute(String) - Method in interface org.xquark.xml.xdbc.XMLStatement

Deprecated. Not useful since updates are not available.

execute(String, int) - Method in interface org.xquark.xml.xdbc.XMLStatement

Deprecated. Not useful since updates are not available.

executeDocumentQuery(String) - Method in interface org.xquark.xml.xdbc.XMLStatement

Executes a query statement of the type specified when this object was built with the createStatement method (see XMLConnection interface) that returns complete XML documents.

executeQuery() - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

Executes the query statement specified when this object was built with the prepareStatement method (see XMLConnection interface) that returns results.

executeQuery(String) - Method in interface org.xquark.xml.xdbc.XMLStatement

Executes a query statement of the type specified when this object was built with the createStatement method (see XMLConnection interface) that returns results.

executeQuery(String, int) - Method in interface org.xquark.xml.xdbc.XMLStatement

Deprecated. Distinction is no relevant anymore because XPath is now a subset of XQuery.

F

finalize() - Method in class org.xquark.extractor.ExtractorConnection

flush() - Method in class org.xquark.serialize.BasicXMLSerializer

Flushes the user stream.

flush() - Method in class org.xquark.serialize.XMLSerializer

Flushes the user stream.

flushBuffer() - Method in interface org.xquark.bridge.Mapper

Sends buffered XML data to the data source.

flushBuffer() - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Sends buffered XML data to the data source.

G

Generator - interface org.xquark.mapping.Generator.

Object that provide the value to store in a column

getActualNodeData() - Method in interface org.xquark.mapping.StorageContext

Return the XML Schema actual value attached to the current node if any, converted to a java object.

getAsDOM() - Method in interface org.xquark.xml.xdbc.XMLDocument

Deprecated. New method name is XMLDocument.getAsDocument()

getAsDOM(Element) - Method in interface org.xquark.xml.xdbc.XMLDocument

Attaches a DOM2 fragment corresponding to the XML document to the Element node passed as a parameter.

getAsDocument() - Method in interface org.xquark.xml.xdbc.XMLDocument

Returns the document content as a DOM2 Document.

getAsSAX() - Method in interface org.xquark.xml.xdbc.XMLDocument

Returns the document content as a SAX2 event flow.

getAsStream(Writer) - Method in interface org.xquark.xml.xdbc.XMLDocument

Returns the document content in a provided character stream.

getAsString() - Method in interface org.xquark.xml.xdbc.XMLDocument

Returns the document content as an XML string.

getAutoCommit() - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To know the current auto-commit state.

getAutoCommit() - Method in interface org.xquark.xml.xdbc.XMLConnection

To know the current auto-commit state.

getAutoFlush() - Method in interface org.xquark.bridge.Mapper

Retrieves the current buffering mode.

getAutoFlush() - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Retrieves the current buffering mode.

getAutoStreamClose() - Method in class org.xquark.serialize.BasicXMLSerializer

Return the value set for stream automatic close feature.

getAutoStreamClose() - Method in class org.xquark.serialize.XMLSerializer

Return the value set for stream automatic close feature.

getBaseURI() - Method in interface org.xquark.xml.xdbc.XMLStatement

gets the base URI for documents.

getCanonicalOutput() - Method in class org.xquark.serialize.BasicXMLSerializer

Accessor to the current ordering mode for attributes.

getCanonicalOutput() - Method in class org.xquark.serialize.XMLSerializer

Accessor to the current ordering mode for attributes.

getCapabilities() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

To get the set of capabilities of the data source.

getClassLoader() - Method in class org.xquark.bridge.XQBridge

Returns the class loader used for loading drivers, mappings and user generators.

getCode() - Method in class org.xquark.xml.xdbc.XMLDBCException

To get the code of this exception/error.

getCollection(String) - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To retrieve a XMLcollection by its name.

getCollection(String) - Method in interface org.xquark.xml.xdbc.XMLConnection

Creates an XMLcollection object featuring the XML documents collection.

getCollection() - Method in interface org.xquark.xml.xdbc.XMLDocument

Returns the XML collection to which this document belongs.

getCollection() - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Returns the XML collection that produced this object.

getCollectionNames() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

getConnection() - Method in interface org.xquark.bridge.Mapper

Return the JDBC connection used by this object.

getConnection() - Method in class org.xquark.bridge.XQBridge

Deprecated. This method is linked to the deprecated constructor XQBridge.XQBridge(Connection, String).

getConnection() - Method in class org.xquark.extractor.Extractor

Creates a new XML/DBC connection instance.

getConnection(String, String) - Method in class org.xquark.extractor.Extractor

Not implemented by Extractor.

getConnection() - Method in interface org.xquark.mapping.StorageContext

Return the JDBC Connection used by the storage module.

getConnection() - Method in interface org.xquark.xml.xdbc.XMLCollection

Retrieves the XMLConnection object that produced this XMLCollection.

getConnection() - Method in interface org.xquark.xml.xdbc.XMLDataSource

Attempts to establish a connection with the data source.

getConnection(String, String) - Method in interface org.xquark.xml.xdbc.XMLDataSource

Attempts to establish a connection with the data source.

getConnection() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

To get the XMLConnection object that produced this XMLDataSourceMetaData object.

getConnection(String) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Attempts to establish a connection to the given data source URI.

getConnection(String, String, String) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Attempts to establish a connection to the given data source URI with a login/password.

getConnection() - Method in interface org.xquark.xml.xdbc.XMLStatement

Returns the connection object that produced this statement.

getContentHandler() - Method in interface org.xquark.xml.xdbc.XMLDocument

Retrieves the current (SAX2) content handler.

getContentHandler() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the current content handler.

getDataSource() - Method in class org.xquark.bridge.Mapping

Returns the JDBC data source used by this mapping.

getDataSource(String) - Method in class org.xquark.extractor.ExtractorDriver

getDataSource(String, String, String) - Method in class org.xquark.extractor.ExtractorDriver

getDataSource(String) - Method in interface org.xquark.xml.xdbc.XMLDriver

To obtain a handle to a data source with the specified URI.

getDataSource(String, String, String) - Method in interface org.xquark.xml.xdbc.XMLDriver

To obtain a handle to a data source with the specified URI, user name and password.

getDataSource(String) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Returns a handle to a data source with the specified URI.

getDataSource(String, String, String) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Returns a handle to a data source with the specified URI.

getDefaultEncoding() - Method in class org.xquark.serialize.BasicXMLSerializer

getDescription() - Method in interface org.xquark.xml.xdbc.XMLCollection

Retrieves the description of the XML collection.

getDocument(String) - Method in interface org.xquark.xml.xdbc.XMLCollection

Retrieves an XML document in the XML collection.

getDocumentBase() - Method in interface org.xquark.bridge.Mapper

Retrieves the current document base used by this object.

getDocumentCount() - Method in interface org.xquark.xml.xdbc.XMLCollection

Retrieves the XML collection size (number of documents).

getDocumentFiler() - Method in interface org.xquark.xml.xdbc.XMLCollection

Creates a "filer" object that can be used to insert a new XML document into the XML collection.

getDocumentID() - Method in interface org.xquark.mapping.StorageContext

get the document ID set by the user or internally generated.

getDocumentId() - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Gets the identifier to be used by the next document to be stored through this object.

getDocumentOID() - Method in interface org.xquark.mapping.StorageContext

get the numeric ID allocated for the document.

getDocumentSet() - Method in interface org.xquark.xml.xdbc.XMLStatement

Returns the current statement results as an XMLDocumentSet object.

getDriver(String) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Attempts to locate a driver that understands the given URI.

getDrivers() - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Returns an iterator on registered XMLDBC drivers.

getEncoding() - Method in class org.xquark.serialize.XMLSerializer

Accessor to the current character encoding in use.

getErrorHandler() - Method in interface org.xquark.bridge.Mapper

Return the current error handler.

getErrorHandler() - Method in interface org.xquark.xml.xdbc.XMLDocument

SRetrieves the current (SAX2) error handler.

getErrorHandler() - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Return the current error handler.

getErrorHandler() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the current error handler.

getException() - Method in class org.xquark.xml.xdbc.XMLDBCException

To get the exception of this exception/error.

getExtractor() - Method in class org.xquark.extractor.ExtractorConnection

getExtractorConnection() - Method in class org.xquark.extractor.Extractor

Creates a new XML/DBC connection instance for the extractor, avoiding a cast on Extractor.getConnection()to access Extractor specific features.

getFeature(String) - Method in interface org.xquark.xml.xdbc.Configurable

Get the state of a configuration feature.

getFeatureList() - Method in interface org.xquark.xml.xdbc.Configurable

Get the list of supported configuration features

getFragmentsAsDocument(String, String, String) - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the fragments contained in the result set as a single XML document, with a document root element having the specified namespace, local name and qualified name.

getGenerateXMLDeclaration() - Method in class org.xquark.serialize.BasicXMLSerializer

Accessor to the current flag for XML declaration generation.

getGenerateXMLDeclaration() - Method in class org.xquark.serialize.XMLSerializer

Accessor to the current flag for XML declaration generation.

getIdentifier() - Method in interface org.xquark.xml.xdbc.XMLDocument

Returns the document identifier in the XML collection.

getIdentifierList() - Method in interface org.xquark.xml.xdbc.XMLCollection

Returns a list of documents identifiers available in the XML collection.

getIndent() - Method in class org.xquark.serialize.BasicXMLSerializer

getIndent() - Method in class org.xquark.serialize.XMLSerializer

Accessor to the current indenting mode.

getInput() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData.Entry

Gets the input specification as an XPath expression.

getJdbcConnection() - Method in class org.xquark.extractor.ExtractorConnection

getJdbcDataSource() - Method in class org.xquark.extractor.Extractor

Returns the internal JDBC data source.

getLexicalHandler() - Method in interface org.xquark.xml.xdbc.XMLDocument

Retrieves the current (SAX2) lexical handler.

getLexicalHandler() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the current lexical handler.

getLocalName() - Method in interface org.xquark.mapping.StorageContext

Return the local name of the node being stored.

getLogWriter() - Method in class org.xquark.extractor.Extractor

Get the internal JDBC datasource log writer.

getLogWriter() - Method in interface org.xquark.xml.xdbc.XMLDataSource

Retrieves the log writer currently used by the XDataSource object to print messages.

getLogWriter() - Method in class org.xquark.xml.xdbc.XMLDriverManager

Retrieves the default log writer currently used by all data source objects obtained from the manager.

getLoginTimeout() - Method in class org.xquark.extractor.Extractor

Get the internal JDBC datasource login timeout.

getLoginTimeout() - Method in interface org.xquark.xml.xdbc.XMLDataSource

Gets the maximum time in seconds that the object can wait when attempting to log in to a data source

getLoginTimeout() - Method in class org.xquark.xml.xdbc.XMLDriverManager

Gets the maximum time in seconds that all data source objects obtained from the manager can wait when attempting to log in to a data source

getMapper() - Method in class org.xquark.bridge.Mapping

Creates a new Mapper object for storing a set of XML documents in the database

getMapping() - Method in interface org.xquark.bridge.Mapper

Returns the mapping used by this object

getMapping(InputSource) - Method in class org.xquark.bridge.XQBridge

Deprecated. Prefer the string methods because they do not create a problem for resolving relative URIs in mapping file schemaLocation attribute.

getMapping(InputSource, boolean) - Method in class org.xquark.bridge.XQBridge

Deprecated. Prefer the string methods because they do not create a problem for resolving relative URIs in mapping file schemaLocation attribute.

getMapping(String) - Method in class org.xquark.bridge.XQBridge

Creates a mapping object containing the processed version of the specified mapping file.

getMapping(String, boolean) - Method in class org.xquark.bridge.XQBridge

Creates a mapping object containing the processed version of the specified mapping file.

getMessage() - Method in class org.xquark.xml.xdbc.XMLDBCException

Returns the exception message, or the embedded exception message if none is present

getMetaData() - Method in class org.xquark.extractor.ExtractorConnection

Gets the metadata regarding this connection's data source.

getMetaData(boolean) - Method in class org.xquark.extractor.ExtractorConnection

getMetaData() - Method in interface org.xquark.xml.xdbc.XMLConnection

Gets the metadata regarding this connection's data source.

getMetaData(boolean) - Method in interface org.xquark.xml.xdbc.XMLConnection

Gets the metadata regarding this connection's data source.

getMetaData() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

Retrieves the XML document describing the complete metadata of the data source.

getMetaData() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the result set metadata (the XML Schema that models the returned data) as an XMLDocument.

getMetaModules() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

getName() - Method in interface org.xquark.xml.xdbc.XMLCollection

Retrieves the unique name of the XML collection.

getNamespaceURI() - Method in interface org.xquark.mapping.StorageContext

Return the namespace URI of the node being stored.

getNodeData() - Method in interface org.xquark.mapping.StorageContext

Return the character data attached to the current node if any.

getNodeRank() - Method in interface org.xquark.mapping.StorageContext

Return the rank (within its siblings) of the current node being stored.

getNormalizedNodeData() - Method in interface org.xquark.mapping.StorageContext

Return the character data attached to the current node if any, normalized according the XML Schema recommendation.

getOID() - Method in interface org.xquark.mapping.StorageContext

Return the local (to a storage operation) OID (Object IDentifier) of the current node being stored.

getOutput() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData.Entry

Gets the output specification as an XPath expression.

getPSVInfoSetProvider() - Method in interface org.xquark.xml.xdbc.XMLResultSet

getParameterNames() - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

Gets the array of parameter names of the statement

getParameterType(QName) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

Gets the schema type of a particular parameter given it's name

getPathOID() - Method in interface org.xquark.mapping.StorageContext

Return the path OID (Object IDentifier) of the current node being stored.

getPathSet(String) - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

getPosition() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Retrieves the current cursor position in ResultSet.

getPrefixMap() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the result set prefix map (as prefix-namespace pairs).

getProperty(String) - Method in interface org.xquark.xml.xdbc.Configurable

Get the value of a configuration property (only properties set in this configuration).

getProperty(String) - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

Get the property with the specified name

getPropertyList() - Method in interface org.xquark.xml.xdbc.Configurable

Get the list of supported properties

getPropertyList() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

Get the properties that describe this data source.

getQName() - Method in interface org.xquark.mapping.StorageContext

Return the Full Qualified Name of the node being stored.

getRefValue(int, int) - Method in interface org.xquark.mapping.StorageContext

Return the character data stored in a tuple waiting to be stored.

getResultSet() - Method in interface org.xquark.xml.xdbc.XMLStatement

Returns the current statement results as an XMLResultSet object.

getSchema(String) - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

Retrieves the XML document describing the XML schema for the given namespace.

getSchemaNamespaces() - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData

Retrieves the available schema namespaces in the data source.

getSpecificPart(String) - Method in class org.xquark.extractor.ExtractorDriver

getSpecificPart(String) - Method in interface org.xquark.xml.xdbc.XMLDriver

Returns the driver-specific part of the URI

getStatement() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the statement that produced this result set.

getSystemId() - Method in class org.xquark.bridge.Mapping

Returns the system id (the URL) of the mapping file, if known.

getTransactionIsolation() - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

Gets this connection's current transaction isolation level.

getTransactionIsolation() - Method in interface org.xquark.xml.xdbc.XMLConnection

Gets this Connection's current transaction isolation level.

getUOID() - Method in interface org.xquark.mapping.StorageContext

Return the universal OID (Object IDentifier) of the current node being stored.

getURL() - Method in class org.xquark.extractor.Extractor

Gets the XML/DBC URL of the Extractor (XML data source).

getURL() - Method in class org.xquark.extractor.ExtractorConnection

getURL() - Method in interface org.xquark.xml.xdbc.XMLConnection

To get the current URL of this connection.

getUseIgnorableWhitespaces() - Method in class org.xquark.serialize.BasicXMLSerializer

getUseIgnorableWhitespaces() - Method in class org.xquark.serialize.XMLSerializer

Accessor to the current the status of the use of ignorable whitespace by the serializer.

getUserName() - Method in class org.xquark.extractor.Extractor

Gets the user name used to log to the Extractor.

getUserName() - Method in class org.xquark.extractor.ExtractorConnection

getUserName() - Method in interface org.xquark.xml.xdbc.XMLConnection

To get the current user name.

getValue(StorageContext) - Method in interface org.xquark.mapping.Generator

This method is called by the XQuark storage engine when a user-generated column of a relational table is filled.

getValue(StorageContext) - Method in class org.xquark.mapping.KeyGenerator

getXMLConnection() - Method in class org.xquark.bridge.XQBridge

Returns an extractor XML/DBC connection that can be used to execute XQuery statements over the database.

getXMLType() - Method in class org.xquark.mapping.KeyGenerator

getXMLType() - Method in interface org.xquark.mapping.UserGenerator

Return the corresponding XML Schema type using the XML Schema recommendation syntax.

H

hasNext() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Indicates if there is a next Result after the current Result in ResultSet.

hasRootTag() - Method in interface org.xquark.xml.xdbc.XMLResultSet

I

ignorableWhitespace(char[], int, int) - Method in class org.xquark.serialize.BasicXMLSerializer

insertDocument(InputSource) - Method in interface org.xquark.bridge.Mapper

Inserts an XML document in the database using the SAX method.

insertDocument(XMLReader, InputSource) - Method in interface org.xquark.bridge.Mapper

Inserts an XML document in database using the SAX method.

insertDocument(Document) - Method in interface org.xquark.bridge.Mapper

Inserts the XML data contained in the DOM2 document in the database.

insertDocument(String) - Method in interface org.xquark.bridge.Mapper

Inserts the XML data contained in the string in the database.

insertDocument(InputSource) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts an XML document in the filer's collection using the SAX method.

insertDocument(InputSource, String) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts an XML document in the filer's collection using the SAX method.

insertDocument(XMLReader, InputSource) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts an XML document in the filer's collection using the SAX method.

insertDocument(XMLReader, InputSource, String) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts an XML document in the filer's collection using the SAX method.

insertDocument(Document) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts the XML document in the filer's collection.

insertDocument(Document, String) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts the XML document in the filer's collection with the specified identifier.

insertDocument(String) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts the XML document contained in the string in the filer's collection.

insertDocument(String, String) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Inserts the XML document contained in the string in the filer's collection with the specified identifier.

isBeforeFirst() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Indicates whether the cursor is before the first result in this result set.

isClosed() - Method in class org.xquark.extractor.ExtractorConnection

isClosed() - Method in interface org.xquark.xml.xdbc.XMLConnection

To know the connection state (opened or closed).

isDocument() - Method in interface org.xquark.xml.xdbc.XMLResultSet

isReadOnly() - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To know the read/write mode of the current connection.

isReadOnly() - Method in interface org.xquark.xml.xdbc.XMLCollection

Returns true if the XML collection is read-only mode.

isReadOnly() - Method in interface org.xquark.xml.xdbc.XMLConnection

To know the read/write mode of the current connection.

J

JNDI_SCHEME - Static variable in class org.xquark.extractor.Extractor

K

KeyGenerator - class org.xquark.mapping.KeyGenerator.

This generator is a built-in default implementation intended as a device for relational primary and foreign keys generation.

KeyGenerator(CompilationContext) - Constructor for class org.xquark.mapping.KeyGenerator

L

loadModule(String) - Method in class org.xquark.extractor.ExtractorConnection

loadSchema(InputSource) - Method in class org.xquark.bridge.XQBridge

Loads an XML schema in memory.

loadSchema(InputSource) - Method in class org.xquark.extractor.ExtractorConnection

M

Main - class org.xquark.bridge.Main.

This class is the command-line launcher for Bridge.

Main() - Constructor for class org.xquark.bridge.Main

Mapper - interface org.xquark.bridge.Mapper.

Objects implementing this class are used to store XML data into a database according to the parent mapping.

Mapping - class org.xquark.bridge.Mapping.

An object implementing this class represents a processed mapping file.

Mapping(DataSource, InputSource, boolean, ClassLoader, SchemaManager, HashMap) - Constructor for class org.xquark.bridge.Mapping

Constructor.

main(String[]) - Static method in class org.xquark.bridge.Main

The method called from the command line to run the XQBridge as a standalone program.

N

NO_CODE - Static variable in class org.xquark.xml.xdbc.XMLDBCException

Error code for exception that have no associated error code.

nextAsDOM() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Deprecated. Prefer XMLResultSet.nextAsDocument() or XMLResultSet.nextAsDOM(Element) becuse a result may return multiple root nodes.

nextAsDOM(Element) - Method in interface org.xquark.xml.xdbc.XMLResultSet

Attaches the next result nodes as children of the Element node passed as a parameter to and increments by 1 the cursor position.

nextAsDocument() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the next result as a DOM2 document and increments by 1 the cursor position.

nextAsSAX() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the next result as a SAX2 event flow and increments by 1 the cursor position.

nextAsStream(Writer) - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the next result in a provided character stream and increments by 1 the cursor position.

nextAsString() - Method in interface org.xquark.xml.xdbc.XMLResultSet

Returns the next result as an XML string and increments by 1 the cursor position.

nextDocument() - Method in interface org.xquark.xml.xdbc.XMLDocumentSet

Returns the next result as an XML document and increments by 1 the cursor position.

O

org.xquark.bridge - package org.xquark.bridge

org.xquark.extractor - package org.xquark.extractor

org.xquark.mapping - package org.xquark.mapping

org.xquark.serialize - package org.xquark.serialize

org.xquark.xml.xdbc - package org.xquark.xml.xdbc

P

PreparedXMLStatement - interface org.xquark.xml.xdbc.PreparedXMLStatement.

This prepared statement interface is used for executing parameterized XQuery or XPath prepared statements, setting external variables and obtaining the results (update statements are not supported yet).

prepareStatement(String) - Method in class org.xquark.extractor.ExtractorConnection

prepareStatement(String) - Method in interface org.xquark.xml.xdbc.XMLConnection

Creates a prepared statement object for sending parameterized XQuery (query type by default) statements to the data source.

printError(Throwable, boolean) - Static method in class org.xquark.xml.xdbc.XMLDBCException

Print an error message processing embedded expeptions to the standard error output.

printError(Throwable, PrintStream, boolean) - Static method in class org.xquark.xml.xdbc.XMLDBCException

Print an error message processing embedded expeptions.

processingInstruction(String, String) - Method in class org.xquark.serialize.BasicXMLSerializer

R

RCSName - Static variable in interface org.xquark.bridge.Mapper

RCSRevision - Static variable in interface org.xquark.bridge.Mapper

registerDriver(XMLDriver) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Adds the given driver in the driver manager list.

remove() - Method in interface org.xquark.xml.xdbc.XMLDocument

Removes the document from the collection to which it belongs.

removeAllDocuments() - Method in interface org.xquark.xml.xdbc.XMLCollection

Removes all XML documents from the XML collection.

removeDocument(String) - Method in interface org.xquark.xml.xdbc.XMLCollection

Removes the named XML document from the XML collection.

renameCollection(String, String) - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To rename an XML collection by its name.

renameCollection(String, String) - Method in interface org.xquark.xml.xdbc.XMLConnection

Renames an XML collection by its name.

renameDocument(String, String) - Method in interface org.xquark.xml.xdbc.XMLCollection

Renames a document.

reset() - Method in class org.xquark.serialize.BasicXMLSerializer

Reset internal state before reuse.

reset() - Method in class org.xquark.serialize.XMLSerializer

Reset internal state before reuse.

resetMappings(boolean) - Method in class org.xquark.bridge.XQBridge

Empties the mappings cache.

rollback() - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

Drops all changes made since the previous commit/rollback and releases any data source locks currently held by this connection.

rollback() - Method in interface org.xquark.xml.xdbc.XMLConnection

Drops all changes made since the previous commit/rollback and releases any data source locks currently held by this Connection.

S

StorageContext - interface org.xquark.mapping.StorageContext.

Provide access to storage system variables.

setAutoCommit(boolean) - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

Sets this connection's auto-commit mode.

setAutoCommit(boolean) - Method in interface org.xquark.xml.xdbc.XMLConnection

Sets this connection's auto-commit mode.

setAutoFlush(boolean) - Method in interface org.xquark.bridge.Mapper

Turns on or off the automatic buffering mode.

setAutoFlush(boolean) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Turns on or off the automatic buffering mode.

setAutoStreamClose(boolean) - Method in class org.xquark.serialize.BasicXMLSerializer

Enable automatic close of the output user stream on endDocument() event.

setAutoStreamClose(boolean) - Method in class org.xquark.serialize.XMLSerializer

Enable automatic close of the output user stream on endDocument() event.

setBaseURI(String) - Method in class org.xquark.extractor.ExtractorConnection

Sets the base URI for documents.

setBaseURI(String) - Method in interface org.xquark.xml.xdbc.XMLConnection

Sets the base URI for documents.

setBaseURI(String) - Method in interface org.xquark.xml.xdbc.XMLStatement

Sets the base URI for documents.

setBigDecimal(String, String, BigDecimal) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a @link java.math.BigDecimal value.

setBigDecimal(String, BigDecimal) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a @link java.math.BigDecimal value.

setBoolean(String, String, boolean) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a boolean value.

setBoolean(String, boolean) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a boolean value.

setBytes(String, String, byte[]) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a byte array value.

setBytes(String, byte[]) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a byte array value.

setCanonicalOutput(boolean) - Method in class org.xquark.serialize.BasicXMLSerializer

Set the ordering mode for attributes.

setCanonicalOutput(boolean) - Method in class org.xquark.serialize.XMLSerializer

Set the ordering mode for attributes.

setClassLoader(ClassLoader) - Method in class org.xquark.bridge.XQBridge

Set the class loader used for loading drivers, mappings and user generators.

setContentHandler(ContentHandler) - Method in interface org.xquark.xml.xdbc.XMLDocument

Sets a (SAX2) content handler to intercept events produced when retrieving the document content.

setContentHandler(ContentHandler) - Method in interface org.xquark.xml.xdbc.XMLResultSet

Sets a (SAX2) content handler to intercept events produced when retrieving results as SAX.

setDate(String, String, Date) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a @link java.util.Date value.

setDate(String, Date) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a @link java.util.Date value.

setDefaultEncoding(String) - Method in class org.xquark.serialize.BasicXMLSerializer

Set the character encoding.

setDescription(String) - Method in interface org.xquark.xml.xdbc.XMLCollection

Sets the description of the XML collection.

setDocumentBase(String) - Method in interface org.xquark.bridge.Mapper

This method is to be used when the document stored contains an 'xsi:schemaLocation' attribute (or any element or attribute with the XML Schema type 'anyURI') that uses relatives URIs and when the API used to store documents does not use an InputSource with the SystemID set (e.g.

setDocumentId(String) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Sets the identifier of the next document to be stored through this object.

setDouble(String, String, double) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a double value.

setDouble(String, double) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a double value.

setEncoding(String) - Method in class org.xquark.serialize.XMLSerializer

Set the character encoding.

setErrorHandler(XMLErrorHandler) - Method in interface org.xquark.bridge.Mapper

Allows an application to register an error event handler for non-fatal errors.

setErrorHandler(ErrorHandler) - Method in interface org.xquark.xml.xdbc.XMLDocument

Sets a (SAX2) error handler to intercept error events produced when retrieving the document content.

setErrorHandler(XMLErrorHandler) - Method in interface org.xquark.xml.xdbc.XMLDocumentFiler

Allow an application to register an error event handler for non-fatal errors.

setErrorHandler(ErrorHandler) - Method in interface org.xquark.xml.xdbc.XMLResultSet

Sets a (SAX2) error handler to intercept error events produced when retrieving results as SAX.

setExternalVariable(String, String, String) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

Binds the specified external variable to the current query of the statement.

setExternalVariable(String, String) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

Binds the specified external variable to the current query of the statement.

setFeature(String, boolean) - Method in interface org.xquark.xml.xdbc.Configurable

Set the state of a configuration feature.

setFloat(String, String, float) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a float value.

setFloat(String, float) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a float value.

setGenerateEncodingDeclaration(boolean) - Method in class org.xquark.serialize.BasicXMLSerializer

Enable encoding attribute generation in XML declaration on startDocument() event.

setGenerateEncodingDeclaration(boolean) - Method in class org.xquark.serialize.XMLSerializer

Enable encoding attribute generation in XML declaration on startDocument() event.

setGenerateXMLDeclaration(boolean) - Method in class org.xquark.serialize.BasicXMLSerializer

Enable XML declaration generation on startDocument() event.

setGenerateXMLDeclaration(boolean) - Method in class org.xquark.serialize.XMLSerializer

Enable XML declaration generation on startDocument() event.

setIdentifier(String) - Method in interface org.xquark.xml.xdbc.XMLDocument

Changes the document identifier in the XML collection.

setIndent(boolean) - Method in class org.xquark.serialize.BasicXMLSerializer

Set the indenting mode.

setIndent(boolean) - Method in class org.xquark.serialize.XMLSerializer

Set the indenting mode.

setInput(String) - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData.Entry

Sets the input specification

setInputStream(String, String, InputStream, int) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a @link java.io.InputStream value.

setInputStream(String, InputStream, int) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a @link java.io.InputStream value.

setLexicalHandler(LexicalHandler) - Method in interface org.xquark.xml.xdbc.XMLDocument

Sets a (SAX2) lexical handler to intercept events produced when retrieving the document content.

setLexicalHandler(LexicalHandler) - Method in interface org.xquark.xml.xdbc.XMLResultSet

Sets a (SAX2) lexical handler to intercept events produced when retrieving results as SAX.

setLogWriter(PrintWriter) - Method in class org.xquark.extractor.Extractor

Sets the internal JDBC datasource log writer.

setLogWriter(PrintWriter) - Method in interface org.xquark.xml.xdbc.XMLDataSource

Sets the logging/tracing java.io.PrintWriter object that is used by the XDataSource object.

setLogWriter(PrintWriter) - Static method in class org.xquark.xml.xdbc.XMLDriverManager

Sets the default logging/tracing java.io.PrintWriter object that is used by all data source objects obtained from the manager.

setLoginTimeout(int) - Method in class org.xquark.extractor.Extractor

Set the internal JDBC datasource login timeout.

setLoginTimeout(int) - Method in interface org.xquark.xml.xdbc.XMLDataSource

Sets the maximum time in seconds that the object will wait when attempting to log in to a data source.

setLoginTimeout(int) - Method in class org.xquark.xml.xdbc.XMLDriverManager

Sets the maximum time in seconds that all data source objects obtained from the manager will wait when attempting to log in to a data source.

setLong(String, String, long) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a long value.

setLong(String, long) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a long value.

setObject(String, String, Object) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a value inside an object.

setObject(String, Object) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a value inside an object.

setOutput(String) - Method in interface org.xquark.xml.xdbc.XMLDataSourceMetaData.Entry

Sets the output specification

setOutputStream(OutputStream) - Method in class org.xquark.serialize.BasicXMLSerializer

Set the OutputStream where the serializer writes bytes.

setOutputStream(OutputStream) - Method in class org.xquark.serialize.XMLSerializer

Set the OutputStream where the serializer writes bytes.

setProperty(String, Object) - Method in interface org.xquark.xml.xdbc.Configurable

Set the state of a configuration property.

setReadOnly(boolean) - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

To change the read/write mode of the connection.

setReadOnly(boolean) - Method in interface org.xquark.xml.xdbc.XMLCollection

Changes the read-only mode for this XML collection.

setReadOnly(boolean) - Method in interface org.xquark.xml.xdbc.XMLConnection

To change the read/write mode of the connection.

setSequence(String, String, List) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a Sequence value.

setSequence(String, List) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a Sequence value.

setString(String, String, String) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a String value.

setString(String, String) - Method in interface org.xquark.xml.xdbc.PreparedXMLStatement

To set the specified variable with a String value.

setTransactionIsolation(short) - Method in class org.xquark.xml.xdbc.DefaultReadOnlyXMLConnection

Attempts to change the transaction isolation level to the one given.

setTransactionIsolation(short) - Method in interface org.xquark.xml.xdbc.XMLConnection

Attempts to change the transaction isolation level to the one given.

setUseIgnorableWhitespaces(boolean) - Method in class org.xquark.serialize.BasicXMLSerializer

Turn on or off the use of ignorable whitespace for indentation.

setUseIgnorableWhitespaces(boolean) - Method in class org.xquark.serialize.XMLSerializer

turn on or off the use of ignorable whitespace for indentation.

setUseScrollableResultSets(boolean) - Method in class org.xquark.extractor.Extractor

To indicate the Extractor that scrollable JDBC result sets must be used.

setWriter(Writer) - Method in class org.xquark.serialize.BasicXMLSerializer

Set the Writer where the serializer writes characters.

setWriter(Writer) - Method in class org.xquark.serialize.XMLSerializer

Set the Writer where the serializer writes characters.

startCDATA() - Method in class org.xquark.serialize.BasicXMLSerializer

startDocument() - Method in class org.xquark.serialize.BasicXMLSerializer

startElement(String, String, String, Attributes) - Method in class org.xquark.serialize.BasicXMLSerializer

statementClosed(XMLStatement) - Method in class org.xquark.extractor.ExtractorConnection

T

TABLE_NAME - Static variable in class org.xquark.mapping.CompilationContext

This property contains the name of the tab