Public Member Functions | List of all members
org.zorbaxquery.api.xqj.ZorbaXQMetaData Class Reference

ZorbaXQMetaData class provides information about the data source, in various aspects, such as the product name and version identification, supported features, specific behaviors, user information, product limits and so forth. More...

Inherits XQMetaData.

Public Member Functions

int getMaxExpressionLength () throws XQException
 Gets the maximum number of characters allowed in an expression in this data source. More...
 
int getMaxUserNameLength () throws XQException
 Gets the maximum number of characters allowed in a user name. More...
 
int getProductMajorVersion () throws XQException
 Gets the major version of this product. More...
 
int getProductMinorVersion () throws XQException
 Gets the minor version of this product. More...
 
String getProductName () throws XQException
 Gets the name of this product. More...
 
String getProductVersion () throws XQException
 Gets the full version of this product. More...
 
Set getSupportedXQueryEncodings () throws XQException
 Returns a set of java.lang.String, each of which specifies a character encoding method the XQJ implmentation supports to parse the XQuery query text. More...
 
String getUserName () throws XQException
 Gets the user name associated with this connection. More...
 
int getXQJMajorVersion () throws XQException
 Gets the major version number of XQJ specification supported by this implementation. More...
 
int getXQJMinorVersion () throws XQException
 Gets the minor version number of XQJ specification supported by this implementation. More...
 
String getXQJVersion () throws XQException
 Gets the full version of XQJ specification supported by this implementation. More...
 
boolean isFullAxisFeatureSupported () throws XQException
 Query if XQuery full axis feature is supported in this connection. More...
 
boolean isModuleFeatureSupported () throws XQException
 Query if XQuery module feature is supported in this connection. More...
 
boolean isReadOnly () throws XQException
 Query if the associated conection is restricted for read only use. More...
 
boolean isSchemaImportFeatureSupported () throws XQException
 Query if XQuery schema import feature is supported in this connection. More...
 
boolean isSchemaValidationFeatureSupported () throws XQException
 Query if XQuery schema validation feature is supported in this connection. More...
 
boolean isSerializationFeatureSupported () throws XQException
 Query if XQuery serialization feature is supported in this connection. More...
 
boolean isStaticTypingExtensionsSupported () throws XQException
 Query if XQuery static typing extensions are supported in this connection. More...
 
boolean isStaticTypingFeatureSupported () throws XQException
 Query if XQuery static typing feature is supported in this data source. More...
 
boolean isTransactionSupported () throws XQException
 Query if transaction is supported in this data source. More...
 
boolean isUserDefinedXMLSchemaTypeSupported () throws XQException
 Check if the user defined XML schema type is supported in this connection. More...
 
boolean isXQueryEncodingDeclSupported () throws XQException
 Query if the XQuery encoding declaration is supported by the XQJ implementation. More...
 
boolean isXQueryEncodingSupported (String string) throws XQException
 Query if a character encoding method of the XQuery query text is supported by the XQJ implmentation. More...
 
boolean isXQueryXSupported () throws XQException
 Query if XQueryX format is supported in this data source. More...
 
boolean wasCreatedFromJDBCConnection () throws XQException
 Query if this connection was created from a JDBC connection. More...
 
 ZorbaXQMetaData (XQConnection conn) throws XQException
 

Detailed Description

ZorbaXQMetaData class provides information about the data source, in various aspects, such as the product name and version identification, supported features, specific behaviors, user information, product limits and so forth.

An object from this class is obtained from the connection object by calling the getMetaData() method, for example:

ZorbaXQMetaData metaData = connection.getMetaData();
String productVersion = metaData.getProductVersion();
...

Since the metadata object depends on the connection, all its methods would raise an exception if the connection it is created from is no longer valid.

Definition at line 36 of file ZorbaXQMetaData.java.

Constructor & Destructor Documentation

org.zorbaxquery.api.xqj.ZorbaXQMetaData.ZorbaXQMetaData ( XQConnection  conn) throws XQException
inline

Definition at line 43 of file ZorbaXQMetaData.java.

Member Function Documentation

int org.zorbaxquery.api.xqj.ZorbaXQMetaData.getMaxExpressionLength ( ) throws XQException
inline

Gets the maximum number of characters allowed in an expression in this data source.

Returns
the maximum length of expression as an integer. A zero value means that there is no limit or the limit is unknown.
Exceptions
XQException- if the connection is no longer valid

Definition at line 255 of file ZorbaXQMetaData.java.

int org.zorbaxquery.api.xqj.ZorbaXQMetaData.getMaxUserNameLength ( ) throws XQException
inline

Gets the maximum number of characters allowed in a user name.

Returns
the maximum length of user name as an integer. A zero value means that there is no limit or the limit is unknown.
Exceptions
XQException- if the connection is no longer valid

Definition at line 266 of file ZorbaXQMetaData.java.

int org.zorbaxquery.api.xqj.ZorbaXQMetaData.getProductMajorVersion ( ) throws XQException
inline

Gets the major version of this product.

Returns
a integer indicating the major version of this product
Exceptions
XQException- if the connection is no longer valid

Definition at line 57 of file ZorbaXQMetaData.java.

int org.zorbaxquery.api.xqj.ZorbaXQMetaData.getProductMinorVersion ( ) throws XQException
inline

Gets the minor version of this product.

Returns
a integer indicating the minor version of this product
Exceptions
XQException- if the connection is no longer valid

Definition at line 68 of file ZorbaXQMetaData.java.

String org.zorbaxquery.api.xqj.ZorbaXQMetaData.getProductName ( ) throws XQException
inline

Gets the name of this product.

Returns
a string indicating the product name
Exceptions
XQException- if the connection is no longer valid

Definition at line 79 of file ZorbaXQMetaData.java.

String org.zorbaxquery.api.xqj.ZorbaXQMetaData.getProductVersion ( ) throws XQException
inline

Gets the full version of this product.

Returns
a string indicating the product version
Exceptions
XQException- if the connection is no longer valid

Definition at line 90 of file ZorbaXQMetaData.java.

Set org.zorbaxquery.api.xqj.ZorbaXQMetaData.getSupportedXQueryEncodings ( ) throws XQException
inline

Returns a set of java.lang.String, each of which specifies a character encoding method the XQJ implmentation supports to parse the XQuery query text.

For an example, for an XQJ impmentation which is able to parse the XQuery encoded in "UTF-8" or "UTF-16", it returns a java.util.Set of "UTF-8" and "UTF-16". If the implemetation is not able to generate a list of encodings supported, an empty set is returned. If a non-empty set is returned, the encodings returned in this set are guaranteed to be supported. Note that encodings not in the returned set might also be supported. For example, if the set has two encoding methods: 'UTF-8' and 'UTF-16', they are supported by the implementation. However, this does not mean 'Shift-Js' is not supported. It might be supported.

Returns
a java.util.Set of java.lang.String, each of which is an XQuery query text encoding method
Exceptions
XQException- if the connection is no longer valid

Definition at line 301 of file ZorbaXQMetaData.java.

String org.zorbaxquery.api.xqj.ZorbaXQMetaData.getUserName ( ) throws XQException
inline

Gets the user name associated with this connection.

Returns
the user's name
Exceptions
XQException- if the connection is no longer valid

Definition at line 244 of file ZorbaXQMetaData.java.

int org.zorbaxquery.api.xqj.ZorbaXQMetaData.getXQJMajorVersion ( ) throws XQException
inline

Gets the major version number of XQJ specification supported by this implementation.

Returns
an integer indicating the XQJ major version
Exceptions
XQException- if the connection is no longer valid

Definition at line 101 of file ZorbaXQMetaData.java.

int org.zorbaxquery.api.xqj.ZorbaXQMetaData.getXQJMinorVersion ( ) throws XQException
inline

Gets the minor version number of XQJ specification supported by this implementation.

Returns
an integer indicating the XQJ minor version
Exceptions
XQException- if the connection is no longer valid

Definition at line 112 of file ZorbaXQMetaData.java.

String org.zorbaxquery.api.xqj.ZorbaXQMetaData.getXQJVersion ( ) throws XQException
inline

Gets the full version of XQJ specification supported by this implementation.

Returns
a string indicating the version of XQJ specification
Exceptions
XQException- if the connection is no longer valid

Definition at line 123 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isFullAxisFeatureSupported ( ) throws XQException
inline

Query if XQuery full axis feature is supported in this connection.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 200 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isModuleFeatureSupported ( ) throws XQException
inline

Query if XQuery module feature is supported in this connection.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 211 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isReadOnly ( ) throws XQException
inline

Query if the associated conection is restricted for read only use.

Returns
true if the associated connection is for read-only; false otherwise
Exceptions
XQException- if the connection is no longer valid

Definition at line 134 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isSchemaImportFeatureSupported ( ) throws XQException
inline

Query if XQuery schema import feature is supported in this connection.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 178 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isSchemaValidationFeatureSupported ( ) throws XQException
inline

Query if XQuery schema validation feature is supported in this connection.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 189 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isSerializationFeatureSupported ( ) throws XQException
inline

Query if XQuery serialization feature is supported in this connection.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 222 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isStaticTypingExtensionsSupported ( ) throws XQException
inline

Query if XQuery static typing extensions are supported in this connection.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 233 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isStaticTypingFeatureSupported ( ) throws XQException
inline

Query if XQuery static typing feature is supported in this data source.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 167 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isTransactionSupported ( ) throws XQException
inline

Query if transaction is supported in this data source.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 156 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isUserDefinedXMLSchemaTypeSupported ( ) throws XQException
inline

Check if the user defined XML schema type is supported in this connection.

If this method returns true, then XQItemAccessor.instanceOf(XQItemType) must be able to determine if the type of an XQItemAccessor is an instance of the XQItemType even if either of them is a user defined XML schema type which is defined by the non-predefined XML schema. The pre-defined XML Schema refers to the XML schema whose schema URL is "http://www.w3.org/2001/XMLSchema"

Returns
true if the user defined XML schema type is supported in this connection, false otherwise.
Exceptions
XQException- if the connection is no longer valid

Definition at line 330 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isXQueryEncodingDeclSupported ( ) throws XQException
inline

Query if the XQuery encoding declaration is supported by the XQJ implementation.

Returns
true if the XQuery encoding declaration is supported; false otherwise
Exceptions
XQException- if the connection is no longer valid

Definition at line 288 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isXQueryEncodingSupported ( String  string) throws XQException
inline

Query if a character encoding method of the XQuery query text is supported by the XQJ implmentation.

Parameters
string- String representing the character encoding method of the XQuery query text.
Returns
true if an XQuery query character encoding method is supported, false otherwise
Exceptions
XQException- if (1) the connection is no longer valid, or (2) the specified encoding parameter is null

Definition at line 316 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.isXQueryXSupported ( ) throws XQException
inline

Query if XQueryX format is supported in this data source.

Returns
true if so; otherwise false
Exceptions
XQException- if the connection is no longer valid

Definition at line 145 of file ZorbaXQMetaData.java.

boolean org.zorbaxquery.api.xqj.ZorbaXQMetaData.wasCreatedFromJDBCConnection ( ) throws XQException
inline

Query if this connection was created from a JDBC connection.

Returns
true, if this connection was created from a JDBC connection, false otherwise.
Exceptions
XQException- if the connection is no longer valid

Definition at line 277 of file ZorbaXQMetaData.java.


The documentation for this class was generated from the following file:
blog comments powered by Disqus