org.openscience.nmrshiftdb.om
Class BaseDBCanonicalName

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBCanonicalName

public abstract class BaseDBCanonicalName
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 DBCanonicalName

See Also:

Serialized Form

Field Summary

private DBCanonicalNameType	aDBCanonicalNameType
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 int	canonicalNameTypeId The value for the canonicalNameTypeId field
private org.apache.torque.om.ComboKey	comboPK
private static java.util.List	fieldNames
private int	moleculeId The value for the moleculeId field
private java.lang.String	name The value for the name field
private java.lang.String	nameSoundex The value for the nameSoundex field
private static DBCanonicalNamePeer	peer The Peer class
private org.apache.torque.om.SimpleKey[]	pks

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

NEW_ID

Constructor Summary

BaseDBCanonicalName()

Method Summary

DBCanonicalName	copy() Makes a copy of this object.
protected DBCanonicalName	copyInto(DBCanonicalName 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.
int	getCanonicalNameTypeId() Get the CanonicalNameTypeId
DBCanonicalNameType	getDBCanonicalNameType() Get the associated DBCanonicalNameType object
DBMolecule	getDBMolecule() Get the associated DBMolecule object
static java.util.List	getFieldNames() Generate a list of field names.
int	getMoleculeId() Get the MoleculeId
java.lang.String	getName() Get the Name
java.lang.String	getNameSoundex() Get the NameSoundex
DBCanonicalNamePeer	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.
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	setCanonicalNameTypeId(int v) Set the value of CanonicalNameTypeId
void	setDBCanonicalNameType(DBCanonicalNameType v) Declares an association between this object and a DBCanonicalNameType object
void	setDBCanonicalNameTypeKey(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	setMoleculeId(int v) Set the value of MoleculeId
void	setName(java.lang.String v) Set the value of Name
void	setNameSoundex(java.lang.String v) Set the value of NameSoundex
void	setPrimaryKey(int moleculeId, int canonicalNameTypeId) 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.
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 DBCanonicalNamePeer peer

The Peer class

moleculeId

private int moleculeId

The value for the moleculeId field

canonicalNameTypeId

private int canonicalNameTypeId

The value for the canonicalNameTypeId field

name

private java.lang.String name

The value for the name field

nameSoundex

private java.lang.String nameSoundex

The value for the nameSoundex field

aDBMolecule

private DBMolecule aDBMolecule

aDBCanonicalNameType

private DBCanonicalNameType aDBCanonicalNameType

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

BaseDBCanonicalName

public BaseDBCanonicalName()

Method Detail

getMoleculeId

public int getMoleculeId()

Get the MoleculeId

Returns:

int

setMoleculeId

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

Set the value of MoleculeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

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

getName

public java.lang.String getName()

Get the Name

Returns:

String

setName

public void setName(java.lang.String v)

Set the value of Name

Parameters:

v - new value

getNameSoundex

public java.lang.String getNameSoundex()

Get the NameSoundex

Returns:

String

setNameSoundex

public void setNameSoundex(java.lang.String v)

Set the value of NameSoundex

Parameters:

v - new value

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

setDBCanonicalNameType

public void setDBCanonicalNameType(DBCanonicalNameType v)
                            throws org.apache.torque.TorqueException

Declares an association between this object and a DBCanonicalNameType object

Parameters:

v - DBCanonicalNameType

Throws:

org.apache.torque.TorqueException

getDBCanonicalNameType

public DBCanonicalNameType getDBCanonicalNameType()
                                           throws org.apache.torque.TorqueException

Get the associated DBCanonicalNameType object

Returns:

the associated DBCanonicalNameType object

Throws:

org.apache.torque.TorqueException

setDBCanonicalNameTypeKey

public void setDBCanonicalNameTypeKey(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 moleculeId,
                          int canonicalNameTypeId)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

int - moleculeId

int - canonicalNameTypeId

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

Throws:

org.apache.torque.TorqueException

getPeer

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