org.openscience.nmrshiftdb.om
Class BaseDBSignalDBAtom

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBSignalDBAtom

public abstract class BaseDBSignalDBAtom
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 DBSignalDBAtom

See Also:

Serialized Form

Field Summary

private DBAtom	aDBAtom
private DBSignal	aDBSignal
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 static java.util.List	fieldNames
private static DBSignalDBAtomPeer	peer The Peer class
private org.apache.torque.om.SimpleKey[]	pks
private int	signalId The value for the signalId field

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

NEW_ID

Constructor Summary

BaseDBSignalDBAtom()

Method Summary

DBSignalDBAtom	copy() Makes a copy of this object.
protected DBSignalDBAtom	copyInto(DBSignalDBAtom 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.
DBAtom	getDBAtom() Get the associated DBAtom object
DBSignal	getDBSignal() Get the associated DBSignal object
static java.util.List	getFieldNames() Generate a list of field names.
DBSignalDBAtomPeer	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.
int	getSignalId() Get the SignalId
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	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	setDBSignal(DBSignal v) Declares an association between this object and a DBSignal object
void	setDBSignalKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setPrimaryKey(int signalId, 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	setSignalId(int v) Set the value of SignalId
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 DBSignalDBAtomPeer peer

The Peer class

signalId

private int signalId

The value for the signalId field

atomId

private int atomId

The value for the atomId field

aDBSignal

private DBSignal aDBSignal

aDBAtom

private DBAtom aDBAtom

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

BaseDBSignalDBAtom

public BaseDBSignalDBAtom()

Method Detail

getSignalId

public int getSignalId()

Get the SignalId

Returns:

int

setSignalId

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

Set the value of SignalId

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

setDBSignal

public void setDBSignal(DBSignal v)
                 throws org.apache.torque.TorqueException

Declares an association between this object and a DBSignal object

Parameters:

v - DBSignal

Throws:

org.apache.torque.TorqueException

getDBSignal

public DBSignal getDBSignal()
                     throws org.apache.torque.TorqueException

Get the associated DBSignal object

Returns:

the associated DBSignal object

Throws:

org.apache.torque.TorqueException

setDBSignalKey

public void setDBSignalKey(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

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

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 signalId,
                          int atomId)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

int - signalId

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 DBSignalDBAtom 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 DBSignalDBAtom copyInto(DBSignalDBAtom copyObj)
                           throws org.apache.torque.TorqueException

Throws:

org.apache.torque.TorqueException

getPeer

public DBSignalDBAtomPeer 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