|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface provides comprehensive information about the "data source".
Since this interface accesses all sorts of data sources, the term data source is loosely applied.
Information provided depend on driver vendors implementation.
An XMLDBCNotSupportedException will be thrown if a driver does not support a metadata method.
Nested Class Summary | |
static interface |
XMLDataSourceMetaData.Entry
Inner interface of XMLDataSourceMetaData interface. |
Method Summary | |
java.util.Set |
getCapabilities()
To get the set of capabilities of the data source. |
java.util.List |
getCollectionNames()
Retrieves the name of all XML collections in this data source. |
XMLConnection |
getConnection()
To get the XMLConnection object that produced this XMLDataSourceMetaData object. |
XMLDocument |
getMetaData()
Retrieves the XML document describing the complete metadata of the data source. |
XMLDocument |
getPathSet(java.lang.String colName)
Retrieves the XML document describing all existing paths in all documents of the specified XML collection. |
java.lang.Object |
getProperty(java.lang.String propertyId)
Get the property with the specified name |
java.lang.String[] |
getPropertyList()
Get the properties that describe this data source. |
XMLDocument |
getSchema(java.lang.String targetNamespace)
Retrieves the XML document describing the XML schema for the given namespace. |
java.util.List |
getSchemaNamespaces()
Retrieves the available schema namespaces in the data source. |
Method Detail |
public java.lang.String[] getPropertyList()
Valid properties are listed in the table.
The type "int" means the property value string is a valid
integer.
The type "string" means the property value is a string.
The type "boolean" means the property value is "true" or "false".
Property | Definition | Type |
xmldbc.maxConnections | Maximum active connections | int |
xmldbc.maxStatementLength | Maximum length for a statement | int |
xmldbc.maxActiveStatements | Maximum number of active statements | int |
xmldbc.maxResultSetLength | Maximum length of a result set | int |
xmldbc.maxUserNameLength | Maximum length of a user name | int |
xmldbc.dataSourceVersion | Version number of the data source | string |
xmldbc.vendor.name | Name of vendor of underlying source | string |
xmldbc.vendor.product | Product name of vendor of underlying source | string |
xmldbc.vendor.version | Version string of vendor of underlying source | string |
xmldbc.driver.version | Version string of this XMLDBC driver | string |
xmldbc.driver.product | Product name of this XMLDBC driver | string |
xmldbc.xpath | Supports XPath | boolean |
xmldbc.xpath.version | Version of XPath supported | string |
xmldbc.xquery | Supports XQuery | boolean |
xmldbc.xquery.version | Version of XQuery supported | string |
xmldbc.xquery.outerJoin | Supports XQuery outer join | boolean |
xmldbc.twoPhaseCommit | Supports two phase commit | boolean |
xmldbc.xquery.equality | Supports equality operator in WHERE clause | boolean |
xmldbc.xquery.result | Supports construction in RESULT clause | boolean |
xmldbc.xmlCollection | Supports at least part of XMLCollection | boolean |
xmldbc.xmlCollection.id | Supports methods that use XML ID String | boolean |
xmldbc.xmlCollection.iterator | Supports iterator() method | boolean |
xmldbc.xquery.multiCollection | An XQUERY expression may reference multiple XMLCollections | boolean |
For example, a data source that supports all of XQuery without restriction would define true for the xmldb.xquery property. This property implies all other xmldbc.xquery.* properties are supported. A data source that provided no query functionality at all and simply dumped its contents (e.g. an XML file), would not provide any properties at all. A data source may return other properties not listed. For developers, note that no set of capabilities can completely describe all data sources, so a particular data source may throw XMLDBCNotSupportedException in rare circumstances.
public java.lang.Object getProperty(java.lang.String propertyId) throws XMLDBCNotRecognizedException
XMLDBCNotRecognizedException
- if the property is not knownpublic XMLConnection getConnection() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public java.util.List getCollectionNames() throws XMLDBCException, XMLDBCNotSupportedException
XMLDBCException
- if a data source access error occurs.
XMLDBCNotSupportedException
- if the data source does not support this operation (typically, when the data source is read-only)public java.util.List getSchemaNamespaces() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public XMLDocument getPathSet(java.lang.String colName) throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public XMLDocument getSchema(java.lang.String targetNamespace) throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public XMLDocument getMetaData() throws XMLDBCException
XMLDBCException
- if a data source access error occurs.public java.util.Set getCapabilities()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |