DODS 7.1 API

com.lutris.appserver.server.sql
Class CoreDataStruct

java.lang.Object
  extended by com.lutris.appserver.server.sql.CoreDataStruct

public abstract class CoreDataStruct
extends java.lang.Object

Base class from which the data objects are derived.

Version:
$Revision: 1.6 $
Author:
Kyle Clark

Field Summary
protected  int newVersion
           
protected  ObjectId oId
           
protected  int version
           
 
Constructor Summary
CoreDataStruct()
          Public constructor.
 
Method Summary
 boolean compareCond(Condition cond)
          Subclass should override this method if wants to use it.
abstract  CoreDataStruct dumpData(boolean incrementVersion)
           
 java.lang.String get_CacheHandle()
          Subclass should override this method if wants to use it.
 java.lang.String get_Database()
          Subclass should override this method if wants to use it.
 java.lang.String get_Handle()
          Subclass should override this method if wants to use it.
 ObjectId get_OId()
          Returns this object's identifier.
protected static java.lang.String get_OIdColumnName()
          Returns the object identifier column name.
protected  int get_Version()
          Returns this object's version.
protected static java.lang.String get_versionColumnName()
          Returns the version column name.
 java.lang.String getHandle()
          Deprecated. Use get_Handle() instead.
 ObjectId getOId()
          Deprecated. Use get_OId()
protected  int getVersion()
          Deprecated. Use get_Version()
protected  void set_OId(ObjectId oId)
          Sets this object's identifier.
protected static void set_OIdColumnName(java.lang.String _oidColumnName)
          Sets the object identifier column name.
protected  void set_Version(int _version)
          Sets this object's version.
protected static void set_versionColumnName(java.lang.String _versionColumnName)
          Sets the version column name.
protected  void setOId(ObjectId oId)
          Deprecated. Use set_OId()
protected  void setVersion(int _version)
          Deprecated. Use set_Version()
abstract  void writeXMLData(java.io.Writer writer)
          Writes the data, for this WebRowSet object to the given Writer object in XML format.
static void writeXMLhead(java.io.Writer w)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

oId

protected ObjectId oId

version

protected int version

newVersion

protected int newVersion
Constructor Detail

CoreDataStruct

public CoreDataStruct()
Public constructor.

Method Detail

get_OIdColumnName

protected static java.lang.String get_OIdColumnName()
Returns the object identifier column name.

Returns:
the object identifier column name.

set_OIdColumnName

protected static void set_OIdColumnName(java.lang.String _oidColumnName)
Sets the object identifier column name.

Parameters:
_oidColumnName - Name of object identifier column.

get_versionColumnName

protected static java.lang.String get_versionColumnName()
Returns the version column name.

Returns:
the version column name.

set_versionColumnName

protected static void set_versionColumnName(java.lang.String _versionColumnName)
Sets the version column name.

Parameters:
_versionColumnName - Name of version column.

setVersion

protected void setVersion(int _version)
Deprecated. Use set_Version()

Parameters:
_version - the object's version.

set_Version

protected void set_Version(int _version)
Sets this object's version.

Parameters:
_version - the object's version.

getVersion

protected int getVersion()
Deprecated. Use get_Version()

Returns:
this object's version.

get_Version

protected int get_Version()
Returns this object's version.

Returns:
this object's version.

getOId

public ObjectId getOId()
Deprecated. Use get_OId()

Returns:
this object's identifier.

get_OId

public ObjectId get_OId()
Returns this object's identifier.

Returns:
this object's identifier.

setOId

protected void setOId(ObjectId oId)
Deprecated. Use set_OId()

Parameters:
oId - this object's identifier.

set_OId

protected void set_OId(ObjectId oId)
Sets this object's identifier.

Parameters:
oId - this object's identifier.

compareCond

public boolean compareCond(Condition cond)
Subclass should override this method if wants to use it. This method checks if this DataStruct object satisfies condition cond.

Parameters:
cond - Condition of the query.
Returns:
true if this DataStruct object satisfies condition of this query, otherwise false.

getHandle

public java.lang.String getHandle()
                           throws DatabaseManagerException
Deprecated. Use get_Handle() instead.

Subclass should override this method if wants to use it. Returns this object's handle (identifier as a string).

Returns:
This object's identifier as a string.
Throws:
DatabaseManagerException - If a connection to the database cannot be established, etc.

get_Handle

public java.lang.String get_Handle()
                            throws DatabaseManagerException
Subclass should override this method if wants to use it. Returns this object's handle (identifier as a string).

Returns:
This object's identifier as a string.
Throws:
DatabaseManagerException - If a connection to the database cannot be established, etc.

get_CacheHandle

public java.lang.String get_CacheHandle()
                                 throws DatabaseManagerException
Subclass should override this method if wants to use it. Returns this object's cache handle (String in the form: ".").

Returns:
cache handle.
Throws:
DatabaseManagerException - If a connection to the database cannot be established, etc.

get_Database

public java.lang.String get_Database()
Subclass should override this method if wants to use it. Returns the name of the logical database for which was this object created.

Returns:
logical database name.

dumpData

public abstract CoreDataStruct dumpData(boolean incrementVersion)
Returns:
CoreDataStruct new empty instance

writeXMLData

public abstract void writeXMLData(java.io.Writer writer)
                           throws java.io.IOException
Writes the data, for this WebRowSet object to the given Writer object in XML format.

Parameters:
writer - java.io.Writer to write into
Throws:
java.io.IOException

writeXMLhead

public static void writeXMLhead(java.io.Writer w)
                         throws java.io.IOException
Throws:
java.io.IOException

DODS 7.1 API