org.openscience.nmrshiftdb.om
Class BaseDBCoupling

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBCoupling

public abstract class BaseDBCoupling
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 DBCoupling

See Also:

Serialized Form

Field Summary

private DBAtom	aDBAtomRelatedByAtomId1
private DBAtom	aDBAtomRelatedByAtomId2
private DBSpectrum	aDBSpectrum
private boolean	alreadyInSave flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.
private int	atomId1 The value for the atomId1 field
private int	atomId2 The value for the atomId2 field
private org.apache.torque.om.ComboKey	comboPK
private double	constant The value for the constant field
private static java.util.List	fieldNames
private static DBCouplingPeer	peer The Peer class
private org.apache.torque.om.SimpleKey[]	pks
private int	spectrumId The value for the spectrumId field

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

NEW_ID

Constructor Summary

BaseDBCoupling()

Method Summary

DBCoupling	copy() Makes a copy of this object.
protected DBCoupling	copyInto(DBCoupling copyObj)
int	getAtomId1() Get the AtomId1
int	getAtomId2() Get the AtomId2
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.
double	getConstant() Get the Constant
DBAtom	getDBAtomRelatedByAtomId1() Get the associated DBAtom object
DBAtom	getDBAtomRelatedByAtomId2() Get the associated DBAtom object
DBSpectrum	getDBSpectrum() Get the associated DBSpectrum object
static java.util.List	getFieldNames() Generate a list of field names.
DBCouplingPeer	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	getSpectrumId() Get the SpectrumId
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	setAtomId1(int v) Set the value of AtomId1
void	setAtomId2(int v) Set the value of AtomId2
void	setConstant(double v) Set the value of Constant
void	setDBAtomRelatedByAtomId1(DBAtom v) Declares an association between this object and a DBAtom object
void	setDBAtomRelatedByAtomId1Key(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setDBAtomRelatedByAtomId2(DBAtom v) Declares an association between this object and a DBAtom object
void	setDBAtomRelatedByAtomId2Key(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setDBSpectrum(DBSpectrum v) Declares an association between this object and a DBSpectrum object
void	setDBSpectrumKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setPrimaryKey(int spectrumId, int atomId1, int atomId2) 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	setSpectrumId(int v) Set the value of SpectrumId
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 DBCouplingPeer peer

The Peer class

spectrumId

private int spectrumId

The value for the spectrumId field

atomId1

private int atomId1

The value for the atomId1 field

atomId2

private int atomId2

The value for the atomId2 field

constant

private double constant

The value for the constant field

aDBAtomRelatedByAtomId1

private DBAtom aDBAtomRelatedByAtomId1

aDBAtomRelatedByAtomId2

private DBAtom aDBAtomRelatedByAtomId2

aDBSpectrum

private DBSpectrum aDBSpectrum

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

BaseDBCoupling

public BaseDBCoupling()

Method Detail

getSpectrumId

public int getSpectrumId()

Get the SpectrumId

Returns:

int

setSpectrumId

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

Set the value of SpectrumId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getAtomId1

public int getAtomId1()

Get the AtomId1

Returns:

int

setAtomId1

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

Set the value of AtomId1

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getAtomId2

public int getAtomId2()

Get the AtomId2

Returns:

int

setAtomId2

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

Set the value of AtomId2

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getConstant

public double getConstant()

Get the Constant

Returns:

double

setConstant

public void setConstant(double v)

Set the value of Constant

Parameters:

v - new value

setDBAtomRelatedByAtomId1

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

getDBAtomRelatedByAtomId1

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

Get the associated DBAtom object

Returns:

the associated DBAtom object

Throws:

org.apache.torque.TorqueException

setDBAtomRelatedByAtomId1Key

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

setDBAtomRelatedByAtomId2

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

getDBAtomRelatedByAtomId2

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

Get the associated DBAtom object

Returns:

the associated DBAtom object

Throws:

org.apache.torque.TorqueException

setDBAtomRelatedByAtomId2Key

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

setDBSpectrum

public void setDBSpectrum(DBSpectrum v)
                   throws org.apache.torque.TorqueException

Declares an association between this object and a DBSpectrum object

Parameters:

v - DBSpectrum

Throws:

org.apache.torque.TorqueException

getDBSpectrum

public DBSpectrum getDBSpectrum()
                         throws org.apache.torque.TorqueException

Get the associated DBSpectrum object

Returns:

the associated DBSpectrum object

Throws:

org.apache.torque.TorqueException

setDBSpectrumKey

public void setDBSpectrumKey(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 spectrumId,
                          int atomId1,
                          int atomId2)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

int - spectrumId

int - atomId1

int - atomId2

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

Throws:

org.apache.torque.TorqueException

getPeer

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