<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Fri Dec 09 20:48:46 GMT 2011 -->
<TITLE>
XQMetaData
</TITLE>
<META NAME="date" CONTENT="2011-12-09">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XQMetaData";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../javax/xml/xquery/XQItemType.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/xquery/XQPreparedExpression.html" title="interface in javax.xml.xquery"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/xquery/XQMetaData.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQMetaData.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
javax.xml.xquery</FONT>
<BR>
Interface XQMetaData</H2>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../net/sf/saxon/xqj/SaxonXQMetaData.html" title="class in net.sf.saxon.xqj">SaxonXQMetaData</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>XQMetaData</B></DL>
</PRE>
<P>
<code>XQMetaData</code> interface 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.
<br>
<br>
An object implementing this interface is obtained from the connection object
by calling the <code>getMetaData()</code> method, for example:
<br>
<pre>
XQMetaData metaData = connection.getMetaData();
String productVersion = metaData.getProductVersion();
...
</pre>
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.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../javax/xml/xquery/XQConnection.html" title="interface in javax.xml.xquery"><CODE>XQConnection</CODE></A></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getMaxExpressionLength()">getMaxExpressionLength</A></B>()</CODE>
<BR>
Gets the maximum number of characters allowed in an expression in this
data source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getMaxUserNameLength()">getMaxUserNameLength</A></B>()</CODE>
<BR>
Gets the maximum number of characters allowed in a user name.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getProductMajorVersion()">getProductMajorVersion</A></B>()</CODE>
<BR>
Gets the major version of this product.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getProductMinorVersion()">getProductMinorVersion</A></B>()</CODE>
<BR>
Gets the minor version of this product.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getProductName()">getProductName</A></B>()</CODE>
<BR>
Gets the name of this product.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getProductVersion()">getProductVersion</A></B>()</CODE>
<BR>
Gets the full version of this product.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getSupportedXQueryEncodings()">getSupportedXQueryEncodings</A></B>()</CODE>
<BR>
Returns a set of <code>java.lang.String</code>, each of which
specifies a character encoding method the XQJ implmentation supports to
parse the XQuery query text.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getUserName()">getUserName</A></B>()</CODE>
<BR>
Gets the user name associated with this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getXQJMajorVersion()">getXQJMajorVersion</A></B>()</CODE>
<BR>
Gets the major version number of XQJ specification supported by
this implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getXQJMinorVersion()">getXQJMinorVersion</A></B>()</CODE>
<BR>
Gets the minor version number of XQJ specification supported by
this implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#getXQJVersion()">getXQJVersion</A></B>()</CODE>
<BR>
Gets the full version of XQJ specification supported by this implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isFullAxisFeatureSupported()">isFullAxisFeatureSupported</A></B>()</CODE>
<BR>
Query if XQuery full axis feature is supported in this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isModuleFeatureSupported()">isModuleFeatureSupported</A></B>()</CODE>
<BR>
Query if XQuery module feature is supported in this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isReadOnly()">isReadOnly</A></B>()</CODE>
<BR>
Query if the associated conection is restricted for read only use.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isSchemaImportFeatureSupported()">isSchemaImportFeatureSupported</A></B>()</CODE>
<BR>
Query if XQuery schema import feature is supported in this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isSchemaValidationFeatureSupported()">isSchemaValidationFeatureSupported</A></B>()</CODE>
<BR>
Query if XQuery schema validation feature is supported in this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isSerializationFeatureSupported()">isSerializationFeatureSupported</A></B>()</CODE>
<BR>
Query if XQuery serialization feature is supported in this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isStaticTypingExtensionsSupported()">isStaticTypingExtensionsSupported</A></B>()</CODE>
<BR>
Query if XQuery static typing extensions are supported in
this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isStaticTypingFeatureSupported()">isStaticTypingFeatureSupported</A></B>()</CODE>
<BR>
Query if XQuery static typing feature is supported in this data source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isTransactionSupported()">isTransactionSupported</A></B>()</CODE>
<BR>
Query if transaction is supported in this data source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isUserDefinedXMLSchemaTypeSupported()">isUserDefinedXMLSchemaTypeSupported</A></B>()</CODE>
<BR>
Check if the user defined XML schema type is supported in this connection.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isXQueryEncodingDeclSupported()">isXQueryEncodingDeclSupported</A></B>()</CODE>
<BR>
Query if the XQuery encoding declaration is supported by the XQJ implementation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isXQueryEncodingSupported(java.lang.String)">isXQueryEncodingSupported</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> encoding)</CODE>
<BR>
Query if a character encoding method of the XQuery query text
is supported by the XQJ implmentation.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#isXQueryXSupported()">isXQueryXSupported</A></B>()</CODE>
<BR>
Query if XQueryX format is supported in this data source.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../javax/xml/xquery/XQMetaData.html#wasCreatedFromJDBCConnection()">wasCreatedFromJDBCConnection</A></B>()</CODE>
<BR>
Query if this connection was created from a JDBC connection.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="getProductMajorVersion()"><!-- --></A><H3>
getProductMajorVersion</H3>
<PRE>
int <B>getProductMajorVersion</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the major version of this product.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a integer indicating the major version of this product
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getProductMinorVersion()"><!-- --></A><H3>
getProductMinorVersion</H3>
<PRE>
int <B>getProductMinorVersion</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the minor version of this product.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a integer indicating the minor version of this product
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getProductName()"><!-- --></A><H3>
getProductName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getProductName</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the name of this product.
The value of string returned by this method is implementation-defined.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a string indicating the product name
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getProductVersion()"><!-- --></A><H3>
getProductVersion</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getProductVersion</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the full version of this product.
The format and value of the string returned by this method is
implementation-defined.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a string indicating the product version
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getXQJMajorVersion()"><!-- --></A><H3>
getXQJMajorVersion</H3>
<PRE>
int <B>getXQJMajorVersion</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the major version number of XQJ specification supported by
this implementation.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an integer indicating the XQJ major version
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getXQJMinorVersion()"><!-- --></A><H3>
getXQJMinorVersion</H3>
<PRE>
int <B>getXQJMinorVersion</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the minor version number of XQJ specification supported by
this implementation.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>an integer indicating the XQJ minor version
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getXQJVersion()"><!-- --></A><H3>
getXQJVersion</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getXQJVersion</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the full version of XQJ specification supported by this implementation.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a string indicating the version of XQJ specification
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isReadOnly()"><!-- --></A><H3>
isReadOnly</H3>
<PRE>
boolean <B>isReadOnly</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if the associated conection is restricted for read only use.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if the associated connection is
for read-only; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isXQueryXSupported()"><!-- --></A><H3>
isXQueryXSupported</H3>
<PRE>
boolean <B>isXQueryXSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQueryX format is supported in this data source.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isTransactionSupported()"><!-- --></A><H3>
isTransactionSupported</H3>
<PRE>
boolean <B>isTransactionSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if transaction is supported in this data source.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isStaticTypingFeatureSupported()"><!-- --></A><H3>
isStaticTypingFeatureSupported</H3>
<PRE>
boolean <B>isStaticTypingFeatureSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQuery static typing feature is supported in this data source.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isSchemaImportFeatureSupported()"><!-- --></A><H3>
isSchemaImportFeatureSupported</H3>
<PRE>
boolean <B>isSchemaImportFeatureSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQuery schema import feature is supported in this connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isSchemaValidationFeatureSupported()"><!-- --></A><H3>
isSchemaValidationFeatureSupported</H3>
<PRE>
boolean <B>isSchemaValidationFeatureSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQuery schema validation feature is supported in this connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isFullAxisFeatureSupported()"><!-- --></A><H3>
isFullAxisFeatureSupported</H3>
<PRE>
boolean <B>isFullAxisFeatureSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQuery full axis feature is supported in this connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isModuleFeatureSupported()"><!-- --></A><H3>
isModuleFeatureSupported</H3>
<PRE>
boolean <B>isModuleFeatureSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQuery module feature is supported in this connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isSerializationFeatureSupported()"><!-- --></A><H3>
isSerializationFeatureSupported</H3>
<PRE>
boolean <B>isSerializationFeatureSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQuery serialization feature is supported in this connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isStaticTypingExtensionsSupported()"><!-- --></A><H3>
isStaticTypingExtensionsSupported</H3>
<PRE>
boolean <B>isStaticTypingExtensionsSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if XQuery static typing extensions are supported in
this connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if so; otherwise <code>false</code>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getUserName()"><!-- --></A><H3>
getUserName</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getUserName</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the user name associated with this connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the user's name
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getMaxExpressionLength()"><!-- --></A><H3>
getMaxExpressionLength</H3>
<PRE>
int <B>getMaxExpressionLength</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the maximum number of characters allowed in an expression in this
data source.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the maximum length of expression as an integer.
A zero value means that there is no limit or the
limit is unknown
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getMaxUserNameLength()"><!-- --></A><H3>
getMaxUserNameLength</H3>
<PRE>
int <B>getMaxUserNameLength</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Gets the maximum number of characters allowed in a user name.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the maximum length of user name as an integer.
A zero value means that there is no limit or the
limit is unknown
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="wasCreatedFromJDBCConnection()"><!-- --></A><H3>
wasCreatedFromJDBCConnection</H3>
<PRE>
boolean <B>wasCreatedFromJDBCConnection</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if this connection was created from a JDBC connection.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code>, if this connection was created
from a JDBC connection, <code>false</code> otherwise.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isXQueryEncodingDeclSupported()"><!-- --></A><H3>
isXQueryEncodingDeclSupported</H3>
<PRE>
boolean <B>isXQueryEncodingDeclSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if the XQuery encoding declaration is supported by the XQJ implementation.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if the XQuery encoding declaration
is supported; <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="getSupportedXQueryEncodings()"><!-- --></A><H3>
getSupportedXQueryEncodings</H3>
<PRE>
<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</A> <B>getSupportedXQueryEncodings</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Returns a set of <code>java.lang.String</code>, each of which
specifies a character encoding method the XQJ implmentation supports to
parse the XQuery query text. <br>
For an example, for an XQJ impmentation which is able to parse the
XQuery encoded in "UTF-8" or "UTF-16", it returns a
<code>java.util.Set</code> 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.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>a <code>java.util.Set</code> of
<code>java.lang.String</code>, each of which
is an XQuery query text encoding method
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<HR>
<A NAME="isXQueryEncodingSupported(java.lang.String)"><!-- --></A><H3>
isXQueryEncodingSupported</H3>
<PRE>
boolean <B>isXQueryEncodingSupported</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> encoding)
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Query if a character encoding method of the XQuery query text
is supported by the XQJ implmentation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>encoding</CODE> - <code>String</code> representing the character
encoding method of the XQuery query text.
<DT><B>Returns:</B><DD><code>true</code> if an XQuery query character encoding
method is supported, <code>false</code> otherwise
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if (1) the connection is no longer valid,
or (2) the specified <code>encoding</code>
parameter is <code>null</code></DL>
</DD>
</DL>
<HR>
<A NAME="isUserDefinedXMLSchemaTypeSupported()"><!-- --></A><H3>
isUserDefinedXMLSchemaTypeSupported</H3>
<PRE>
boolean <B>isUserDefinedXMLSchemaTypeSupported</B>()
throws <A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></PRE>
<DL>
<DD>Check if the user defined XML schema type is supported in this connection.
If this method returns <code>true</code>, then
<code>XQItemAccessor.instanceOf(XQItemType)</code> must
be able to determine if the type of an <code>XQItemAccessor</code> is an
instance of the <code>XQItemType</code> 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
<code>"http://www.w3.org/2001/XMLSchema"</code>
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if the user defined XML schema
type is supported in this connection, <code>false</code>
otherwise.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../javax/xml/xquery/XQException.html" title="class in javax.xml.xquery">XQException</A></CODE> - if the connection is no longer valid</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../javax/xml/xquery/XQItemType.html" title="interface in javax.xml.xquery"><B>PREV CLASS</B></A>
<A HREF="../../../javax/xml/xquery/XQPreparedExpression.html" title="interface in javax.xml.xquery"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?javax/xml/xquery/XQMetaData.html" target="_top"><B>FRAMES</B></A>
<A HREF="XQMetaData.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright (c) 2004-2011 Saxonica Limited. All rights reserved.
</BODY>
</HTML>
