com.softwareag.tamino.db.api.command
Class TCommandValue

java.lang.Object
  extended by com.softwareag.tamino.db.api.command.TCommandItem
      extended by com.softwareag.tamino.db.api.command.TCommandValue

public class TCommandValue
extends TCommandItem

TCommandValue represents the value type of TCommand. As a consequence a TCommand object offen occurrs in pair with a TCommandValue that represents its value state.

Version:
$Revision: 1.8 $
Author:
Marcus Schreyer

Field Summary
static TCommandValue API_VERSION
          Constant that represents the "apiversion" command value for the diagnose command.
static TCommandValue CLOSE
          Constant that represents the "close" command value for the cursor command.
static TCommandValue ECHO
          Constant that represents the "echo" command value for the diagnose command.
static TCommandValue FETCH
          Constant that represents the "fetch" command value for the cursor command.
static TCommandValue FULL_VERSION
          Constant that represents the "fullVersion" command value for the diagnose command.
static TCommandValue OPEN
          Constant that represents the "open" command value for the cursor command.
static TCommandValue PING
          Constant that represents the "ping" command value for the diagnose command.
static TCommandValue PREPARED_XQUERY
          Constant that represents the "prepared-xquery" command value for the execute command.
static TCommandValue TIME
          Constant that represents the "time" command value for the diagnose command.
static TCommandValue UPDATE_FRAGMENT
          Constant that represents the "update" command value for the xquery update expression.
static TCommandValue VERSION
          Constant that represents the "version" command value for the diagnose command.
 
Constructor Summary
TCommandValue(java.lang.String value)
          Initializes the TCommandValue with a string.
TCommandValue(TStreamable streamable)
          Initializes the TCommandValue with a TStreamable instance.
 
Method Summary
 TStreamable getStreamableValue()
          Returns the streamable value if one is given, null otherwise.
 boolean hasStreamableValue()
          Indicates if the command value contains a streamable value, false otherwise.
 void takeVisitor(TCommandItemVisitor visitor)
          Takes a TCommandItemVisitor and tells it that it wants to be visited.
 java.lang.String toString()
          Returns the string representation of the underlyling value.
 
Methods inherited from class com.softwareag.tamino.db.api.command.TCommandItem
getValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OPEN

public static final TCommandValue OPEN
Constant that represents the "open" command value for the cursor command.


CLOSE

public static final TCommandValue CLOSE
Constant that represents the "close" command value for the cursor command.


FETCH

public static final TCommandValue FETCH
Constant that represents the "fetch" command value for the cursor command.


PING

public static final TCommandValue PING
Constant that represents the "ping" command value for the diagnose command.


ECHO

public static final TCommandValue ECHO
Constant that represents the "echo" command value for the diagnose command.


TIME

public static final TCommandValue TIME
Constant that represents the "time" command value for the diagnose command.


VERSION

public static final TCommandValue VERSION
Constant that represents the "version" command value for the diagnose command.


FULL_VERSION

public static final TCommandValue FULL_VERSION
Constant that represents the "fullVersion" command value for the diagnose command.


UPDATE_FRAGMENT

public static final TCommandValue UPDATE_FRAGMENT
Constant that represents the "update" command value for the xquery update expression. Note: This value is just a fragment of the whole value.


API_VERSION

public static final TCommandValue API_VERSION
Constant that represents the "apiversion" command value for the diagnose command.


PREPARED_XQUERY

public static final TCommandValue PREPARED_XQUERY
Constant that represents the "prepared-xquery" command value for the execute command.

Constructor Detail

TCommandValue

public TCommandValue(java.lang.String value)
Initializes the TCommandValue with a string.


TCommandValue

public TCommandValue(TStreamable streamable)
Initializes the TCommandValue with a TStreamable instance.

Method Detail

takeVisitor

public void takeVisitor(TCommandItemVisitor visitor)
Takes a TCommandItemVisitor and tells it that it wants to be visited.

Specified by:
takeVisitor in class TCommandItem
Parameters:
the - TCommandItemVisitor that shall visit this instance.

getStreamableValue

public TStreamable getStreamableValue()
Returns the streamable value if one is given, null otherwise.


hasStreamableValue

public boolean hasStreamableValue()
Indicates if the command value contains a streamable value, false otherwise.

Returns:
true if command value contains a streamable value, false otherwise.

toString

public java.lang.String toString()
Returns the string representation of the underlyling value. If underlying value is a byte array the String "binary" is returned.

Overrides:
toString in class TCommandItem


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