org.openscience.nmrshiftdb.om
Class BaseDBKeyword

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBKeyword

public abstract class BaseDBKeyword
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 DBKeyword

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.
protected java.util.List	collDBMoleculeDBKeywords Collection to store aggregation of collDBMoleculeDBKeywords
protected java.util.List	collDBSpectrumDBKeywords Collection to store aggregation of collDBSpectrumDBKeywords
private static java.util.List	fieldNames
private java.lang.String	keyword The value for the keyword field
private int	keywordId The value for the keywordId field
private java.lang.String	keywordSoundex The value for the keywordSoundex field
private org.apache.torque.util.Criteria	lastDBMoleculeDBKeywordsCriteria The criteria used to select the current contents of collDBMoleculeDBKeywords
private org.apache.torque.util.Criteria	lastDBSpectrumDBKeywordsCriteria The criteria used to select the current contents of collDBSpectrumDBKeywords
private static DBKeywordPeer	peer The Peer class

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

NEW_ID

Constructor Summary

BaseDBKeyword()

Method Summary

void	addDBMoleculeDBKeyword(DBMoleculeDBKeyword l) Method called to associate a DBMoleculeDBKeyword object to this object through the DBMoleculeDBKeyword foreign key attribute
void	addDBSpectrumDBKeyword(DBSpectrumDBKeyword l) Method called to associate a DBSpectrumDBKeyword object to this object through the DBSpectrumDBKeyword foreign key attribute
DBKeyword	copy() Makes a copy of this object.
protected DBKeyword	copyInto(DBKeyword 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	getDBMoleculeDBKeywords() If this collection has already been initialized, returns the collection.
java.util.List	getDBMoleculeDBKeywords(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBMoleculeDBKeywords(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBMoleculeDBKeywords(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	getDBMoleculeDBKeywordsJoinDBKeyword(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	getDBMoleculeDBKeywordsJoinDBMolecule(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBSpectrumDBKeywords() If this collection has already been initialized, returns the collection.
java.util.List	getDBSpectrumDBKeywords(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBSpectrumDBKeywords(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBSpectrumDBKeywords(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	getDBSpectrumDBKeywordsJoinDBKeyword(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	getDBSpectrumDBKeywordsJoinDBSpectrum(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	getKeyword() Get the Keyword
int	getKeywordId() Get the KeywordId
java.lang.String	getKeywordSoundex() Get the KeywordSoundex
DBKeywordPeer	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	initDBMoleculeDBKeywords() Temporary storage of collDBMoleculeDBKeywords to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initDBSpectrumDBKeywords() Temporary storage of collDBSpectrumDBKeywords 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	setKeyword(java.lang.String v) Set the value of Keyword
void	setKeywordId(int v) Set the value of KeywordId
void	setKeywordSoundex(java.lang.String v) Set the value of KeywordSoundex
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 DBKeywordPeer peer

The Peer class

keywordId

private int keywordId

The value for the keywordId field

keyword

private java.lang.String keyword

The value for the keyword field

keywordSoundex

private java.lang.String keywordSoundex

The value for the keywordSoundex field

collDBMoleculeDBKeywords

protected java.util.List collDBMoleculeDBKeywords

Collection to store aggregation of collDBMoleculeDBKeywords

lastDBMoleculeDBKeywordsCriteria

private org.apache.torque.util.Criteria lastDBMoleculeDBKeywordsCriteria

The criteria used to select the current contents of collDBMoleculeDBKeywords

collDBSpectrumDBKeywords

protected java.util.List collDBSpectrumDBKeywords

Collection to store aggregation of collDBSpectrumDBKeywords

lastDBSpectrumDBKeywordsCriteria

private org.apache.torque.util.Criteria lastDBSpectrumDBKeywordsCriteria

The criteria used to select the current contents of collDBSpectrumDBKeywords

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

BaseDBKeyword

public BaseDBKeyword()

Method Detail

getKeywordId

public int getKeywordId()

Get the KeywordId

Returns:

int

setKeywordId

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

Set the value of KeywordId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getKeyword

public java.lang.String getKeyword()

Get the Keyword

Returns:

String

setKeyword

public void setKeyword(java.lang.String v)

Set the value of Keyword

Parameters:

v - new value

getKeywordSoundex

public java.lang.String getKeywordSoundex()

Get the KeywordSoundex

Returns:

String

setKeywordSoundex

public void setKeywordSoundex(java.lang.String v)

Set the value of KeywordSoundex

Parameters:

v - new value

initDBMoleculeDBKeywords

protected void initDBMoleculeDBKeywords()

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

addDBMoleculeDBKeyword

public void addDBMoleculeDBKeyword(DBMoleculeDBKeyword l)
                            throws org.apache.torque.TorqueException

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

Parameters:

l - DBMoleculeDBKeyword

Throws:

org.apache.torque.TorqueException

getDBMoleculeDBKeywords

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

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

Throws:

org.apache.torque.TorqueException

getDBMoleculeDBKeywords

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

getDBMoleculeDBKeywords

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

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

getDBMoleculeDBKeywords

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

getDBMoleculeDBKeywordsJoinDBMolecule

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

Throws:

org.apache.torque.TorqueException

getDBMoleculeDBKeywordsJoinDBKeyword

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

Throws:

org.apache.torque.TorqueException

initDBSpectrumDBKeywords

protected void initDBSpectrumDBKeywords()

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

addDBSpectrumDBKeyword

public void addDBSpectrumDBKeyword(DBSpectrumDBKeyword l)
                            throws org.apache.torque.TorqueException

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

Parameters:

l - DBSpectrumDBKeyword

Throws:

org.apache.torque.TorqueException

getDBSpectrumDBKeywords

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

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

Throws:

org.apache.torque.TorqueException

getDBSpectrumDBKeywords

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

getDBSpectrumDBKeywords

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

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

getDBSpectrumDBKeywords

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

getDBSpectrumDBKeywordsJoinDBSpectrum

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

Throws:

org.apache.torque.TorqueException

getDBSpectrumDBKeywordsJoinDBKeyword

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

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:

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

Throws:

org.apache.torque.TorqueException

getPeer

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