org.openscience.nmrshiftdb.om
Class BaseDBArticle

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DBArticle

public abstract class BaseDBArticle
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 DBArticle

See Also:

Serialized Form

Field Summary

private DBJournalVolume	aDBJournalVolume
private DBLiterature	aDBLiteratureRelatedByLiteratureId
private DBLiterature	aDBLiteratureRelatedByPublishedInBook
private boolean	alreadyInSave flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.
private static java.util.List	fieldNames
private int	issueNumber The value for the issueNumber field
private int	literatureId The value for the literatureId field
private int	pagesFrom The value for the pagesFrom field
private int	pagesTo The value for the pagesTo field
private static DBArticlePeer	peer The Peer class
private int	publishedInBook The value for the publishedInBook field
private int	publishedInJournal The value for the publishedInJournal field

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

NEW_ID

Constructor Summary

BaseDBArticle()

Method Summary

DBArticle	copy() Makes a copy of this object.
protected DBArticle	copyInto(DBArticle 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.
DBJournalVolume	getDBJournalVolume() Get the associated DBJournalVolume object
DBLiterature	getDBLiteratureRelatedByLiteratureId() Get the associated DBLiterature object
DBLiterature	getDBLiteratureRelatedByPublishedInBook() Get the associated DBLiterature object
static java.util.List	getFieldNames() Generate a list of field names.
int	getIssueNumber() Get the IssueNumber
int	getLiteratureId() Get the LiteratureId
int	getPagesFrom() Get the PagesFrom
int	getPagesTo() Get the PagesTo
DBArticlePeer	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	getPublishedInBook() Get the PublishedInBook
int	getPublishedInJournal() Get the PublishedInJournal
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	setDBJournalVolume(DBJournalVolume v) Declares an association between this object and a DBJournalVolume object
void	setDBJournalVolumeKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setDBLiteratureRelatedByLiteratureId(DBLiterature v) Declares an association between this object and a DBLiterature object
void	setDBLiteratureRelatedByLiteratureIdKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setDBLiteratureRelatedByPublishedInBook(DBLiterature v) Declares an association between this object and a DBLiterature object
void	setDBLiteratureRelatedByPublishedInBookKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey.
void	setIssueNumber(int v) Set the value of IssueNumber
void	setLiteratureId(int v) Set the value of LiteratureId
void	setPagesFrom(int v) Set the value of PagesFrom
void	setPagesTo(int v) Set the value of PagesTo
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	setPublishedInBook(int v) Set the value of PublishedInBook
void	setPublishedInJournal(int v) Set the value of PublishedInJournal
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 DBArticlePeer peer

The Peer class

literatureId

private int literatureId

The value for the literatureId field

pagesFrom

private int pagesFrom

The value for the pagesFrom field

pagesTo

private int pagesTo

The value for the pagesTo field

issueNumber

private int issueNumber

The value for the issueNumber field

publishedInBook

private int publishedInBook

The value for the publishedInBook field

publishedInJournal

private int publishedInJournal

The value for the publishedInJournal field

aDBLiteratureRelatedByLiteratureId

private DBLiterature aDBLiteratureRelatedByLiteratureId

aDBLiteratureRelatedByPublishedInBook

private DBLiterature aDBLiteratureRelatedByPublishedInBook

aDBJournalVolume

private DBJournalVolume aDBJournalVolume

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

BaseDBArticle

public BaseDBArticle()

Method Detail

getLiteratureId

public int getLiteratureId()

Get the LiteratureId

Returns:

int

setLiteratureId

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

Set the value of LiteratureId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getPagesFrom

public int getPagesFrom()

Get the PagesFrom

Returns:

int

setPagesFrom

public void setPagesFrom(int v)

Set the value of PagesFrom

Parameters:

v - new value

getPagesTo

public int getPagesTo()

Get the PagesTo

Returns:

int

setPagesTo

public void setPagesTo(int v)

Set the value of PagesTo

Parameters:

v - new value

getIssueNumber

public int getIssueNumber()

Get the IssueNumber

Returns:

int

setIssueNumber

public void setIssueNumber(int v)

Set the value of IssueNumber

Parameters:

v - new value

getPublishedInBook

public int getPublishedInBook()

Get the PublishedInBook

Returns:

int

setPublishedInBook

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

Set the value of PublishedInBook

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getPublishedInJournal

public int getPublishedInJournal()

Get the PublishedInJournal

Returns:

int

setPublishedInJournal

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

Set the value of PublishedInJournal

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

setDBLiteratureRelatedByLiteratureId

public void setDBLiteratureRelatedByLiteratureId(DBLiterature v)
                                          throws org.apache.torque.TorqueException

Declares an association between this object and a DBLiterature object

Parameters:

v - DBLiterature

Throws:

org.apache.torque.TorqueException

getDBLiteratureRelatedByLiteratureId

public DBLiterature getDBLiteratureRelatedByLiteratureId()
                                                  throws org.apache.torque.TorqueException

Get the associated DBLiterature object

Returns:

the associated DBLiterature object

Throws:

org.apache.torque.TorqueException

setDBLiteratureRelatedByLiteratureIdKey

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

setDBLiteratureRelatedByPublishedInBook

public void setDBLiteratureRelatedByPublishedInBook(DBLiterature v)
                                             throws org.apache.torque.TorqueException

Declares an association between this object and a DBLiterature object

Parameters:

v - DBLiterature

Throws:

org.apache.torque.TorqueException

getDBLiteratureRelatedByPublishedInBook

public DBLiterature getDBLiteratureRelatedByPublishedInBook()
                                                     throws org.apache.torque.TorqueException

Get the associated DBLiterature object

Returns:

the associated DBLiterature object

Throws:

org.apache.torque.TorqueException

setDBLiteratureRelatedByPublishedInBookKey

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

setDBJournalVolume

public void setDBJournalVolume(DBJournalVolume v)
                        throws org.apache.torque.TorqueException

Declares an association between this object and a DBJournalVolume object

Parameters:

v - DBJournalVolume

Throws:

org.apache.torque.TorqueException

getDBJournalVolume

public DBJournalVolume getDBJournalVolume()
                                   throws org.apache.torque.TorqueException

Get the associated DBJournalVolume object

Returns:

the associated DBJournalVolume object

Throws:

org.apache.torque.TorqueException

setDBJournalVolumeKey

public void setDBJournalVolumeKey(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 using ObjectKey.

Specified by:

setPrimaryKey in interface org.apache.torque.om.Persistent

Overrides:

setPrimaryKey in class org.apache.torque.om.BaseObject

Parameters:

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

Throws:

org.apache.torque.TorqueException

getPeer

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