de.fraunhofer.ipsi.ipsixq.api.impl
Class XQAbstractConnection

java.lang.Object
  extended by de.fraunhofer.ipsi.ipsixq.api.impl.XQAbstractDataFactory
      extended by de.fraunhofer.ipsi.ipsixq.api.impl.XQAbstractConnection
All Implemented Interfaces:
XQConnection, XQDataFactory, XQDynamicContext, XQStaticContext
Direct Known Subclasses:
XQConnectionImpl

public abstract class XQAbstractConnection
extends XQAbstractDataFactory
implements XQConnection, XQStaticContext, XQDynamicContext

Author:
Michael Stark

Constructor Summary
XQAbstractConnection()
           
 
Method Summary
 void bindBase64Binary(javax.xml.namespace.QName varname, java.lang.Byte[] value)
          Binds a base64 binary value to the given external variable.
 void bindBoolean(javax.xml.namespace.QName varname, boolean value)
          Binds a boolean value to the given external variable.
 void bindByte(javax.xml.namespace.QName varname, byte value)
          Binds a byte value to the given external variable.
 void bindContextItem(XQItem contextitem)
          Binds an XQuery item object for context.
 void bindDecimal(javax.xml.namespace.QName varname, java.math.BigDecimal value)
          Binds a big decimal value to the given external variable.
 void bindDouble(javax.xml.namespace.QName varname, double value)
          Binds a double value to the given external variable.
 void bindFloat(javax.xml.namespace.QName varname, float value)
          Binds a float value to the given external variable.
 void bindHexBinary(javax.xml.namespace.QName varname, java.lang.Byte[] value)
          Binds a hexadecimal value to the given external variable.
 void bindInt(javax.xml.namespace.QName varname, int value)
          Binds an integer value to the given external variable.
 void bindItem(javax.xml.namespace.QName varname, XQItem item)
          Binds an item to this variable.
 void bindLexicalValue(javax.xml.namespace.QName varname, java.lang.String value, XQItemType type)
          Binds a lexical value to the given external variable.
 void bindLong(javax.xml.namespace.QName varname, long value)
          Binds a long value to the given external variable.
 void bindNode(javax.xml.namespace.QName varname, org.w3c.dom.Node node)
          Binds an XML node.
 void bindNotation(javax.xml.namespace.QName varname, java.lang.String value)
          Binds a Notation value to the given external variable.
 void bindSequence(javax.xml.namespace.QName varname, XQSequence seq)
          Binds a variable to the sequence of items contained in the input.
 void bindString(javax.xml.namespace.QName varname, java.lang.String value)
          Binds a string value to the given variable.
 void bindTime(javax.xml.namespace.QName varname, java.sql.Time value)
          Binds a time value to the given external variable.
 void bindTimestamp(javax.xml.namespace.QName varname, java.sql.Timestamp value)
          Binds a timestamp value to the given external variable.
 void bindURI(javax.xml.namespace.QName varname, java.net.URI value)
          Binds a URI value to the given external variable.
 void clearWarnings()
          Clears the list of warnings associated with this connection.
 void close()
          Closes the connection.
 void commit()
          Commits the current transaction.
 XQExpression createExpression()
          Creates a new Xquery expression object that can be used to perform execute immediate operations with XQuery expressions.
 java.lang.String getBaseURI()
          Gets the base URI, if set, else the empty string.
 int getDefaultCollation()
          Gets the default collation defined in the static context.
 java.lang.String getDefaultElementTypeNamespace()
          Retrieves the default element/type namespace as a string.
 java.lang.String getDefaultFunctionNamespace()
          Retrieves the default function namespace.
 int getDefaultValidationMode()
          Gets the default validation mode defined in the static context.
 int getDefaultXMLSpacePolicy()
          Gets the default XML space policy defined in the static context.
 int getHoldability()
          Gets the value of the holdability property of this connection.
 java.util.TimeZone getImplicitTimeZone()
          Gets the implicit timezone.
 java.lang.String[] getInScopeNamespacePrefixes()
          Returns the prefixes of all the in scope namespace definitions.
 XQMetaData getMetaData()
          Gets the Metadata for this connection.
 java.lang.String getMetaDataProperty(java.lang.String key)
          Gets the Value of the connection property indicated by the specified key.
 java.lang.String getNamespaceURI(java.lang.String prefix)
          Retrieves the namespace URI associated with the prefix.
 int getQueryLanguageTypeAndVersion()
          Gets the query language type and version.
 int getScrollability()
          Gets the value of the scrollability property of this connection.
 javax.xml.namespace.QName[] getStaticInScopeVariableNames()
          Gets the list of all static scope variables defined in the static context.
 XQSequenceType getStaticInScopeVariableType(javax.xml.namespace.QName varname)
          Gets the type of the static in scope variable.
 java.lang.String[] getSupportedMetaDataPropertyNames()
          Determines the property names supported by this connection.
 int getUpdatability()
          Gets the value of the updatability property of this connection.
 XQWarning getWarnings()
          Gets the first warning in a chained list of warnings associated with this connection.
 boolean isClosed()
          Checks if the connection is closed.
 XQPreparedExpression prepareExpression(java.io.Reader xquery)
          Prepares an expression for execution (input xquery reader).
 XQPreparedExpression prepareExpression(java.lang.String xquery)
          Prepares an expression for execution.
 void rollback()
          Rollsback the current transaction.
 void setCommonHandler(XQCommonHandler hdlr)
          Sets the default common handler to be used for converting items to and from Java objects in the setObject and getObject methods on an item.
 void setHoldability(int holdability)
          Sets the holdability of the result sequence.
 void setImplicitTimeZone(java.util.TimeZone implicitTimeZone)
          Sets the implicit timezone.
 void setQueryLanguageAndVersion(int langType)
          Sets the input query language type and version.
 void setScrollability(int scrollability)
          Sets the scrollability of the result sequence.
 void setUpdatability(int updatability)
          Sets the updatability of the result sequence.
 
Methods inherited from class de.fraunhofer.ipsi.ipsixq.api.impl.XQAbstractDataFactory
createCachedSequence, createCachedSequence, createItem, createItemFromByte, createItemFromDate, createItemFromInt, createItemFromLong, createItemFromString, createItemType, createItemType, createSequenceType, createSequenceType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.xml.xquery.XQDataFactory
createCachedSequence, createCachedSequence, createItem, createItemFromByte, createItemFromDate, createItemFromInt, createItemFromLong, createItemFromString, createItemType, createItemType, createSequenceType, createSequenceType
 

Constructor Detail

XQAbstractConnection

public XQAbstractConnection()
Method Detail

clearWarnings

public void clearWarnings()
                   throws XQException
Description copied from interface: XQConnection
Clears the list of warnings associated with this connection.

Specified by:
clearWarnings in interface XQConnection
Throws:
XQException

close

public void close()
           throws XQException
Description copied from interface: XQConnection
Closes the connection.

Specified by:
close in interface XQConnection
Throws:
XQException

commit

public void commit()
            throws XQException
Description copied from interface: XQConnection
Commits the current transaction.

Specified by:
commit in interface XQConnection
Throws:
XQException

createExpression

public XQExpression createExpression()
                              throws XQException
Description copied from interface: XQConnection
Creates a new Xquery expression object that can be used to perform execute immediate operations with XQuery expressions.

Specified by:
createExpression in interface XQConnection
Throws:
XQException

getHoldability

public int getHoldability()
                   throws XQException
Description copied from interface: XQConnection
Gets the value of the holdability property of this connection.

Specified by:
getHoldability in interface XQConnection
Throws:
XQException

getMetaData

public XQMetaData getMetaData()
                       throws XQException
Description copied from interface: XQConnection
Gets the Metadata for this connection.

Specified by:
getMetaData in interface XQConnection
Throws:
XQException

getMetaDataProperty

public java.lang.String getMetaDataProperty(java.lang.String key)
                                     throws XQException
Description copied from interface: XQConnection
Gets the Value of the connection property indicated by the specified key.

Specified by:
getMetaDataProperty in interface XQConnection
Throws:
XQException

getQueryLanguageTypeAndVersion

public int getQueryLanguageTypeAndVersion()
                                   throws XQException
Description copied from interface: XQConnection
Gets the query language type and version.

Specified by:
getQueryLanguageTypeAndVersion in interface XQConnection
Throws:
XQException

getScrollability

public int getScrollability()
                     throws XQException
Description copied from interface: XQConnection
Gets the value of the scrollability property of this connection.

Specified by:
getScrollability in interface XQConnection
Throws:
XQException

getSupportedMetaDataPropertyNames

public java.lang.String[] getSupportedMetaDataPropertyNames()
                                                     throws XQException
Description copied from interface: XQConnection
Determines the property names supported by this connection.

Specified by:
getSupportedMetaDataPropertyNames in interface XQConnection
Throws:
XQException

getUpdatability

public int getUpdatability()
                    throws XQException
Description copied from interface: XQConnection
Gets the value of the updatability property of this connection.

Specified by:
getUpdatability in interface XQConnection
Throws:
XQException

getWarnings

public XQWarning getWarnings()
                      throws XQException
Description copied from interface: XQConnection
Gets the first warning in a chained list of warnings associated with this connection.

Specified by:
getWarnings in interface XQConnection
Throws:
XQException

isClosed

public boolean isClosed()
                 throws XQException
Description copied from interface: XQConnection
Checks if the connection is closed.

Specified by:
isClosed in interface XQConnection
Throws:
XQException

prepareExpression

public XQPreparedExpression prepareExpression(java.io.Reader xquery)
                                       throws XQException
Description copied from interface: XQConnection
Prepares an expression for execution (input xquery reader).

Specified by:
prepareExpression in interface XQConnection
Throws:
XQException

prepareExpression

public XQPreparedExpression prepareExpression(java.lang.String xquery)
                                       throws XQException
Description copied from interface: XQConnection
Prepares an expression for execution.

Specified by:
prepareExpression in interface XQConnection
Throws:
XQException

rollback

public void rollback()
              throws XQException
Description copied from interface: XQConnection
Rollsback the current transaction.

Specified by:
rollback in interface XQConnection
Throws:
XQException

setCommonHandler

public void setCommonHandler(XQCommonHandler hdlr)
                      throws XQException
Description copied from interface: XQConnection
Sets the default common handler to be used for converting items to and from Java objects in the setObject and getObject methods on an item.

Specified by:
setCommonHandler in interface XQConnection
Throws:
XQException

setHoldability

public void setHoldability(int holdability)
                    throws XQException
Description copied from interface: XQConnection
Sets the holdability of the result sequence.

Specified by:
setHoldability in interface XQConnection
Throws:
XQException

setQueryLanguageAndVersion

public void setQueryLanguageAndVersion(int langType)
                                throws XQException
Description copied from interface: XQConnection
Sets the input query language type and version.

Specified by:
setQueryLanguageAndVersion in interface XQConnection
Throws:
XQException

setScrollability

public void setScrollability(int scrollability)
                      throws XQException
Description copied from interface: XQConnection
Sets the scrollability of the result sequence.

Specified by:
setScrollability in interface XQConnection
Throws:
XQException

setUpdatability

public void setUpdatability(int updatability)
                     throws XQException
Description copied from interface: XQConnection
Sets the updatability of the result sequence.

Specified by:
setUpdatability in interface XQConnection
Throws:
XQException

getBaseURI

public java.lang.String getBaseURI()
Description copied from interface: XQStaticContext
Gets the base URI, if set, else the empty string.

Specified by:
getBaseURI in interface XQStaticContext

getDefaultCollation

public int getDefaultCollation()
Description copied from interface: XQStaticContext
Gets the default collation defined in the static context.

Specified by:
getDefaultCollation in interface XQStaticContext

getDefaultElementTypeNamespace

public java.lang.String getDefaultElementTypeNamespace()
Description copied from interface: XQStaticContext
Retrieves the default element/type namespace as a string.

Specified by:
getDefaultElementTypeNamespace in interface XQStaticContext

getDefaultFunctionNamespace

public java.lang.String getDefaultFunctionNamespace()
Description copied from interface: XQStaticContext
Retrieves the default function namespace.

Specified by:
getDefaultFunctionNamespace in interface XQStaticContext

getDefaultValidationMode

public int getDefaultValidationMode()
Description copied from interface: XQStaticContext
Gets the default validation mode defined in the static context.

Specified by:
getDefaultValidationMode in interface XQStaticContext

getDefaultXMLSpacePolicy

public int getDefaultXMLSpacePolicy()
Description copied from interface: XQStaticContext
Gets the default XML space policy defined in the static context.

Specified by:
getDefaultXMLSpacePolicy in interface XQStaticContext

getInScopeNamespacePrefixes

public java.lang.String[] getInScopeNamespacePrefixes()
Description copied from interface: XQStaticContext
Returns the prefixes of all the in scope namespace definitions.

Specified by:
getInScopeNamespacePrefixes in interface XQStaticContext

getNamespaceURI

public java.lang.String getNamespaceURI(java.lang.String prefix)
Description copied from interface: XQStaticContext
Retrieves the namespace URI associated with the prefix.

Specified by:
getNamespaceURI in interface XQStaticContext

getStaticInScopeVariableNames

public javax.xml.namespace.QName[] getStaticInScopeVariableNames()
Description copied from interface: XQStaticContext
Gets the list of all static scope variables defined in the static context.

Specified by:
getStaticInScopeVariableNames in interface XQStaticContext

getStaticInScopeVariableType

public XQSequenceType getStaticInScopeVariableType(javax.xml.namespace.QName varname)
Description copied from interface: XQStaticContext
Gets the type of the static in scope variable.

Specified by:
getStaticInScopeVariableType in interface XQStaticContext

bindBase64Binary

public void bindBase64Binary(javax.xml.namespace.QName varname,
                             java.lang.Byte[] value)
                      throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a base64 binary value to the given external variable.

Specified by:
bindBase64Binary in interface XQDynamicContext
Throws:
XQTypeException

bindBoolean

public void bindBoolean(javax.xml.namespace.QName varname,
                        boolean value)
                 throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a boolean value to the given external variable.

Specified by:
bindBoolean in interface XQDynamicContext
Throws:
XQTypeException

bindByte

public void bindByte(javax.xml.namespace.QName varname,
                     byte value)
              throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a byte value to the given external variable.

Specified by:
bindByte in interface XQDynamicContext
Throws:
XQTypeException

bindContextItem

public void bindContextItem(XQItem contextitem)
                     throws XQTypeException
Description copied from interface: XQDynamicContext
Binds an XQuery item object for context.

Specified by:
bindContextItem in interface XQDynamicContext
Throws:
XQTypeException

bindDecimal

public void bindDecimal(javax.xml.namespace.QName varname,
                        java.math.BigDecimal value)
                 throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a big decimal value to the given external variable.

Specified by:
bindDecimal in interface XQDynamicContext
Throws:
XQTypeException

bindDouble

public void bindDouble(javax.xml.namespace.QName varname,
                       double value)
                throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a double value to the given external variable.

Specified by:
bindDouble in interface XQDynamicContext
Throws:
XQTypeException

bindFloat

public void bindFloat(javax.xml.namespace.QName varname,
                      float value)
               throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a float value to the given external variable.

Specified by:
bindFloat in interface XQDynamicContext
Throws:
XQTypeException

bindHexBinary

public void bindHexBinary(javax.xml.namespace.QName varname,
                          java.lang.Byte[] value)
                   throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a hexadecimal value to the given external variable.

Specified by:
bindHexBinary in interface XQDynamicContext
Throws:
XQTypeException

bindInt

public void bindInt(javax.xml.namespace.QName varname,
                    int value)
             throws XQTypeException
Description copied from interface: XQDynamicContext
Binds an integer value to the given external variable.

Specified by:
bindInt in interface XQDynamicContext
Throws:
XQTypeException

bindItem

public void bindItem(javax.xml.namespace.QName varname,
                     XQItem item)
              throws XQTypeException
Description copied from interface: XQDynamicContext
Binds an item to this variable.

Specified by:
bindItem in interface XQDynamicContext
Throws:
XQTypeException

bindLexicalValue

public void bindLexicalValue(javax.xml.namespace.QName varname,
                             java.lang.String value,
                             XQItemType type)
                      throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a lexical value to the given external variable.

Specified by:
bindLexicalValue in interface XQDynamicContext
Throws:
XQTypeException

bindLong

public void bindLong(javax.xml.namespace.QName varname,
                     long value)
              throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a long value to the given external variable.

Specified by:
bindLong in interface XQDynamicContext
Throws:
XQTypeException

bindNode

public void bindNode(javax.xml.namespace.QName varname,
                     org.w3c.dom.Node node)
              throws XQTypeException
Description copied from interface: XQDynamicContext
Binds an XML node.

Specified by:
bindNode in interface XQDynamicContext
Throws:
XQTypeException

bindNotation

public void bindNotation(javax.xml.namespace.QName varname,
                         java.lang.String value)
                  throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a Notation value to the given external variable.

Specified by:
bindNotation in interface XQDynamicContext
Throws:
XQTypeException

bindSequence

public void bindSequence(javax.xml.namespace.QName varname,
                         XQSequence seq)
                  throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a variable to the sequence of items contained in the input.

Specified by:
bindSequence in interface XQDynamicContext
Throws:
XQTypeException

bindString

public void bindString(javax.xml.namespace.QName varname,
                       java.lang.String value)
                throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a string value to the given variable.

Specified by:
bindString in interface XQDynamicContext
Throws:
XQTypeException

bindTime

public void bindTime(javax.xml.namespace.QName varname,
                     java.sql.Time value)
              throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a time value to the given external variable.

Specified by:
bindTime in interface XQDynamicContext
Throws:
XQTypeException

bindTimestamp

public void bindTimestamp(javax.xml.namespace.QName varname,
                          java.sql.Timestamp value)
                   throws XQTypeException
Description copied from interface: XQDynamicContext
Binds a timestamp value to the given external variable.

Specified by:
bindTimestamp in interface XQDynamicContext
Throws:
XQTypeException

bindURI

public void bindURI(javax.xml.namespace.QName varname,
                    java.net.URI value)
             throws XQTypeException,
                    XPathDTException
Description copied from interface: XQDynamicContext
Binds a URI value to the given external variable.

Specified by:
bindURI in interface XQDynamicContext
Throws:
XQTypeException
XPathDTException

getImplicitTimeZone

public java.util.TimeZone getImplicitTimeZone()
Description copied from interface: XQDynamicContext
Gets the implicit timezone.

Specified by:
getImplicitTimeZone in interface XQDynamicContext

setImplicitTimeZone

public void setImplicitTimeZone(java.util.TimeZone implicitTimeZone)
Description copied from interface: XQDynamicContext
Sets the implicit timezone.

Specified by:
setImplicitTimeZone in interface XQDynamicContext