org.openscience.nmrshiftdb.om
Class BaseDBSample

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBSample

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

This class was autogenerated by Torque on: [Thu Dec 07 14:43:53 CET 2006] You should not use this class directly. It should not even be extended all references should be to DBSample

See Also:

Serialized Form

Field Summary

private DBCondition	aDBCondition
private DBMachine	aDBMachine
private DBMolecule	aDBMolecule
private boolean	alreadyInSave flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.
private NmrshiftdbUser	aNmrshiftdbUser
private byte[]	attachment The value for the attachment field
private java.lang.String	attachmentName The value for the attachmentName field
protected java.util.List	collDBRawFiles Collection to store aggregation of collDBRawFiles
private java.util.Date	date The value for the date field
private static java.util.List	fieldNames
private java.lang.String	finished The value for the finished field
private org.apache.torque.util.Criteria	lastDBRawFilesCriteria The criteria used to select the current contents of collDBRawFiles
private int	machine The value for the machine field
private java.lang.String	otherNuclei The value for the otherNuclei field
private java.lang.String	otherWishedSpectrum The value for the otherWishedSpectrum field
private static DBSamplePeer	peer The Peer class
private int	probableStructure The value for the probableStructure field
private java.lang.String	process The value for the process field
private int	sampleId The value for the sampleId field
private int	solvent The value for the solvent field
private java.lang.String	specialCare The value for the specialCare field
private int	userId The value for the userId field
private java.lang.String	usersId The value for the usersId field
private java.lang.String	usersIdComment The value for the usersIdComment field
private java.lang.String	wishedSpectrum The value for the wishedSpectrum field

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

NEW_ID

Constructor Summary

BaseDBSample()

Method Summary

void	addDBRawFile(DBRawFile l) Method called to associate a DBRawFile object to this object through the DBRawFile foreign key attribute
DBSample	copy() Makes a copy of this object.
protected DBSample	copyInto(DBSample copyObj)
byte[]	getAttachment() Get the Attachment
java.lang.String	getAttachmentName() Get the AttachmentName
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.Date	getDate() Get the Date
DBCondition	getDBCondition() Get the associated DBCondition object
DBMachine	getDBMachine() Get the associated DBMachine object
DBMolecule	getDBMolecule() Get the associated DBMolecule object
java.util.List	getDBRawFiles() If this collection has already been initialized, returns the collection.
java.util.List	getDBRawFiles(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBRawFiles(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBRawFiles(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	getDBRawFilesJoinDBSample(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
static java.util.List	getFieldNames() Generate a list of field names.
java.lang.String	getFinished() Get the Finished
int	getMachine() Get the Machine
NmrshiftdbUser	getNmrshiftdbUser() Get the associated NmrshiftdbUser object
java.lang.String	getOtherNuclei() Get the OtherNuclei
java.lang.String	getOtherWishedSpectrum() Get the OtherWishedSpectrum
DBSamplePeer	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	getProbableStructure() Get the ProbableStructure
java.lang.String	getProcess() Get the Process
int	getSampleId() Get the SampleId
int	getSolvent() Get the Solvent
java.lang.String	getSpecialCare() Get the SpecialCare
int	getUserId() Get the UserId
java.lang.String	getUsersId() Get the UsersId
java.lang.String	getUsersIdComment() Get the UsersIdComment
java.lang.String	getWishedSpectrum() Get the WishedSpectrum
protected void	initDBRawFiles() Temporary storage of collDBRawFiles 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	setAttachment(byte[] v) Set the value of Attachment
void	setAttachmentName(java.lang.String v) Set the value of AttachmentName
void	setDate(java.util.Date v) Set the value of Date
void	setDBCondition(DBCondition v) Declares an association between this object and a DBCondition object
void	setDBConditionKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setDBMachine(DBMachine v) Declares an association between this object and a DBMachine object
void	setDBMachineKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setDBMolecule(DBMolecule v) Declares an association between this object and a DBMolecule object
void	setDBMoleculeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setFinished(java.lang.String v) Set the value of Finished
void	setMachine(int v) Set the value of Machine
void	setNmrshiftdbUser(NmrshiftdbUser v) Declares an association between this object and a NmrshiftdbUser object
void	setNmrshiftdbUserKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setOtherNuclei(java.lang.String v) Set the value of OtherNuclei
void	setOtherWishedSpectrum(java.lang.String v) Set the value of OtherWishedSpectrum
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	setProbableStructure(int v) Set the value of ProbableStructure
void	setProcess(java.lang.String v) Set the value of Process
void	setSampleId(int v) Set the value of SampleId
void	setSolvent(int v) Set the value of Solvent
void	setSpecialCare(java.lang.String v) Set the value of SpecialCare
void	setUserId(int v) Set the value of UserId
void	setUsersId(java.lang.String v) Set the value of UsersId
void	setUsersIdComment(java.lang.String v) Set the value of UsersIdComment
void	setWishedSpectrum(java.lang.String v) Set the value of WishedSpectrum
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 DBSamplePeer peer

The Peer class

sampleId

private int sampleId

The value for the sampleId field

usersId

private java.lang.String usersId

The value for the usersId field

usersIdComment

private java.lang.String usersIdComment

The value for the usersIdComment field

userId

private int userId

The value for the userId field

solvent

private int solvent

The value for the solvent field

machine

private int machine

The value for the machine field

probableStructure

private int probableStructure

The value for the probableStructure field

date

private java.util.Date date

The value for the date field

otherNuclei

private java.lang.String otherNuclei

The value for the otherNuclei field

specialCare

private java.lang.String specialCare

The value for the specialCare field

wishedSpectrum

private java.lang.String wishedSpectrum

The value for the wishedSpectrum field

otherWishedSpectrum

private java.lang.String otherWishedSpectrum

The value for the otherWishedSpectrum field

finished

private java.lang.String finished

The value for the finished field

process

private java.lang.String process

The value for the process field

attachment

private byte[] attachment

The value for the attachment field

attachmentName

private java.lang.String attachmentName

The value for the attachmentName field

aNmrshiftdbUser

private NmrshiftdbUser aNmrshiftdbUser

aDBCondition

private DBCondition aDBCondition

aDBMachine

private DBMachine aDBMachine

aDBMolecule

private DBMolecule aDBMolecule

collDBRawFiles

protected java.util.List collDBRawFiles

Collection to store aggregation of collDBRawFiles

lastDBRawFilesCriteria

private org.apache.torque.util.Criteria lastDBRawFilesCriteria

The criteria used to select the current contents of collDBRawFiles

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

BaseDBSample

public BaseDBSample()

Method Detail

getSampleId

public int getSampleId()

Get the SampleId

Returns:

int

setSampleId

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

Set the value of SampleId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getUsersId

public java.lang.String getUsersId()

Get the UsersId

Returns:

String

setUsersId

public void setUsersId(java.lang.String v)

Set the value of UsersId

Parameters:

v - new value

getUsersIdComment

public java.lang.String getUsersIdComment()

Get the UsersIdComment

Returns:

String

setUsersIdComment

public void setUsersIdComment(java.lang.String v)

Set the value of UsersIdComment

Parameters:

v - new value

getUserId

public int getUserId()

Get the UserId

Returns:

int

setUserId

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

Set the value of UserId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getSolvent

public int getSolvent()

Get the Solvent

Returns:

int

setSolvent

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

Set the value of Solvent

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getMachine

public int getMachine()

Get the Machine

Returns:

int

setMachine

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

Set the value of Machine

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getProbableStructure

public int getProbableStructure()

Get the ProbableStructure

Returns:

int

setProbableStructure

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

Set the value of ProbableStructure

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getDate

public java.util.Date getDate()

Get the Date

Returns:

Date

setDate

public void setDate(java.util.Date v)

Set the value of Date

Parameters:

v - new value

getOtherNuclei

public java.lang.String getOtherNuclei()

Get the OtherNuclei

Returns:

String

setOtherNuclei

public void setOtherNuclei(java.lang.String v)

Set the value of OtherNuclei

Parameters:

v - new value

getSpecialCare

public java.lang.String getSpecialCare()

Get the SpecialCare

Returns:

String

setSpecialCare

public void setSpecialCare(java.lang.String v)

Set the value of SpecialCare

Parameters:

v - new value

getWishedSpectrum

public java.lang.String getWishedSpectrum()

Get the WishedSpectrum

Returns:

String

setWishedSpectrum

public void setWishedSpectrum(java.lang.String v)

Set the value of WishedSpectrum

Parameters:

v - new value

getOtherWishedSpectrum

public java.lang.String getOtherWishedSpectrum()

Get the OtherWishedSpectrum

Returns:

String

setOtherWishedSpectrum

public void setOtherWishedSpectrum(java.lang.String v)

Set the value of OtherWishedSpectrum

Parameters:

v - new value

getFinished

public java.lang.String getFinished()

Get the Finished

Returns:

String

setFinished

public void setFinished(java.lang.String v)

Set the value of Finished

Parameters:

v - new value

getProcess

public java.lang.String getProcess()

Get the Process

Returns:

String

setProcess

public void setProcess(java.lang.String v)

Set the value of Process

Parameters:

v - new value

getAttachment

public byte[] getAttachment()

Get the Attachment

Returns:

byte[]

setAttachment

public void setAttachment(byte[] v)

Set the value of Attachment

Parameters:

v - new value

getAttachmentName

public java.lang.String getAttachmentName()

Get the AttachmentName

Returns:

String

setAttachmentName

public void setAttachmentName(java.lang.String v)

Set the value of AttachmentName

Parameters:

v - new value

setNmrshiftdbUser

public void setNmrshiftdbUser(NmrshiftdbUser v)
                       throws org.apache.torque.TorqueException

Declares an association between this object and a NmrshiftdbUser object

Parameters:

v - NmrshiftdbUser

Throws:

org.apache.torque.TorqueException

getNmrshiftdbUser

public NmrshiftdbUser getNmrshiftdbUser()
                                 throws org.apache.torque.TorqueException

Get the associated NmrshiftdbUser object

Returns:

the associated NmrshiftdbUser object

Throws:

org.apache.torque.TorqueException

setNmrshiftdbUserKey

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

setDBCondition

public void setDBCondition(DBCondition v)
                    throws org.apache.torque.TorqueException

Declares an association between this object and a DBCondition object

Parameters:

v - DBCondition

Throws:

org.apache.torque.TorqueException

getDBCondition

public DBCondition getDBCondition()
                           throws org.apache.torque.TorqueException

Get the associated DBCondition object

Returns:

the associated DBCondition object

Throws:

org.apache.torque.TorqueException

setDBConditionKey

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

setDBMachine

public void setDBMachine(DBMachine v)
                  throws org.apache.torque.TorqueException

Declares an association between this object and a DBMachine object

Parameters:

v - DBMachine

Throws:

org.apache.torque.TorqueException

getDBMachine

public DBMachine getDBMachine()
                       throws org.apache.torque.TorqueException

Get the associated DBMachine object

Returns:

the associated DBMachine object

Throws:

org.apache.torque.TorqueException

setDBMachineKey

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

setDBMolecule

public void setDBMolecule(DBMolecule v)
                   throws org.apache.torque.TorqueException

Declares an association between this object and a DBMolecule object

Parameters:

v - DBMolecule

Throws:

org.apache.torque.TorqueException

getDBMolecule

public DBMolecule getDBMolecule()
                         throws org.apache.torque.TorqueException

Get the associated DBMolecule object

Returns:

the associated DBMolecule object

Throws:

org.apache.torque.TorqueException

setDBMoleculeKey

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

initDBRawFiles

protected void initDBRawFiles()

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

addDBRawFile

public void addDBRawFile(DBRawFile l)
                  throws org.apache.torque.TorqueException

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

Parameters:

l - DBRawFile

Throws:

org.apache.torque.TorqueException

getDBRawFiles

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

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

Throws:

org.apache.torque.TorqueException

getDBRawFiles

public java.util.List getDBRawFiles(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 DBSample has previously been saved, it will retrieve related DBRawFiles from storage. If this DBSample 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

getDBRawFiles

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

If this collection has already been initialized, returns the collection. Otherwise returns the results of getDBRawFiles(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

getDBRawFiles

public java.util.List getDBRawFiles(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 DBSample has previously been saved, it will retrieve related DBRawFiles from storage. If this DBSample 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

getDBRawFilesJoinDBSample

protected java.util.List getDBRawFilesJoinDBSample(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 DBSample is new, it will return an empty collection; or if this DBSample has previously been saved, it will retrieve related DBRawFiles 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 DBSample.

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:

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

Throws:

org.apache.torque.TorqueException

getPeer

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