org.openscience.nmrshiftdb.om
Class BaseDBCoordinateSet3d

java.lang.Object
  org.apache.torque.om.BaseObject
      org.openscience.nmrshiftdb.om.BaseDBCoordinateSet3d

All Implemented Interfaces:

java.io.Serializable, org.apache.torque.om.Persistent

Direct Known Subclasses:

DBCoordinateSet3d

public abstract class BaseDBCoordinateSet3d
extends org.apache.torque.om.BaseObject

This class was autogenerated by Torque on: [Tue Nov 21 16:23:43 CET 2006] You should not use this class directly. It should not even be extended all references should be to DBCoordinateSet3d

See Also:

Serialized Form

Field Summary

private DBAtom	aDBAtom
private DBCoordinateSetType	aDBCoordinateSetType
private boolean	alreadyInSave flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.
private int	atomId The value for the atomId field
private org.apache.torque.om.ComboKey	comboPK
private int	coordinateSetTypeId The value for the coordinateSetTypeId field
private static java.util.List	fieldNames
private static DBCoordinateSet3dPeer	peer The Peer class
private org.apache.torque.om.SimpleKey[]	pks
private double	xCoordinate The value for the xCoordinate field
private double	yCoordinate The value for the yCoordinate field
private double	zCoordinate The value for the zCoordinate field

Fields inherited from class org.apache.torque.om.BaseObject

NEW_ID

Constructor Summary

BaseDBCoordinateSet3d()

Method Summary

DBCoordinateSet3d	copy() Makes a copy of this object.
protected DBCoordinateSet3d	copyInto(DBCoordinateSet3d copyObj)
int	getAtomId() Get the AtomId
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPeerName(java.lang.String name) Retrieves a field from the object by name passed in as a String.
java.lang.Object	getByPosition(int pos) Retrieves a field from the object by Position as specified in the xml schema.
int	getCoordinateSetTypeId() Get the CoordinateSetTypeId
DBAtom	getDBAtom() Get the associated DBAtom object
DBCoordinateSetType	getDBCoordinateSetType() Get the associated DBCoordinateSetType object
static java.util.List	getFieldNames() Generate a list of field names.
DBCoordinateSet3dPeer	getPeer() returns a peer instance associated with this om.
org.apache.torque.om.ObjectKey	getPrimaryKey() returns an id that differentiates this object from others of its class.
double	getXCoordinate() Get the XCoordinate
double	getYCoordinate() Get the YCoordinate
double	getZCoordinate() Get the ZCoordinate
void	save() Stores the object in the database.
void	save(java.sql.Connection con) Stores the object in the database.
void	save(java.lang.String dbName) Stores the object in the database.
void	setAtomId(int v) Set the value of AtomId
void	setCoordinateSetTypeId(int v) Set the value of CoordinateSetTypeId
void	setDBAtom(DBAtom v) Declares an association between this object and a DBAtom object
void	setDBAtomKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setDBCoordinateSetType(DBCoordinateSetType v) Declares an association between this object and a DBCoordinateSetType object
void	setDBCoordinateSetTypeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setPrimaryKey(int coordinateSetTypeId, int atomId) Set the PrimaryKey using SimpleKeys.
void	setPrimaryKey(org.apache.torque.om.ObjectKey key) Set the PrimaryKey with an ObjectKey
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setXCoordinate(double v) Set the value of XCoordinate
void	setYCoordinate(double v) Set the value of YCoordinate
void	setZCoordinate(double v) Set the value of ZCoordinate
java.lang.String	toString()

Methods inherited from class org.apache.torque.om.BaseObject

equals, equals, getLog, hashCode, isModified, isNew, log, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

peer

private static final DBCoordinateSet3dPeer peer

The Peer class

coordinateSetTypeId

private int coordinateSetTypeId

The value for the coordinateSetTypeId field

atomId

private int atomId

The value for the atomId field

xCoordinate

private double xCoordinate

The value for the xCoordinate field

yCoordinate

private double yCoordinate

The value for the yCoordinate field

zCoordinate

private double zCoordinate

The value for the zCoordinate field

aDBAtom

private DBAtom aDBAtom

aDBCoordinateSetType

private DBCoordinateSetType aDBCoordinateSetType

fieldNames

private static java.util.List fieldNames

alreadyInSave

private boolean alreadyInSave

flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.

pks

private final org.apache.torque.om.SimpleKey[] pks

comboPK

private final org.apache.torque.om.ComboKey comboPK

Constructor Detail

BaseDBCoordinateSet3d

public BaseDBCoordinateSet3d()

Method Detail

getCoordinateSetTypeId

public int getCoordinateSetTypeId()

Get the CoordinateSetTypeId

Returns:

int

setCoordinateSetTypeId

public void setCoordinateSetTypeId(int v)
                            throws org.apache.torque.TorqueException

Set the value of CoordinateSetTypeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getAtomId

public int getAtomId()

Get the AtomId

Returns:

int

setAtomId

public void setAtomId(int v)
               throws org.apache.torque.TorqueException

Set the value of AtomId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getXCoordinate

public double getXCoordinate()

Get the XCoordinate

Returns:

double

setXCoordinate

public void setXCoordinate(double v)

Set the value of XCoordinate

Parameters:

v - new value

getYCoordinate

public double getYCoordinate()

Get the YCoordinate

Returns:

double

setYCoordinate

public void setYCoordinate(double v)

Set the value of YCoordinate

Parameters:

v - new value

getZCoordinate

public double getZCoordinate()

Get the ZCoordinate

Returns:

double

setZCoordinate

public void setZCoordinate(double v)

Set the value of ZCoordinate

Parameters:

v - new value

setDBAtom

public void setDBAtom(DBAtom v)
               throws org.apache.torque.TorqueException

Declares an association between this object and a DBAtom object

Parameters:

v - DBAtom

Throws:

org.apache.torque.TorqueException

getDBAtom

public DBAtom getDBAtom()
                 throws org.apache.torque.TorqueException

Get the associated DBAtom object

Returns:

the associated DBAtom object

Throws:

org.apache.torque.TorqueException

setDBAtomKey

public void setDBAtomKey(org.apache.torque.om.ObjectKey key)
                  throws org.apache.torque.TorqueException

Provides convenient way to set a relationship based on a ObjectKey. e.g. bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

setDBCoordinateSetType

public void setDBCoordinateSetType(DBCoordinateSetType v)
                            throws org.apache.torque.TorqueException

Declares an association between this object and a DBCoordinateSetType object

Parameters:

v - DBCoordinateSetType

Throws:

org.apache.torque.TorqueException

getDBCoordinateSetType

public DBCoordinateSetType getDBCoordinateSetType()
                                           throws org.apache.torque.TorqueException

Get the associated DBCoordinateSetType object

Returns:

the associated DBCoordinateSetType object

Throws:

org.apache.torque.TorqueException

setDBCoordinateSetTypeKey

public void setDBCoordinateSetTypeKey(org.apache.torque.om.ObjectKey key)
                               throws org.apache.torque.TorqueException

Provides convenient way to set a relationship based on a ObjectKey. e.g. bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

getFieldNames

public static java.util.List getFieldNames()

Generate a list of field names.

Returns:

a list of field names

getByName

public java.lang.Object getByName(java.lang.String name)

Retrieves a field from the object by name passed in as a String.

Overrides:

getByName in class org.apache.torque.om.BaseObject

Parameters:

name - field name

Returns:

value

getByPeerName

public java.lang.Object getByPeerName(java.lang.String name)

Retrieves a field from the object by name passed in as a String. The String must be one of the static Strings defined in this Class' Peer.

Overrides:

getByPeerName in class org.apache.torque.om.BaseObject

Parameters:

name - peer name

Returns:

value

getByPosition

public java.lang.Object getByPosition(int pos)

Retrieves a field from the object by Position as specified in the xml schema. Zero-based.

Overrides:

getByPosition in class org.apache.torque.om.BaseObject

Parameters:

pos - position in xml schema

Returns:

value

save

public void save()
          throws java.lang.Exception

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed.

Specified by:

save in interface org.apache.torque.om.Persistent

Specified by:

save in class org.apache.torque.om.BaseObject

Throws:

java.lang.Exception

save

public void save(java.lang.String dbName)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. Note: this code is here because the method body is auto-generated conditionally and therefore needs to be in this file instead of in the super class, BaseObject.

Specified by:

save in interface org.apache.torque.om.Persistent

Specified by:

save in class org.apache.torque.om.BaseObject

Parameters:

dbName -

Throws:

org.apache.torque.TorqueException

save

public void save(java.sql.Connection con)
          throws org.apache.torque.TorqueException

Stores the object in the database. If the object is new, it inserts it; otherwise an update is performed. This method is meant to be used as part of a transaction, otherwise use the save() method and the connection details will be handled internally

Specified by:

save in interface org.apache.torque.om.Persistent

Specified by:

save in class org.apache.torque.om.BaseObject

Parameters:

con -

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(org.apache.torque.om.ObjectKey key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey with an ObjectKey

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Overrides:

setPrimaryKey in class org.apache.torque.om.BaseObject

Parameters:

key -

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(int coordinateSetTypeId,
                          int atomId)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

int - coordinateSetTypeId

int - atomId

Throws:

org.apache.torque.TorqueException

setPrimaryKey

public void setPrimaryKey(java.lang.String key)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using a String.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Overrides:

setPrimaryKey in class org.apache.torque.om.BaseObject

Throws:

org.apache.torque.TorqueException

getPrimaryKey

public org.apache.torque.om.ObjectKey getPrimaryKey()

returns an id that differentiates this object from others of its class.

Specified by:

getPrimaryKey in interface org.apache.torque.om.Persistent

Overrides:

getPrimaryKey in class org.apache.torque.om.BaseObject

copy

public DBCoordinateSet3d copy()
                       throws org.apache.torque.TorqueException

Makes a copy of this object. It creates a new object filling in the simple attributes. It then fills all the association collections and sets the related objects to isNew=true.

Throws:

org.apache.torque.TorqueException

copyInto

protected DBCoordinateSet3d copyInto(DBCoordinateSet3d copyObj)
                              throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

public DBCoordinateSet3dPeer getPeer()

returns a peer instance associated with this om. Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object