com.softwareag.tamino.db.api.accessor
Class TXQuery

java.lang.Object
  extended by com.softwareag.tamino.db.api.accessor.TXQuery
All Implemented Interfaces:
TXQDynamicContext, java.io.Serializable
Direct Known Subclasses:
TPreparedXQuery

public class TXQuery
extends java.lang.Object
implements TXQDynamicContext, java.io.Serializable

TXQuery represents a Tamino xquery expression. It wraps a Tamino xquery expression.

Version:
$Revision: 1.19 $
Author:
Stefan Liebig
See Also:
Serialized Form

Field Summary
protected  java.util.HashMap<java.lang.String,java.lang.String> extVarialbles
           
 
Constructor Summary
TXQuery(java.lang.String expression)
          Initializes the query with the given XQuery expression.
 
Method Summary
 void bindBase64Binary(javax.xml.namespace.QName varname, byte[] value)
          Binds external variable of type xs:base64Binary to prepared XQuery.
 void bindBoolean(javax.xml.namespace.QName varname, boolean value)
          Binds external variable of type xs:boolean to prepared XQuery.
 void bindByte(javax.xml.namespace.QName varname, byte value)
          Binds external variable of type xs:byte to prepared XQuery.
 void bindDate(javax.xml.namespace.QName varname, java.util.Calendar value, java.lang.String format)
          Binds external variable of type xs:date to prepared XQuery.
 void bindDateTime(javax.xml.namespace.QName varname, java.util.Calendar value, java.lang.String format)
          Binds external variable of type xs:dateTime to prepared XQuery.
 void bindDecimal(javax.xml.namespace.QName varname, java.math.BigDecimal value)
          Binds external variable of type xs:decimal to prepared XQuery.
 void bindDouble(javax.xml.namespace.QName varname, double value)
          Binds external variable of type xs:double to prepared XQuery.
 void bindDuration(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:duration to prepared XQuery.
 void bindEntity(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:ENTITY to prepared XQuery.
 void bindFloat(javax.xml.namespace.QName varname, float value)
          Binds external variable of type xs:float to prepared XQuery.
 void bindGDay(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:gDay to prepared XQuery.
 void bindGMonth(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:gMonth to prepared XQuery.
 void bindGMonthDay(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:gMonthDay to prepared XQuery.
 void bindGYear(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:gYear to prepared XQuery.
 void bindGYearMonth(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:gYearMonth to prepared XQuery.
 void bindHexBinary(javax.xml.namespace.QName varname, byte[] value)
          Binds external variable of type xs:hexBinary to prepared XQuery.
 void bindID(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:ID to prepared XQuery.
 void bindIDRef(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:IDREF to prepared XQuery.
 void bindInt(javax.xml.namespace.QName varname, int value)
          Binds external variable of type xs:int to prepared XQuery.
 void bindInteger(javax.xml.namespace.QName varname, java.math.BigInteger value)
          Binds external variable of type xs:integer to prepared XQuery.
 void bindLanguage(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:language to prepared XQuery.
 void bindLong(javax.xml.namespace.QName varname, long value)
          Binds external variable of type xs:long to prepared XQuery.
 void bindName(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:Name to prepared XQuery.
 void bindNCName(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:NCName to prepared XQuery.
 void bindNegativeInteger(javax.xml.namespace.QName varname, java.math.BigInteger value)
          Binds external variable of type xs:negativeInteger to prepared XQuery.
 void bindNMToken(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:NMTOKEN to prepared XQuery.
 void bindNonNegativeInteger(javax.xml.namespace.QName varname, java.math.BigInteger value)
          Binds external variable of type xs:nonNegativeInteger to prepared XQuery.
 void bindNonPositiveInteger(javax.xml.namespace.QName varname, java.math.BigInteger value)
          Binds external variable of type xs:nonPositiveInteger to prepared XQuery.
 void bindNormalizedString(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:normalizedString to prepared XQuery.
 void bindNotation(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:NOTATION to XQuery.
 void bindPositiveInteger(javax.xml.namespace.QName varname, java.math.BigInteger value)
          Binds external variable of type xs:positiveInteger to prepared XQuery.
 void bindQName(javax.xml.namespace.QName varname, javax.xml.namespace.QName value)
          Binding variable of type QName is possible only if QName is outside of any namespace.
 void bindSequence(javax.xml.namespace.QName varname, TXQTypes[] type, java.lang.String[] sequence)
          Binds external variable of type Sequence to prepared XQuery.
 void bindSequence(javax.xml.namespace.QName varname, TXQTypes type, java.lang.String[] sequence)
          Binds external variable of type Sequence to prepared XQuery.
 void bindShort(javax.xml.namespace.QName varname, short value)
          Binds external variable of type xs:short to prepared XQuery.
 void bindString(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:string to prepared XQuery.
 void bindTime(javax.xml.namespace.QName varname, java.util.Calendar value, java.lang.String format)
          Binds external variable of type xs:time to prepared XQuery.
 void bindToken(javax.xml.namespace.QName varname, java.lang.String value)
          Binds external variable of type xs:token to prepared XQuery.
 void bindUnsignedByte(javax.xml.namespace.QName varname, short value)
          Binds external variable of type xs:unsignedByte to prepared XQuery.
 void bindUnsignedInt(javax.xml.namespace.QName varname, long value)
          Binds external variable of type xs:unsignedInt to prepared XQuery.
 void bindUnsignedLong(javax.xml.namespace.QName varname, java.math.BigInteger value)
          Binds external variable of type xs:unsignedLong to prepared XQuery.
 void bindUnsignedShort(javax.xml.namespace.QName varname, int value)
          Binds external variable of type xs:unsignedShort to prepared XQuery.
 void bindURI(javax.xml.namespace.QName varname, java.net.URI value)
          Binds external variable of type xs:anyURI to prepared XQuery.
 boolean equals(java.lang.Object obj)
          Indicates whether some other object is "equal to" this one.
 java.lang.String getExpression()
          Gets the xquery expression.
 TMediaType getMediaType()
          Gets the media-type parameter of serialization spec for this xquery.
 TOutputMethod getOutputMethod()
          Gets the output method parameter of serialization spec for this xquery.
 TQuerySearchMode getQuerySearchMode()
          Gets the _querysearchmode parameter for this query.
 TSensitive getSensitive()
          Gets the current sensitive parameter for this xquery.
 int hashCode()
          Returns a hash code value for the object.
static TXQuery newInstance(java.lang.String expression)
          Factory method for the instantiation of a TXQuery instance.
protected  void setExpression(java.lang.String expression)
          Sets the concrete xquery expression.
 void setMediaType(TMediaType mediaType)
          Sets the media-type parameter of serialization spec for this xquery.
 void setOutputMethod(TOutputMethod outputMethod)
          Sets the output method parameter of serialization spec for this xquery.
 void setQuerySearchMode(TQuerySearchMode querySearchMode)
          Sets the _querysearchmode parameter for this query.
 void setSensitive(TSensitive sensitive)
          Sets the sensitive parameter for this xquery.
 java.lang.String toString()
          Returns the String representation of this TQuery instance.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

extVarialbles

protected java.util.HashMap<java.lang.String,java.lang.String> extVarialbles
Constructor Detail

TXQuery

public TXQuery(java.lang.String expression)
Initializes the query with the given XQuery expression.

Parameters:
expression - is the xquery expression.
Method Detail

newInstance

public static TXQuery newInstance(java.lang.String expression)
Factory method for the instantiation of a TXQuery instance.

Parameters:
expression - is the XQuery expression.
Returns:
the TXQuery instance.

setExpression

protected void setExpression(java.lang.String expression)
Sets the concrete xquery expression.

Parameters:
expression - is the Tamino query expression.

getExpression

public java.lang.String getExpression()
Gets the xquery expression.

Returns:
the Tamino xquery expression.

setSensitive

public void setSensitive(TSensitive sensitive)
Sets the sensitive parameter for this xquery. If you specify TSensitive.NO, an insensitive cursor is opened. This means that the XQuery is calculated on a fixed input when the cursor is opened, and thus the result sequence remains unchanged as long as the cursor is active. If you specify TSensitive.VAGUE, a vague cursor is opened. The XQuery is calculated on an input that takes modification operations of parallel transactions into account. Thus, the result sequence can vary during the lifetime of the cursor if objects that match the original query criteria are inserted, updated or deleted in the meantime. A transaction that has an open vague cursor cannot perform document modifications (update, insert, delete). A transaction that has an open insensitive cursor can do XQuery updates.

Please refer to the description of the X-Machine Commands in the Tamino Server documentation for details on the usage of this parameter.

The default is TSensitive.NO

Parameters:
sensitive - parameter for this xquery.

getSensitive

public TSensitive getSensitive()
Gets the current sensitive parameter for this xquery.

Returns:
The sensitive parameter for this xquery.

setOutputMethod

public void setOutputMethod(TOutputMethod outputMethod)
Sets the output method parameter of serialization spec for this xquery.

Parameters:
output - method parameter of serialization spec.

getOutputMethod

public TOutputMethod getOutputMethod()
Gets the output method parameter of serialization spec for this xquery.

Returns:
The output method parameter of serialization spec.

setMediaType

public void setMediaType(TMediaType mediaType)
Sets the media-type parameter of serialization spec for this xquery.

Parameters:
media-type - parameter of serialization spec.

getMediaType

public TMediaType getMediaType()
Gets the media-type parameter of serialization spec for this xquery.

Returns:
The media-type parameter of serialization spec.

bindBoolean

public void bindBoolean(javax.xml.namespace.QName varname,
                        boolean value)
                 throws TXQTypeException
Binds external variable of type xs:boolean to prepared XQuery.

Specified by:
bindBoolean in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a boolean value of external variable.
Throws:
TXQTypeException

bindByte

public void bindByte(javax.xml.namespace.QName varname,
                     byte value)
              throws TXQTypeException
Binds external variable of type xs:byte to prepared XQuery.

Specified by:
bindByte in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a byte value of external variable.
Throws:
TXQTypeException

bindShort

public void bindShort(javax.xml.namespace.QName varname,
                      short value)
               throws TXQTypeException
Binds external variable of type xs:short to prepared XQuery.

Specified by:
bindShort in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a short value of external variable.
Throws:
TXQTypeException

bindInt

public void bindInt(javax.xml.namespace.QName varname,
                    int value)
             throws TXQTypeException
Binds external variable of type xs:int to prepared XQuery.

Specified by:
bindInt in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a int value of external variable.
Throws:
TXQTypeException

bindLong

public void bindLong(javax.xml.namespace.QName varname,
                     long value)
              throws TXQTypeException
Binds external variable of type xs:long to prepared XQuery.

Specified by:
bindLong in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a long value of external variable.
Throws:
TXQTypeException

bindFloat

public void bindFloat(javax.xml.namespace.QName varname,
                      float value)
               throws TXQTypeException
Binds external variable of type xs:float to prepared XQuery.

Specified by:
bindFloat in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a float value of external variable.
Throws:
TXQTypeException

bindDouble

public void bindDouble(javax.xml.namespace.QName varname,
                       double value)
                throws TXQTypeException
Binds external variable of type xs:double to prepared XQuery.

Specified by:
bindDouble in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a double value of external variable.
Throws:
TXQTypeException

bindInteger

public void bindInteger(javax.xml.namespace.QName varname,
                        java.math.BigInteger value)
                 throws TXQTypeException
Binds external variable of type xs:integer to prepared XQuery.

Specified by:
bindInteger in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a integer value of external variable.
Throws:
TXQTypeException

bindDecimal

public void bindDecimal(javax.xml.namespace.QName varname,
                        java.math.BigDecimal value)
                 throws TXQTypeException
Binds external variable of type xs:decimal to prepared XQuery.

Specified by:
bindDecimal in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a decimal value of external variable.
Throws:
TXQTypeException

bindString

public void bindString(javax.xml.namespace.QName varname,
                       java.lang.String value)
                throws TXQTypeException
Binds external variable of type xs:string to prepared XQuery.

Specified by:
bindString in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a string value of external variable.
Throws:
TXQTypeException

bindDateTime

public void bindDateTime(javax.xml.namespace.QName varname,
                         java.util.Calendar value,
                         java.lang.String format)
                  throws TXQTypeException
Binds external variable of type xs:dateTime to prepared XQuery.

Specified by:
bindDateTime in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a dateTime value of external variable.
format - is a format of dateTime value of external variable. e.g.(yyyy-MM-dd'T'hh:mm:ss)
Throws:
TXQTypeException

bindBase64Binary

public void bindBase64Binary(javax.xml.namespace.QName varname,
                             byte[] value)
                      throws TXQTypeException
Binds external variable of type xs:base64Binary to prepared XQuery.

Specified by:
bindBase64Binary in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a base64Binary value of external variable.
Throws:
TXQTypeException

bindHexBinary

public void bindHexBinary(javax.xml.namespace.QName varname,
                          byte[] value)
                   throws TXQTypeException
Binds external variable of type xs:hexBinary to prepared XQuery.

Specified by:
bindHexBinary in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a hexBinary value of external variable.
Throws:
TXQTypeException

bindDuration

public void bindDuration(javax.xml.namespace.QName varname,
                         java.lang.String value)
                  throws TXQTypeException
Binds external variable of type xs:duration to prepared XQuery.

Specified by:
bindDuration in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a duration value of external variable.
Throws:
TXQTypeException

bindTime

public void bindTime(javax.xml.namespace.QName varname,
                     java.util.Calendar value,
                     java.lang.String format)
              throws TXQTypeException
Binds external variable of type xs:time to prepared XQuery.

Specified by:
bindTime in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a time value of external variable.
format - is a format of time value of external variable. e.g.(hh:mm:ss)
Throws:
TXQTypeException

bindDate

public void bindDate(javax.xml.namespace.QName varname,
                     java.util.Calendar value,
                     java.lang.String format)
              throws TXQTypeException
Binds external variable of type xs:date to prepared XQuery.

Specified by:
bindDate in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a date value of external variable.
format - is a format of date value of external variable. e.g.(yyyy-MM-dd)
Throws:
TXQTypeException

bindGYearMonth

public void bindGYearMonth(javax.xml.namespace.QName varname,
                           java.lang.String value)
                    throws TXQTypeException
Binds external variable of type xs:gYearMonth to prepared XQuery.

Specified by:
bindGYearMonth in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a gYearMonth value of external variable.
Throws:
TXQTypeException

bindGYear

public void bindGYear(javax.xml.namespace.QName varname,
                      java.lang.String value)
               throws TXQTypeException
Binds external variable of type xs:gYear to prepared XQuery.

Specified by:
bindGYear in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a gYear value of external variable.
Throws:
TXQTypeException

bindGMonthDay

public void bindGMonthDay(javax.xml.namespace.QName varname,
                          java.lang.String value)
                   throws TXQTypeException
Binds external variable of type xs:gMonthDay to prepared XQuery.

Specified by:
bindGMonthDay in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a gMonthDay value of external variable.
Throws:
TXQTypeException

bindGDay

public void bindGDay(javax.xml.namespace.QName varname,
                     java.lang.String value)
              throws TXQTypeException
Binds external variable of type xs:gDay to prepared XQuery.

Specified by:
bindGDay in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a gDay value of external variable.
Throws:
TXQTypeException

bindGMonth

public void bindGMonth(javax.xml.namespace.QName varname,
                       java.lang.String value)
                throws TXQTypeException
Binds external variable of type xs:gMonth to prepared XQuery.

Specified by:
bindGMonth in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a gMonth value of external variable.
Throws:
TXQTypeException

bindURI

public void bindURI(javax.xml.namespace.QName varname,
                    java.net.URI value)
             throws TXQTypeException
Binds external variable of type xs:anyURI to prepared XQuery.

Specified by:
bindURI in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a anyURI value of external variable.
Throws:
TXQTypeException

bindToken

public void bindToken(javax.xml.namespace.QName varname,
                      java.lang.String value)
               throws TXQTypeException
Binds external variable of type xs:token to prepared XQuery.

Specified by:
bindToken in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a token value of external variable.
Throws:
TXQTypeException

bindNormalizedString

public void bindNormalizedString(javax.xml.namespace.QName varname,
                                 java.lang.String value)
                          throws TXQTypeException
Binds external variable of type xs:normalizedString to prepared XQuery.

Specified by:
bindNormalizedString in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a normalizedString value of external variable.
Throws:
TXQTypeException

bindNotation

public void bindNotation(javax.xml.namespace.QName varname,
                         java.lang.String value)
                  throws TXQTypeException
Binds external variable of type xs:NOTATION to XQuery.

Parameters:
varname - is a QName that represents external variable.
value - is a notation value of external variable.
Throws:
TXQTypeException

bindLanguage

public void bindLanguage(javax.xml.namespace.QName varname,
                         java.lang.String value)
                  throws TXQTypeException
Binds external variable of type xs:language to prepared XQuery.

Specified by:
bindLanguage in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a language value of external variable.
Throws:
TXQTypeException

bindName

public void bindName(javax.xml.namespace.QName varname,
                     java.lang.String value)
              throws TXQTypeException
Binds external variable of type xs:Name to prepared XQuery.

Specified by:
bindName in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a Name value of external variable.
Throws:
TXQTypeException

bindNMToken

public void bindNMToken(javax.xml.namespace.QName varname,
                        java.lang.String value)
                 throws TXQTypeException
Binds external variable of type xs:NMTOKEN to prepared XQuery.

Specified by:
bindNMToken in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a NMTOKEN value of external variable.
Throws:
TXQTypeException

bindNCName

public void bindNCName(javax.xml.namespace.QName varname,
                       java.lang.String value)
                throws TXQTypeException
Binds external variable of type xs:NCName to prepared XQuery.

Specified by:
bindNCName in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a NCName value of external variable.
Throws:
TXQTypeException

bindID

public void bindID(javax.xml.namespace.QName varname,
                   java.lang.String value)
            throws TXQTypeException
Binds external variable of type xs:ID to prepared XQuery.

Specified by:
bindID in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a ID value of external variable.
Throws:
TXQTypeException

bindIDRef

public void bindIDRef(javax.xml.namespace.QName varname,
                      java.lang.String value)
               throws TXQTypeException
Binds external variable of type xs:IDREF to prepared XQuery.

Specified by:
bindIDRef in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a IDREF value of external variable.
Throws:
TXQTypeException

bindEntity

public void bindEntity(javax.xml.namespace.QName varname,
                       java.lang.String value)
                throws TXQTypeException
Binds external variable of type xs:ENTITY to prepared XQuery.

Specified by:
bindEntity in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a ENTITY value of external variable.
Throws:
TXQTypeException

bindNonPositiveInteger

public void bindNonPositiveInteger(javax.xml.namespace.QName varname,
                                   java.math.BigInteger value)
                            throws TXQTypeException
Binds external variable of type xs:nonPositiveInteger to prepared XQuery.

Specified by:
bindNonPositiveInteger in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a nonPositiveInteger value of external variable.
Throws:
TXQTypeException

bindNonNegativeInteger

public void bindNonNegativeInteger(javax.xml.namespace.QName varname,
                                   java.math.BigInteger value)
                            throws TXQTypeException
Binds external variable of type xs:nonNegativeInteger to prepared XQuery.

Specified by:
bindNonNegativeInteger in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a nonNegativeInteger value of external variable.
Throws:
TXQTypeException

bindNegativeInteger

public void bindNegativeInteger(javax.xml.namespace.QName varname,
                                java.math.BigInteger value)
                         throws TXQTypeException
Binds external variable of type xs:negativeInteger to prepared XQuery.

Specified by:
bindNegativeInteger in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a negativeInteger value of external variable.
Throws:
TXQTypeException

bindUnsignedLong

public void bindUnsignedLong(javax.xml.namespace.QName varname,
                             java.math.BigInteger value)
                      throws TXQTypeException
Binds external variable of type xs:unsignedLong to prepared XQuery.

Specified by:
bindUnsignedLong in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a unsignedLong value of external variable.
Throws:
TXQTypeException

bindPositiveInteger

public void bindPositiveInteger(javax.xml.namespace.QName varname,
                                java.math.BigInteger value)
                         throws TXQTypeException
Binds external variable of type xs:positiveInteger to prepared XQuery.

Specified by:
bindPositiveInteger in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a positiveInteger value of external variable.
Throws:
TXQTypeException

bindUnsignedInt

public void bindUnsignedInt(javax.xml.namespace.QName varname,
                            long value)
                     throws TXQTypeException
Binds external variable of type xs:unsignedInt to prepared XQuery.

Specified by:
bindUnsignedInt in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a unsignedInt value of external variable.
Throws:
TXQTypeException

bindUnsignedShort

public void bindUnsignedShort(javax.xml.namespace.QName varname,
                              int value)
                       throws TXQTypeException
Binds external variable of type xs:unsignedShort to prepared XQuery.

Specified by:
bindUnsignedShort in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a unsignedShort value of external variable.
Throws:
TXQTypeException

bindUnsignedByte

public void bindUnsignedByte(javax.xml.namespace.QName varname,
                             short value)
                      throws TXQTypeException
Binds external variable of type xs:unsignedByte to prepared XQuery.

Specified by:
bindUnsignedByte in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a unsignedByte value of external variable.
Throws:
TXQTypeException

bindQName

public void bindQName(javax.xml.namespace.QName varname,
                      javax.xml.namespace.QName value)
               throws TXQTypeException
Binding variable of type QName is possible only if QName is outside of any namespace. This means external variable are identified by NCName and not by a QName

Specified by:
bindQName in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is a QName value of external variable.
Throws:
TXQTypeException

bindSequence

public void bindSequence(javax.xml.namespace.QName varname,
                         TXQTypes type,
                         java.lang.String[] sequence)
                  throws TXQTypeException
Binds external variable of type Sequence to prepared XQuery.

Specified by:
bindSequence in interface TXQDynamicContext
Parameters:
varname - is a QName that represents external variable.
value - is an array of items in a Sequence.
Throws:
TXQTypeException

bindSequence

public void bindSequence(javax.xml.namespace.QName varname,
                         TXQTypes[] type,
                         java.lang.String[] sequence)
                  throws TXQTypeException
Binds external variable of type Sequence to prepared XQuery.

Parameters:
varname - is a QName that represents external variable.
value - is an array of items in a Sequence.
Throws:
TXQTypeException

setQuerySearchMode

public void setQuerySearchMode(TQuerySearchMode querySearchMode)
Sets the _querysearchmode parameter for this query. Tamino version 4.1 onwards index access operations were made safe in the sense that they now deliver consistent results. That means, if a single query access multiple indexes, it is ensured that all these indexes reflect the same set of documents with the same document contents. For this implementation short-term locks on doctype level are used.

It has turned out that these �short-term� locks might live too long. Then, while a query request is reading indizes, concurrent updates have to wait until this short lock becomes available. To prevent starvation of these update requests, newly arriving read request have to queue up behind the update requests. As a consequence, even very short read requests need a long time until they can be processed.

To increase transaction throughput and to solve above mentioned problem we may require to process queries without these �short-term� doctype locks. But giving up the �short-term� doctype lock during index processing implies that one can no longer rely on many assumptions about the correctness of the result.

In order to specify that query request should not use "short-term" locks, set _querysearchmode="approximate" i.e. TQuery.setQuerySearchMode(TQuerySearchMode.APPROXIMATE). Default value for this parameter is - "accurate"

Parameters:
_querysearchmode - parameter for this query.

getQuerySearchMode

public TQuerySearchMode getQuerySearchMode()
Gets the _querysearchmode parameter for this query.

Returns:
The _querysearchmode parameter for this query.

toString

public java.lang.String toString()
Returns the String representation of this TQuery instance.

Overrides:
toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)
Indicates whether some other object is "equal to" this one.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable. Overrides the Object.hashCode method.

Overrides:
hashCode in class java.lang.Object
Returns:
a hash code value for this object.


Copyright (c) 2013 Software AG. All Rights Reserved.