org.openscience.nmrshiftdb.om
Class BaseDBSignal

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBSignal

public abstract class BaseDBSignal
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 DBSignal

See Also:

Serialized Form

Field Summary

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.
protected java.util.List	collDBShifts Collection to store aggregation of collDBShifts
protected java.util.List	collDBSignalDBAtoms Collection to store aggregation of collDBSignalDBAtoms
private static java.util.List	fieldNames
private float	intensity The value for the intensity field
private org.apache.torque.util.Criteria	lastDBShiftsCriteria The criteria used to select the current contents of collDBShifts
private org.apache.torque.util.Criteria	lastDBSignalDBAtomsCriteria The criteria used to select the current contents of collDBSignalDBAtoms
private java.lang.String	multiplicity The value for the multiplicity field
private static DBSignalPeer	peer The Peer class
private int	signalId The value for the signalId field
private int	spectrumId The value for the spectrumId field

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

NEW_ID

Constructor Summary

BaseDBSignal()

Method Summary

void	addDBShift(DBShift l) Method called to associate a DBShift object to this object through the DBShift foreign key attribute
void	addDBSignalDBAtom(DBSignalDBAtom l) Method called to associate a DBSignalDBAtom object to this object through the DBSignalDBAtom foreign key attribute
DBSignal	copy() Makes a copy of this object.
protected DBSignal	copyInto(DBSignal copyObj)
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.
java.util.List	getDBShifts() If this collection has already been initialized, returns the collection.
java.util.List	getDBShifts(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBShifts(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBShifts(org.apache.torque.util.Criteria criteria, java.sql.Connection con) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getDBShiftsJoinDBSignal(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBSignalDBAtoms() If this collection has already been initialized, returns the collection.
java.util.List	getDBSignalDBAtoms(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBSignalDBAtoms(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBSignalDBAtoms(org.apache.torque.util.Criteria criteria, java.sql.Connection con) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getDBSignalDBAtomsJoinDBAtom(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
protected java.util.List	getDBSignalDBAtomsJoinDBSignal(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
DBSpectrum	getDBSpectrum() Get the associated DBSpectrum object
static java.util.List	getFieldNames() Generate a list of field names.
float	getIntensity() Get the Intensity
java.lang.String	getMultiplicity() Get the Multiplicity
DBSignalPeer	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
int	getSpectrumId() Get the SpectrumId
protected void	initDBShifts() Temporary storage of collDBShifts to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initDBSignalDBAtoms() Temporary storage of collDBSignalDBAtoms to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
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	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	setIntensity(float v) Set the value of Intensity
void	setMultiplicity(java.lang.String v) Set the value of Multiplicity
void	setPrimaryKey(org.apache.torque.om.ObjectKey key) Set the PrimaryKey using ObjectKey.
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
void	setSignalId(int v) Set the value of SignalId
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 DBSignalPeer peer

The Peer class

signalId

private int signalId

The value for the signalId field

intensity

private float intensity

The value for the intensity field

multiplicity

private java.lang.String multiplicity

The value for the multiplicity field

spectrumId

private int spectrumId

The value for the spectrumId field

aDBSpectrum

private DBSpectrum aDBSpectrum

collDBShifts

protected java.util.List collDBShifts

Collection to store aggregation of collDBShifts

lastDBShiftsCriteria

private org.apache.torque.util.Criteria lastDBShiftsCriteria

The criteria used to select the current contents of collDBShifts

collDBSignalDBAtoms

protected java.util.List collDBSignalDBAtoms

Collection to store aggregation of collDBSignalDBAtoms

lastDBSignalDBAtomsCriteria

private org.apache.torque.util.Criteria lastDBSignalDBAtomsCriteria

The criteria used to select the current contents of collDBSignalDBAtoms

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.

Constructor Detail

BaseDBSignal

public BaseDBSignal()

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

getIntensity

public float getIntensity()

Get the Intensity

Returns:

double

setIntensity

public void setIntensity(float v)

Set the value of Intensity

Parameters:

v - new value

getMultiplicity

public java.lang.String getMultiplicity()

Get the Multiplicity

Returns:

String

setMultiplicity

public void setMultiplicity(java.lang.String v)

Set the value of Multiplicity

Parameters:

v - new value

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

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

initDBShifts

protected void initDBShifts()

Temporary storage of collDBShifts to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addDBShift

public void addDBShift(DBShift l)
                throws org.apache.torque.TorqueException

Method called to associate a DBShift object to this object through the DBShift foreign key attribute

Parameters:

l - DBShift

Throws:

org.apache.torque.TorqueException

getDBShifts

public java.util.List getDBShifts()
                           throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getDBShifts(new Criteria())

Throws:

org.apache.torque.TorqueException

getDBShifts

public java.util.List getDBShifts(org.apache.torque.util.Criteria criteria)
                           throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DBSignal has previously been saved, it will retrieve related DBShifts from storage. If this DBSignal is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

Throws:

org.apache.torque.TorqueException

getDBShifts

public java.util.List getDBShifts(java.sql.Connection con)
                           throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getDBShifts(new Criteria(),Connection) This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getDBShifts

public java.util.List getDBShifts(org.apache.torque.util.Criteria criteria,
                                  java.sql.Connection con)
                           throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DBSignal has previously been saved, it will retrieve related DBShifts from storage. If this DBSignal is new, it will return an empty collection or the current collection, the criteria is ignored on a new object. This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getDBShiftsJoinDBSignal

protected java.util.List getDBShiftsJoinDBSignal(org.apache.torque.util.Criteria criteria)
                                          throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DBSignal is new, it will return an empty collection; or if this DBSignal has previously been saved, it will retrieve related DBShifts from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DBSignal.

Throws:

org.apache.torque.TorqueException

initDBSignalDBAtoms

protected void initDBSignalDBAtoms()

Temporary storage of collDBSignalDBAtoms to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.

addDBSignalDBAtom

public void addDBSignalDBAtom(DBSignalDBAtom l)
                       throws org.apache.torque.TorqueException

Method called to associate a DBSignalDBAtom object to this object through the DBSignalDBAtom foreign key attribute

Parameters:

l - DBSignalDBAtom

Throws:

org.apache.torque.TorqueException

getDBSignalDBAtoms

public java.util.List getDBSignalDBAtoms()
                                  throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getDBSignalDBAtoms(new Criteria())

Throws:

org.apache.torque.TorqueException

getDBSignalDBAtoms

public java.util.List getDBSignalDBAtoms(org.apache.torque.util.Criteria criteria)
                                  throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DBSignal has previously been saved, it will retrieve related DBSignalDBAtoms from storage. If this DBSignal is new, it will return an empty collection or the current collection, the criteria is ignored on a new object.

Throws:

org.apache.torque.TorqueException

getDBSignalDBAtoms

public java.util.List getDBSignalDBAtoms(java.sql.Connection con)
                                  throws org.apache.torque.TorqueException

If this collection has already been initialized, returns the collection. Otherwise returns the results of getDBSignalDBAtoms(new Criteria(),Connection) This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getDBSignalDBAtoms

public java.util.List getDBSignalDBAtoms(org.apache.torque.util.Criteria criteria,
                                         java.sql.Connection con)
                                  throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DBSignal has previously been saved, it will retrieve related DBSignalDBAtoms from storage. If this DBSignal is new, it will return an empty collection or the current collection, the criteria is ignored on a new object. This method takes in the Connection also as input so that referenced objects can also be obtained using a Connection that is taken as input

Throws:

org.apache.torque.TorqueException

getDBSignalDBAtomsJoinDBSignal

protected java.util.List getDBSignalDBAtomsJoinDBSignal(org.apache.torque.util.Criteria criteria)
                                                 throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DBSignal is new, it will return an empty collection; or if this DBSignal has previously been saved, it will retrieve related DBSignalDBAtoms from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DBSignal.

Throws:

org.apache.torque.TorqueException

getDBSignalDBAtomsJoinDBAtom

protected java.util.List getDBSignalDBAtomsJoinDBAtom(org.apache.torque.util.Criteria criteria)
                                               throws org.apache.torque.TorqueException

If this collection has already been initialized with an identical criteria, it returns the collection. Otherwise if this DBSignal is new, it will return an empty collection; or if this DBSignal has previously been saved, it will retrieve related DBSignalDBAtoms from storage. This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in DBSignal.

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 using ObjectKey.

Specified by:

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

Overrides:

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

Parameters:

signalId - ObjectKey

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

Parameters:

key -

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

Throws:

org.apache.torque.TorqueException

getPeer

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