org.openscience.nmrshiftdb.om
Class BaseDBCanonicalNameType

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBCanonicalNameType

public abstract class BaseDBCanonicalNameType
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 DBCanonicalNameType

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 java.lang.String	canonicalNameType The value for the canonicalNameType field
private int	canonicalNameTypeId The value for the canonicalNameTypeId field
protected java.util.List	collDBCanonicalNames Collection to store aggregation of collDBCanonicalNames
private static java.util.List	fieldNames
private org.apache.torque.util.Criteria	lastDBCanonicalNamesCriteria The criteria used to select the current contents of collDBCanonicalNames
private static DBCanonicalNameTypePeer	peer The Peer class

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

NEW_ID

Constructor Summary

BaseDBCanonicalNameType()

Method Summary

void	addDBCanonicalName(DBCanonicalName l) Method called to associate a DBCanonicalName object to this object through the DBCanonicalName foreign key attribute
DBCanonicalNameType	copy() Makes a copy of this object.
protected DBCanonicalNameType	copyInto(DBCanonicalNameType 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.lang.String	getCanonicalNameType() Get the CanonicalNameType
int	getCanonicalNameTypeId() Get the CanonicalNameTypeId
java.util.List	getDBCanonicalNames() If this collection has already been initialized, returns the collection.
java.util.List	getDBCanonicalNames(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBCanonicalNames(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBCanonicalNames(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	getDBCanonicalNamesJoinDBCanonicalNameType(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	getDBCanonicalNamesJoinDBMolecule(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.
DBCanonicalNameTypePeer	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	initDBCanonicalNames() Temporary storage of collDBCanonicalNames 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	setCanonicalNameType(java.lang.String v) Set the value of CanonicalNameType
void	setCanonicalNameTypeId(int v) Set the value of CanonicalNameTypeId
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 DBCanonicalNameTypePeer peer

The Peer class

canonicalNameTypeId

private int canonicalNameTypeId

The value for the canonicalNameTypeId field

canonicalNameType

private java.lang.String canonicalNameType

The value for the canonicalNameType field

collDBCanonicalNames

protected java.util.List collDBCanonicalNames

Collection to store aggregation of collDBCanonicalNames

lastDBCanonicalNamesCriteria

private org.apache.torque.util.Criteria lastDBCanonicalNamesCriteria

The criteria used to select the current contents of collDBCanonicalNames

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

BaseDBCanonicalNameType

public BaseDBCanonicalNameType()

Method Detail

getCanonicalNameTypeId

public int getCanonicalNameTypeId()

Get the CanonicalNameTypeId

Returns:

int

setCanonicalNameTypeId

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

Set the value of CanonicalNameTypeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getCanonicalNameType

public java.lang.String getCanonicalNameType()

Get the CanonicalNameType

Returns:

String

setCanonicalNameType

public void setCanonicalNameType(java.lang.String v)

Set the value of CanonicalNameType

Parameters:

v - new value

initDBCanonicalNames

protected void initDBCanonicalNames()

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

addDBCanonicalName

public void addDBCanonicalName(DBCanonicalName l)
                        throws org.apache.torque.TorqueException

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

Parameters:

l - DBCanonicalName

Throws:

org.apache.torque.TorqueException

getDBCanonicalNames

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

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

Throws:

org.apache.torque.TorqueException

getDBCanonicalNames

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

getDBCanonicalNames

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

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

getDBCanonicalNames

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

getDBCanonicalNamesJoinDBMolecule

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

Throws:

org.apache.torque.TorqueException

getDBCanonicalNamesJoinDBCanonicalNameType

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

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:

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

Throws:

org.apache.torque.TorqueException

getPeer

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