org.openscience.nmrshiftdb.om
Class BaseDBLabGroup

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBLabGroup

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

This class was autogenerated by Torque on: [Mon Jan 08 17:32:19 CET 2007] You should not use this class directly. It should not even be extended all references should be to DBLabGroup

See Also:

Serialized Form

Field Summary

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
protected java.util.List	collDBMachines Collection to store aggregation of collDBMachines
private static java.util.List	fieldNames
private int	labgroupId The value for the labgroupId field
private java.lang.String	labgroupName The value for the labgroupName field
private org.apache.torque.util.Criteria	lastDBMachinesCriteria The criteria used to select the current contents of collDBMachines
private int	leader The value for the leader field
private static DBLabGroupPeer	peer The Peer class

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

NEW_ID

Constructor Summary

BaseDBLabGroup()

Method Summary

void	addDBMachine(DBMachine l) Method called to associate a DBMachine object to this object through the DBMachine foreign key attribute
DBLabGroup	copy() Makes a copy of this object.
protected DBLabGroup	copyInto(DBLabGroup 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	getDBMachines() If this collection has already been initialized, returns the collection.
java.util.List	getDBMachines(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBMachines(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBMachines(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	getDBMachinesJoinDBCondition(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	getDBMachinesJoinDBLabGroup(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.
int	getLabgroupId() Get the LabgroupId
java.lang.String	getLabgroupName() Get the LabgroupName
int	getLeader() Get the Leader
NmrshiftdbUser	getNmrshiftdbUser() Get the associated NmrshiftdbUser object
DBLabGroupPeer	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.
protected void	initDBMachines() Temporary storage of collDBMachines 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	setLabgroupId(int v) Set the value of LabgroupId
void	setLabgroupName(java.lang.String v) Set the value of LabgroupName
void	setLeader(int v) Set the value of Leader
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	setPrimaryKey(org.apache.torque.om.ObjectKey key) Set the PrimaryKey using ObjectKey.
void	setPrimaryKey(java.lang.String key) Set the PrimaryKey using a String.
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 DBLabGroupPeer peer

The Peer class

labgroupId

private int labgroupId

The value for the labgroupId field

labgroupName

private java.lang.String labgroupName

The value for the labgroupName field

leader

private int leader

The value for the leader field

aNmrshiftdbUser

private NmrshiftdbUser aNmrshiftdbUser

collDBMachines

protected java.util.List collDBMachines

Collection to store aggregation of collDBMachines

lastDBMachinesCriteria

private org.apache.torque.util.Criteria lastDBMachinesCriteria

The criteria used to select the current contents of collDBMachines

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

BaseDBLabGroup

public BaseDBLabGroup()

Method Detail

getLabgroupId

public int getLabgroupId()

Get the LabgroupId

Returns:

int

setLabgroupId

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

Set the value of LabgroupId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getLabgroupName

public java.lang.String getLabgroupName()

Get the LabgroupName

Returns:

String

setLabgroupName

public void setLabgroupName(java.lang.String v)

Set the value of LabgroupName

Parameters:

v - new value

getLeader

public int getLeader()

Get the Leader

Returns:

int

setLeader

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

Set the value of Leader

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

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

initDBMachines

protected void initDBMachines()

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

addDBMachine

public void addDBMachine(DBMachine l)
                  throws org.apache.torque.TorqueException

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

Parameters:

l - DBMachine

Throws:

org.apache.torque.TorqueException

getDBMachines

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

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

Throws:

org.apache.torque.TorqueException

getDBMachines

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

getDBMachines

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

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

getDBMachines

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

getDBMachinesJoinDBCondition

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

Throws:

org.apache.torque.TorqueException

getDBMachinesJoinDBLabGroup

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

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:

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

Throws:

org.apache.torque.TorqueException

getPeer

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