org.openscience.nmrshiftdb.om
Class BaseDBAuthor

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBAuthor

public abstract class BaseDBAuthor
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 DBAuthor

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 int	authorId The value for the authorId field
protected java.util.List	collIsAuthors Collection to store aggregation of collIsAuthors
protected java.util.List	collIsEditors Collection to store aggregation of collIsEditors
private static java.util.List	fieldNames
private org.apache.torque.util.Criteria	lastIsAuthorsCriteria The criteria used to select the current contents of collIsAuthors
private org.apache.torque.util.Criteria	lastIsEditorsCriteria The criteria used to select the current contents of collIsEditors
private java.lang.String	name The value for the name field
private java.lang.String	nameTotal The value for the nameTotal field
private java.lang.String	nameTotalSoundex The value for the nameTotalSoundex field
private static DBAuthorPeer	peer The Peer class
private java.lang.String	surname The value for the surname field

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

NEW_ID

Constructor Summary

BaseDBAuthor()

Method Summary

void	addIsAuthor(IsAuthor l) Method called to associate a IsAuthor object to this object through the IsAuthor foreign key attribute
void	addIsEditor(IsEditor l) Method called to associate a IsEditor object to this object through the IsEditor foreign key attribute
DBAuthor	copy() Makes a copy of this object.
protected DBAuthor	copyInto(DBAuthor copyObj)
int	getAuthorId() Get the AuthorId
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.
static java.util.List	getFieldNames() Generate a list of field names.
java.util.List	getIsAuthors() If this collection has already been initialized, returns the collection.
java.util.List	getIsAuthors(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getIsAuthors(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getIsAuthors(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	getIsAuthorsJoinDBAuthor(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	getIsAuthorsJoinDBLiterature(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getIsEditors() If this collection has already been initialized, returns the collection.
java.util.List	getIsEditors(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getIsEditors(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getIsEditors(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	getIsEditorsJoinDBAuthor(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	getIsEditorsJoinDBLiterature(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.lang.String	getName() Get the Name
java.lang.String	getNameTotal() Get the NameTotal
java.lang.String	getNameTotalSoundex() Get the NameTotalSoundex
DBAuthorPeer	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.
java.lang.String	getSurname() Get the Surname
protected void	initIsAuthors() Temporary storage of collIsAuthors to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initIsEditors() Temporary storage of collIsEditors 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	setAuthorId(int v) Set the value of AuthorId
void	setName(java.lang.String v) Set the value of Name
void	setNameTotal(java.lang.String v) Set the value of NameTotal
void	setNameTotalSoundex(java.lang.String v) Set the value of NameTotalSoundex
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	setSurname(java.lang.String v) Set the value of Surname
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 DBAuthorPeer peer

The Peer class

authorId

private int authorId

The value for the authorId field

surname

private java.lang.String surname

The value for the surname field

name

private java.lang.String name

The value for the name field

nameTotalSoundex

private java.lang.String nameTotalSoundex

The value for the nameTotalSoundex field

nameTotal

private java.lang.String nameTotal

The value for the nameTotal field

collIsEditors

protected java.util.List collIsEditors

Collection to store aggregation of collIsEditors

lastIsEditorsCriteria

private org.apache.torque.util.Criteria lastIsEditorsCriteria

The criteria used to select the current contents of collIsEditors

collIsAuthors

protected java.util.List collIsAuthors

Collection to store aggregation of collIsAuthors

lastIsAuthorsCriteria

private org.apache.torque.util.Criteria lastIsAuthorsCriteria

The criteria used to select the current contents of collIsAuthors

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

BaseDBAuthor

public BaseDBAuthor()

Method Detail

getAuthorId

public int getAuthorId()

Get the AuthorId

Returns:

int

setAuthorId

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

Set the value of AuthorId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getSurname

public java.lang.String getSurname()

Get the Surname

Returns:

String

setSurname

public void setSurname(java.lang.String v)

Set the value of Surname

Parameters:

v - new value

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

getNameTotalSoundex

public java.lang.String getNameTotalSoundex()

Get the NameTotalSoundex

Returns:

String

setNameTotalSoundex

public void setNameTotalSoundex(java.lang.String v)

Set the value of NameTotalSoundex

Parameters:

v - new value

getNameTotal

public java.lang.String getNameTotal()

Get the NameTotal

Returns:

String

setNameTotal

public void setNameTotal(java.lang.String v)

Set the value of NameTotal

Parameters:

v - new value

initIsEditors

protected void initIsEditors()

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

addIsEditor

public void addIsEditor(IsEditor l)
                 throws org.apache.torque.TorqueException

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

Parameters:

l - IsEditor

Throws:

org.apache.torque.TorqueException

getIsEditors

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

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

Throws:

org.apache.torque.TorqueException

getIsEditors

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

getIsEditors

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

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

getIsEditors

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

getIsEditorsJoinDBAuthor

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

Throws:

org.apache.torque.TorqueException

getIsEditorsJoinDBLiterature

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

Throws:

org.apache.torque.TorqueException

initIsAuthors

protected void initIsAuthors()

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

addIsAuthor

public void addIsAuthor(IsAuthor l)
                 throws org.apache.torque.TorqueException

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

Parameters:

l - IsAuthor

Throws:

org.apache.torque.TorqueException

getIsAuthors

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

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

Throws:

org.apache.torque.TorqueException

getIsAuthors

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

getIsAuthors

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

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

getIsAuthors

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

getIsAuthorsJoinDBAuthor

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

Throws:

org.apache.torque.TorqueException

getIsAuthorsJoinDBLiterature

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

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:

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

Throws:

org.apache.torque.TorqueException

getPeer

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