org.openscience.nmrshiftdb.om
Class BaseDBJournalVolume

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBJournalVolume

public abstract class BaseDBJournalVolume
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 DBJournalVolume

See Also:

Serialized Form

Field Summary

private DBJournal	aDBJournal
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	collDBArticles Collection to store aggregation of collDBArticles
private static java.util.List	fieldNames
private int	journalId The value for the journalId field
private int	journalVolumeId The value for the journalVolumeId field
private org.apache.torque.util.Criteria	lastDBArticlesCriteria The criteria used to select the current contents of collDBArticles
private static DBJournalVolumePeer	peer The Peer class
private int	volume The value for the volume field
private int	year The value for the year field

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

NEW_ID

Constructor Summary

BaseDBJournalVolume()

Method Summary

void	addDBArticle(DBArticle l) Method called to associate a DBArticle object to this object through the DBArticle foreign key attribute
DBJournalVolume	copy() Makes a copy of this object.
protected DBJournalVolume	copyInto(DBJournalVolume 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	getDBArticles() If this collection has already been initialized, returns the collection.
java.util.List	getDBArticles(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getDBArticles(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getDBArticles(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	getDBArticlesJoinDBJournalVolume(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	getDBArticlesJoinDBLiteratureRelatedByLiteratureId(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	getDBArticlesJoinDBLiteratureRelatedByPublishedInBook(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
DBJournal	getDBJournal() Get the associated DBJournal object
static java.util.List	getFieldNames() Generate a list of field names.
int	getJournalId() Get the JournalId
int	getJournalVolumeId() Get the JournalVolumeId
DBJournalVolumePeer	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.
int	getVolume() Get the Volume
int	getYear() Get the Year
protected void	initDBArticles() Temporary storage of collDBArticles 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	setDBJournal(DBJournal v) Declares an association between this object and a DBJournal object
void	setDBJournalKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setJournalId(int v) Set the value of JournalId
void	setJournalVolumeId(int v) Set the value of JournalVolumeId
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	setVolume(int v) Set the value of Volume
void	setYear(int v) Set the value of Year
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 DBJournalVolumePeer peer

The Peer class

journalVolumeId

private int journalVolumeId

The value for the journalVolumeId field

volume

private int volume

The value for the volume field

year

private int year

The value for the year field

journalId

private int journalId

The value for the journalId field

aDBJournal

private DBJournal aDBJournal

collDBArticles

protected java.util.List collDBArticles

Collection to store aggregation of collDBArticles

lastDBArticlesCriteria

private org.apache.torque.util.Criteria lastDBArticlesCriteria

The criteria used to select the current contents of collDBArticles

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

BaseDBJournalVolume

public BaseDBJournalVolume()

Method Detail

getJournalVolumeId

public int getJournalVolumeId()

Get the JournalVolumeId

Returns:

int

setJournalVolumeId

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

Set the value of JournalVolumeId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getVolume

public int getVolume()

Get the Volume

Returns:

int

setVolume

public void setVolume(int v)

Set the value of Volume

Parameters:

v - new value

getYear

public int getYear()

Get the Year

Returns:

int

setYear

public void setYear(int v)

Set the value of Year

Parameters:

v - new value

getJournalId

public int getJournalId()

Get the JournalId

Returns:

int

setJournalId

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

Set the value of JournalId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

setDBJournal

public void setDBJournal(DBJournal v)
                  throws org.apache.torque.TorqueException

Declares an association between this object and a DBJournal object

Parameters:

v - DBJournal

Throws:

org.apache.torque.TorqueException

getDBJournal

public DBJournal getDBJournal()
                       throws org.apache.torque.TorqueException

Get the associated DBJournal object

Returns:

the associated DBJournal object

Throws:

org.apache.torque.TorqueException

setDBJournalKey

public void setDBJournalKey(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

initDBArticles

protected void initDBArticles()

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

addDBArticle

public void addDBArticle(DBArticle l)
                  throws org.apache.torque.TorqueException

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

Parameters:

l - DBArticle

Throws:

org.apache.torque.TorqueException

getDBArticles

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

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

Throws:

org.apache.torque.TorqueException

getDBArticles

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

getDBArticles

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

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

getDBArticles

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

getDBArticlesJoinDBLiteratureRelatedByLiteratureId

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

Throws:

org.apache.torque.TorqueException

getDBArticlesJoinDBLiteratureRelatedByPublishedInBook

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

Throws:

org.apache.torque.TorqueException

getDBArticlesJoinDBJournalVolume

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

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:

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

Throws:

org.apache.torque.TorqueException

getPeer

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