org.enhydra.shark.globalpersistence.data
Class GlobalDataDataStruct

java.lang.Object
  extended by com.lutris.appserver.server.sql.CoreDataStruct
      extended by org.enhydra.shark.globalpersistence.data.GlobalDataDataStruct
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class GlobalDataDataStruct
extends com.lutris.appserver.server.sql.CoreDataStruct
implements java.lang.Cloneable, java.io.Serializable

Data structure for DO class. A container for data members of a DO class. A DO class contains a reference to a DataStruct class. This reference can be null (a DO whose data has not yet been retrieved from the database), allowing a DO object to be a lightweight placeholder until its data is needed.

Since:
DODS Project;
Version:
$Revision: 1.22 $
Author:
NN
See Also:
Serialized Form

Field Summary
static int COLUMN_DATAID
          Used for query caching.
static int COLUMN_DATATYPE
          Used for query caching.
static int COLUMN_DATAVALUE
          Used for query caching.
static int COLUMN_DATAVALUEBOOL
          Used for query caching.
static int COLUMN_DATAVALUEDATE
          Used for query caching.
static int COLUMN_DATAVALUEDBL
          Used for query caching.
static int COLUMN_DATAVALUELONG
          Used for query caching.
static int COLUMN_DATAVALUEVCHAR
          Used for query caching.
static int COLUMN_DATAVALUEXML
          Used for query caching.
static int COLUMN_OID
          Used for query caching.
static int COLUMN_ORDNO
          Used for query caching.
 boolean readOnly
          A DO refers to this DataStruct.
 
Fields inherited from class com.lutris.appserver.server.sql.CoreDataStruct
newVersion, oId, version
 
Constructor Summary
GlobalDataDataStruct()
           
 
Method Summary
 boolean compareCond(org.enhydra.dods.cache.Condition cond)
          Compares whether this DataStruct object satisfies condition cond.
 com.lutris.appserver.server.sql.CoreDataStruct dumpData(boolean incrementVersion)
           
 GlobalDataDataStruct duplicate()
          Create a copy of the guts of a DO.
 com.lutris.dods.builder.generator.dataobject.XMLDataEnvelope envelope4DataValueXML()
          Return value of DataValueXML column.
 java.lang.String get_CacheHandle()
          Returns this object's cache handle (String in the form: ".
 java.lang.String get_Database()
           
 java.lang.String get_Handle()
          Returns this object's handle (identifier as a string).
protected  int get_Version()
          Returns DataStruct's version.
 java.lang.String getDataId()
          Return value of DataId column.
 short getDataType()
          Return value of DataType column.
 byte[] getDataValue()
          Return value of DataValue column.
 boolean getDataValueBOOL()
          Return value of DataValueBOOL column.
 java.sql.Timestamp getDataValueDATE()
          Return value of DataValueDATE column.
 double getDataValueDBL()
          Return value of DataValueDBL column.
 long getDataValueLONG()
          Return value of DataValueLONG column.
 java.lang.String getDataValueVCHAR()
          Return value of DataValueVCHAR column.
 org.w3c.dom.Node getDataValueXML()
          Return value of DataValueXML column.
 int getOrdNo()
          Return value of OrdNo column.
protected  boolean isEmpty()
          Returns indicator if DataStruct has any useful content.
 void set_Database(java.lang.String dbName)
           
protected  void set_Empty(boolean b)
          Sets indicator if DataStruct has any useful content.
protected  void set_OId(com.lutris.appserver.server.sql.ObjectId oId)
          Sets this object's identifier.
protected  void set_Version(int v)
          Sets DataStruct's version.
 void setDataId(java.lang.String val4DataId)
          Sets DataId column.
 void setDataType(short val4DataType)
          Sets DataType column.
 void setDataValue(byte[] val4DataValue)
          Sets DataValue column.
 void setDataValueBOOL(boolean val4DataValueBOOL)
          Sets DataValueBOOL column.
 void setDataValueDATE(java.sql.Timestamp val4DataValueDATE)
          Sets DataValueDATE column.
 void setDataValueDBL(double val4DataValueDBL)
          Sets DataValueDBL column.
 void setDataValueLONG(long val4DataValueLONG)
          Sets DataValueLONG column.
 void setDataValueVCHAR(java.lang.String val4DataValueVCHAR)
          Sets DataValueVCHAR column.
 void setDataValueXML(org.w3c.dom.Node val4DataValueXML)
          Sets DataValueXML column.
 void setOrdNo(int val4OrdNo)
          Sets OrdNo column.
 java.lang.String toString()
           
 java.lang.String toString(int indentCount)
           
 void writeXMLData(java.io.Writer w)
           
 
Methods inherited from class com.lutris.appserver.server.sql.CoreDataStruct
get_OId, get_OIdColumnName, get_versionColumnName, getHandle, getOId, getVersion, set_OIdColumnName, set_versionColumnName, setOId, setVersion, writeXMLhead
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

readOnly

public boolean readOnly
A DO refers to this DataStruct. readOnly is set to true when the DO is stored in its class cache.


COLUMN_DATAID

public static final int COLUMN_DATAID
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATATYPE

public static final int COLUMN_DATATYPE
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATAVALUE

public static final int COLUMN_DATAVALUE
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATAVALUEXML

public static final int COLUMN_DATAVALUEXML
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATAVALUEVCHAR

public static final int COLUMN_DATAVALUEVCHAR
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATAVALUEDBL

public static final int COLUMN_DATAVALUEDBL
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATAVALUELONG

public static final int COLUMN_DATAVALUELONG
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATAVALUEDATE

public static final int COLUMN_DATAVALUEDATE
Used for query caching.

See Also:
Constant Field Values

COLUMN_DATAVALUEBOOL

public static final int COLUMN_DATAVALUEBOOL
Used for query caching.

See Also:
Constant Field Values

COLUMN_ORDNO

public static final int COLUMN_ORDNO
Used for query caching.

See Also:
Constant Field Values

COLUMN_OID

public static final int COLUMN_OID
Used for query caching.

See Also:
Constant Field Values
Constructor Detail

GlobalDataDataStruct

public GlobalDataDataStruct()
Method Detail

isEmpty

protected boolean isEmpty()
Returns indicator if DataStruct has any useful content.

Returns:
true if DataStruct has any useful content, otherwise false.

set_Empty

protected void set_Empty(boolean b)
Sets indicator if DataStruct has any useful content.

Parameters:
b - new value of indicator if DataStruct has any useful content.

get_Version

protected int get_Version()
Returns DataStruct's version.

Overrides:
get_Version in class com.lutris.appserver.server.sql.CoreDataStruct
Returns:
DataStruct's version.

set_Version

protected void set_Version(int v)
Sets DataStruct's version.

Overrides:
set_Version in class com.lutris.appserver.server.sql.CoreDataStruct
Parameters:
v - new DataStruct's version.

set_OId

protected void set_OId(com.lutris.appserver.server.sql.ObjectId oId)
Sets this object's identifier.

Overrides:
set_OId in class com.lutris.appserver.server.sql.CoreDataStruct
Parameters:
oId - this object's identifier.

get_Handle

public java.lang.String get_Handle()
                            throws com.lutris.appserver.server.sql.DatabaseManagerException
Returns this object's handle (identifier as a string).

Overrides:
get_Handle in class com.lutris.appserver.server.sql.CoreDataStruct
Returns:
This object's identifier as a string.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - If a connection to the database cannot be established, etc.

get_CacheHandle

public java.lang.String get_CacheHandle()
                                 throws com.lutris.appserver.server.sql.DatabaseManagerException
Returns this object's cache handle (String in the form: ".").

Overrides:
get_CacheHandle in class com.lutris.appserver.server.sql.CoreDataStruct
Returns:
cache handle.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - If a connection to the database cannot be established, etc.

set_Database

public void set_Database(java.lang.String dbName)
Parameters:
dbName - - name of the logical database this DataStruct should belong to.

get_Database

public java.lang.String get_Database()
Overrides:
get_Database in class com.lutris.appserver.server.sql.CoreDataStruct
Returns:
name of the logical database this DataStruct belongs to.

dumpData

public com.lutris.appserver.server.sql.CoreDataStruct dumpData(boolean incrementVersion)
Specified by:
dumpData in class com.lutris.appserver.server.sql.CoreDataStruct

writeXMLData

public void writeXMLData(java.io.Writer w)
                  throws java.io.IOException
Specified by:
writeXMLData in class com.lutris.appserver.server.sql.CoreDataStruct
Throws:
java.io.IOException

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

toString

public java.lang.String toString(int indentCount)

setDataId

public void setDataId(java.lang.String val4DataId)
Sets DataId column.

Parameters:
val4DataId - new column value.

getDataId

public java.lang.String getDataId()
Return value of DataId column.

Returns:
value of DataId column.

setDataType

public void setDataType(short val4DataType)
Sets DataType column.

Parameters:
val4DataType - new column value.

getDataType

public short getDataType()
Return value of DataType column.

Returns:
value of DataType column.

setDataValue

public void setDataValue(byte[] val4DataValue)
Sets DataValue column.

Parameters:
val4DataValue - new column value.

getDataValue

public byte[] getDataValue()
Return value of DataValue column.

Returns:
value of DataValue column.

setDataValueXML

public void setDataValueXML(org.w3c.dom.Node val4DataValueXML)
Sets DataValueXML column.

Parameters:
val4DataValueXML - new column value.

getDataValueXML

public org.w3c.dom.Node getDataValueXML()
Return value of DataValueXML column.

Returns:
value of DataValueXML column.

envelope4DataValueXML

public com.lutris.dods.builder.generator.dataobject.XMLDataEnvelope envelope4DataValueXML()
Return value of DataValueXML column.

Returns:
value of DataValueXML column.

setDataValueVCHAR

public void setDataValueVCHAR(java.lang.String val4DataValueVCHAR)
Sets DataValueVCHAR column.

Parameters:
val4DataValueVCHAR - new column value.

getDataValueVCHAR

public java.lang.String getDataValueVCHAR()
Return value of DataValueVCHAR column.

Returns:
value of DataValueVCHAR column.

setDataValueDBL

public void setDataValueDBL(double val4DataValueDBL)
Sets DataValueDBL column.

Parameters:
val4DataValueDBL - new column value.

getDataValueDBL

public double getDataValueDBL()
Return value of DataValueDBL column.

Returns:
value of DataValueDBL column.

setDataValueLONG

public void setDataValueLONG(long val4DataValueLONG)
Sets DataValueLONG column.

Parameters:
val4DataValueLONG - new column value.

getDataValueLONG

public long getDataValueLONG()
Return value of DataValueLONG column.

Returns:
value of DataValueLONG column.

setDataValueDATE

public void setDataValueDATE(java.sql.Timestamp val4DataValueDATE)
Sets DataValueDATE column.

Parameters:
val4DataValueDATE - new column value.

getDataValueDATE

public java.sql.Timestamp getDataValueDATE()
Return value of DataValueDATE column.

Returns:
value of DataValueDATE column.

setDataValueBOOL

public void setDataValueBOOL(boolean val4DataValueBOOL)
Sets DataValueBOOL column.

Parameters:
val4DataValueBOOL - new column value.

getDataValueBOOL

public boolean getDataValueBOOL()
Return value of DataValueBOOL column.

Returns:
value of DataValueBOOL column.

setOrdNo

public void setOrdNo(int val4OrdNo)
Sets OrdNo column.

Parameters:
val4OrdNo - new column value.

getOrdNo

public int getOrdNo()
Return value of OrdNo column.

Returns:
value of OrdNo column.

compareCond

public boolean compareCond(org.enhydra.dods.cache.Condition cond)
Compares whether this DataStruct object satisfies condition cond.

Overrides:
compareCond in class com.lutris.appserver.server.sql.CoreDataStruct
Parameters:
cond - Condition of the query.
Returns:
true if this DataStruct object satisfies condition of this query, otherwise false.

duplicate

public GlobalDataDataStruct duplicate()
                               throws com.lutris.dods.builder.generator.query.DataObjectException
Create a copy of the guts of a DO.

Returns:
Copied DataStruct object.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - if createExisting() fails for a contained DO
com.lutris.appserver.server.sql.ObjectIdException - if GenericDO has trouble obtaining a valid id.
com.lutris.dods.builder.generator.query.DataObjectException