com.softwareag.xqj.extension
Interface TXQConnection

All Superinterfaces:
com.softwareag.tamino.xqj.TXQConnection, javax.xml.xquery.XQConnection, javax.xml.xquery.XQDataFactory

public interface TXQConnection
extends com.softwareag.tamino.xqj.TXQConnection

Tamino specific extensions for connections.


Method Summary
 javax.xml.xquery.XQItem createItemFromString(java.lang.String paramString, javax.xml.xquery.XQItemType paramXQItemType)
          Creates a new XQItem based on the input string
 javax.xml.xquery.XQItemType createItemType(int itemtype, javax.xml.namespace.QName nodename, javax.xml.namespace.QName typename, boolean nillable)
          Creates a particular itemkind with a specific basetype based on itemtype and typename respectively
 javax.xml.xquery.XQSequence createSequence(java.util.Iterator iterator)
          Creates a new sequence based on the iterator which is a collection of XQItems
 javax.xml.xquery.XQSequence createSequence(javax.xml.xquery.XQSequence xqsequence)
          Creates a new sequence with the input sequence
 java.lang.String getProperty(java.lang.String propertyName)
          Returns the current value of the named property, or null if not set.
 java.lang.String getServerVersion()
          Gets the server version
 javax.xml.xquery.XQStaticContext getStaticContext()
          Returns the static context associated with the connection
 java.lang.Object getTConnection()
          Gets the underlying TConnection (TAJ connection) object.
 boolean isAlive()
          Returns TRUE if the underlying connection is alive, otherwise FALSE.
 void setProperty(java.lang.String propertyName, java.lang.String propertyValue)
          If a property with the same name is already set, then this method overwrites the old value for that property with the new value.
 
Methods inherited from interface javax.xml.xquery.XQConnection
close, commit, createExpression, createExpression, getAutoCommit, getMetaData, isClosed, prepareExpression, prepareExpression, prepareExpression, prepareExpression, prepareExpression, prepareExpression, rollback, setAutoCommit, setStaticContext
 
Methods inherited from interface javax.xml.xquery.XQDataFactory
createAtomicType, createAtomicType, createAttributeType, createAttributeType, createCommentType, createDocumentElementType, createDocumentSchemaElementType, createDocumentType, createElementType, createElementType, createItem, createItemFromAtomicValue, createItemFromBoolean, createItemFromByte, createItemFromDocument, createItemFromDocument, createItemFromDocument, createItemFromDocument, createItemFromDocument, createItemFromDouble, createItemFromFloat, createItemFromInt, createItemFromLong, createItemFromNode, createItemFromObject, createItemFromShort, createItemType, createNodeType, createProcessingInstructionType, createSchemaAttributeType, createSchemaElementType, createSequenceType, createTextType
 

Method Detail

getProperty

java.lang.String getProperty(java.lang.String propertyName)
                             throws javax.xml.xquery.XQException
Returns the current value of the named property, or null if not set.

Parameters:
propertyName - - The name of the property to set.
Returns:
propertyValue - The value of the named property.
Throws:
javax.xml.xquery.XQException - - If the implementation does not support the given property or if it determines that the value given given for this property is invalid, then an exception is raised.

setProperty

void setProperty(java.lang.String propertyName,
                 java.lang.String propertyValue)
                 throws javax.xml.xquery.XQException
If a property with the same name is already set, then this method overwrites the old value for that property with the new value.

Parameters:
propertyName - - The name of the property to set.
propertyValue - - The value of the named property.
Throws:
javax.xml.xquery.XQException - - If the implementation does not support the given property or if it can determine that the value given for this property is invalid, then an exception is raised.

getServerVersion

java.lang.String getServerVersion()
                                  throws javax.xml.xquery.XQException
Gets the server version

Returns:
server version as String
Throws:
javax.xml.xquery.XQException

getTConnection

java.lang.Object getTConnection()
Gets the underlying TConnection (TAJ connection) object.

Returns:
TConnection (may be null if not applicable for implementation)

createItemType

javax.xml.xquery.XQItemType createItemType(int itemtype,
                                           javax.xml.namespace.QName nodename,
                                           javax.xml.namespace.QName typename,
                                           boolean nillable)
                                           throws javax.xml.xquery.XQException
Creates a particular itemkind with a specific basetype based on itemtype and typename respectively

Parameters:
itemtype -
nodename -
typename -
nillable -
Returns:
XQItemType
Throws:
javax.xml.xquery.XQException

isAlive

boolean isAlive()
Returns TRUE if the underlying connection is alive, otherwise FALSE.

Returns:
boolean indicating if connection is alive or not

createSequence

javax.xml.xquery.XQSequence createSequence(javax.xml.xquery.XQSequence xqsequence)
                                           throws javax.xml.xquery.XQException
Creates a new sequence with the input sequence

Specified by:
createSequence in interface javax.xml.xquery.XQDataFactory
Parameters:
xqsequence -
Returns:
XQSequence
Throws:
javax.xml.xquery.XQException

createSequence

javax.xml.xquery.XQSequence createSequence(java.util.Iterator iterator)
                                           throws javax.xml.xquery.XQException
Creates a new sequence based on the iterator which is a collection of XQItems

Specified by:
createSequence in interface javax.xml.xquery.XQDataFactory
Parameters:
iterator -
Returns:
XQSequence
Throws:
javax.xml.xquery.XQException

getStaticContext

javax.xml.xquery.XQStaticContext getStaticContext()
                                                  throws javax.xml.xquery.XQException
Returns the static context associated with the connection

Specified by:
getStaticContext in interface javax.xml.xquery.XQConnection
Returns:
XQStaticContext
Throws:
javax.xml.xquery.XQException

createItemFromString

javax.xml.xquery.XQItem createItemFromString(java.lang.String paramString,
                                             javax.xml.xquery.XQItemType paramXQItemType)
                                             throws javax.xml.xquery.XQException
Creates a new XQItem based on the input string

Specified by:
createItemFromString in interface javax.xml.xquery.XQDataFactory
Parameters:
paramString - - The string value to be converted as XQItem
paramXQItemType - - The XQItemType to which the string value needs to be converted to
Returns:
XQItem
Throws:
javax.xml.xquery.XQException