org.apache.james.mailboxmanager.torque.om
Class BaseMessageRow

java.lang.Object
  org.apache.torque.om.BaseObject
      org.apache.james.mailboxmanager.torque.om.BaseMessageRow

All Implemented Interfaces:

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

Direct Known Subclasses:

MessageRow

public abstract class BaseMessageRow
extends org.apache.torque.om.BaseObject

This class was autogenerated by Torque on: [Sun Dec 09 17:45:09 GMT 2007] You should not use this class directly. It should not even be extended all references should be to MessageRow

See Also:

Serialized Form

Field Summary

protected java.util.List	collMessageBodys Collection to store aggregation of collMessageBodys
protected java.util.List	collMessageFlagss Collection to store aggregation of collMessageFlagss
protected java.util.List	collMessageHeaders Collection to store aggregation of collMessageHeaders

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

NEW_ID

Constructor Summary

BaseMessageRow()

Method Summary

void	addMessageBody(MessageBody l) Method called to associate a MessageBody object to this object through the MessageBody foreign key attribute
void	addMessageFlags(MessageFlags l) Method called to associate a MessageFlags object to this object through the MessageFlags foreign key attribute
void	addMessageHeader(MessageHeader l) Method called to associate a MessageHeader object to this object through the MessageHeader foreign key attribute
MessageRow	copy() Makes a copy of this object.
MessageRow	copy(boolean deepcopy) Makes a copy of this object.
protected MessageRow	copyInto(MessageRow copyObj) Fills the copyObj with the contents of this object.
protected MessageRow	copyInto(MessageRow copyObj, boolean deepcopy) Fills the copyObj with the contents of this object.
java.lang.Object	getByName(java.lang.String name) Retrieves a field from the object by field (Java) 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.Date	getInternalDate() Get the InternalDate
long	getMailboxId() Get the MailboxId
MailboxRow	getMailboxRow() Returns the associated MailboxRow object.
MailboxRow	getMailboxRow(java.sql.Connection connection) Return the associated MailboxRow object If it was not retrieved before, the object is retrieved from the database using the passed connection
java.util.List	getMessageBodys() If this collection has already been initialized, returns the collection.
java.util.List	getMessageBodys(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getMessageBodys(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getMessageBodys(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	getMessageBodysJoinMessageRow(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getMessageFlagss() If this collection has already been initialized, returns the collection.
java.util.List	getMessageFlagss(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getMessageFlagss(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getMessageFlagss(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	getMessageFlagssJoinMessageRow(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getMessageHeaders() If this collection has already been initialized, returns the collection.
java.util.List	getMessageHeaders(java.sql.Connection con) If this collection has already been initialized, returns the collection.
java.util.List	getMessageHeaders(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
java.util.List	getMessageHeaders(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	getMessageHeadersJoinMessageRow(org.apache.torque.util.Criteria criteria) If this collection has already been initialized with an identical criteria, it returns the collection.
MessageRowPeer	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	getSize() Get the Size
org.apache.torque.map.TableMap	getTableMap() Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().
long	getUid() Get the Uid
protected void	initMessageBodys() Temporary storage of collMessageBodys to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initMessageFlagss() Temporary storage of collMessageFlagss to save a possible db hit in the event objects are add to the collection, but the complete collection is never requested.
protected void	initMessageHeaders() Temporary storage of collMessageHeaders 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.
boolean	setByName(java.lang.String name, java.lang.Object value) Set a field in the object by field (Java) name.
boolean	setByPeerName(java.lang.String name, java.lang.Object value) Set field values by Peer Field Name
boolean	setByPosition(int position, java.lang.Object value) Set field values by its position (zero based) in the XML schema.
void	setInternalDate(java.util.Date v) Set the value of InternalDate
void	setMailboxId(long v) Set the value of MailboxId
void	setMailboxRow(MailboxRow v) Declares an association between this object and a MailboxRow object
void	setMailboxRowKey(org.apache.torque.om.ObjectKey key) Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())
void	setPrimaryKey(long mailboxId, long uid) 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.
void	setSize(int v) Set the value of Size
void	setUid(long v) Set the value of Uid
java.lang.String	toString()

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

equals, equals, getLog, hashCode, isModified, isNew, resetModified, setModified, setNew, setPrimaryKey

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

collMessageFlagss

protected java.util.List collMessageFlagss

Collection to store aggregation of collMessageFlagss

collMessageHeaders

protected java.util.List collMessageHeaders

Collection to store aggregation of collMessageHeaders

collMessageBodys

protected java.util.List collMessageBodys

Collection to store aggregation of collMessageBodys

Constructor Detail

BaseMessageRow

public BaseMessageRow()

Method Detail

getMailboxId

public long getMailboxId()

Get the MailboxId

Returns:

long

setMailboxId

public void setMailboxId(long v)
                  throws org.apache.torque.TorqueException

Set the value of MailboxId

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getUid

public long getUid()

Get the Uid

Returns:

long

setUid

public void setUid(long v)
            throws org.apache.torque.TorqueException

Set the value of Uid

Parameters:

v - new value

Throws:

org.apache.torque.TorqueException

getInternalDate

public java.util.Date getInternalDate()

Get the InternalDate

Returns:

Date

setInternalDate

public void setInternalDate(java.util.Date v)

Set the value of InternalDate

Parameters:

v - new value

getSize

public int getSize()

Get the Size

Returns:

int

setSize

public void setSize(int v)

Set the value of Size

Parameters:

v - new value

setMailboxRow

public void setMailboxRow(MailboxRow v)
                   throws org.apache.torque.TorqueException

Declares an association between this object and a MailboxRow object

Parameters:

v - MailboxRow

Throws:

org.apache.torque.TorqueException

getMailboxRow

public MailboxRow getMailboxRow()
                         throws org.apache.torque.TorqueException

Returns the associated MailboxRow object. If it was not retrieved before, the object is retrieved from the database

Returns:

the associated MailboxRow object

Throws:

org.apache.torque.TorqueException

getMailboxRow

public MailboxRow getMailboxRow(java.sql.Connection connection)
                         throws org.apache.torque.TorqueException

Return the associated MailboxRow object If it was not retrieved before, the object is retrieved from the database using the passed connection

Parameters:

connection - the connection used to retrieve the associated object from the database, if it was not retrieved before

Returns:

the associated MailboxRow object

Throws:

org.apache.torque.TorqueException

setMailboxRowKey

public void setMailboxRowKey(org.apache.torque.om.ObjectKey key)
                      throws org.apache.torque.TorqueException

Provides convenient way to set a relationship based on a ObjectKey, for example bar.setFooKey(foo.getPrimaryKey())

Throws:

org.apache.torque.TorqueException

initMessageFlagss

protected void initMessageFlagss()

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

addMessageFlags

public void addMessageFlags(MessageFlags l)
                     throws org.apache.torque.TorqueException

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

Parameters:

l - MessageFlags

Throws:

org.apache.torque.TorqueException

getMessageFlagss

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getMessageFlagss

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

getMessageFlagss

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

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

getMessageFlagss

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

getMessageFlagssJoinMessageRow

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

Throws:

org.apache.torque.TorqueException

initMessageHeaders

protected void initMessageHeaders()

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

addMessageHeader

public void addMessageHeader(MessageHeader l)
                      throws org.apache.torque.TorqueException

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

Parameters:

l - MessageHeader

Throws:

org.apache.torque.TorqueException

getMessageHeaders

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getMessageHeaders

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

getMessageHeaders

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

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

getMessageHeaders

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

getMessageHeadersJoinMessageRow

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

Throws:

org.apache.torque.TorqueException

initMessageBodys

protected void initMessageBodys()

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

addMessageBody

public void addMessageBody(MessageBody l)
                    throws org.apache.torque.TorqueException

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

Parameters:

l - MessageBody

Throws:

org.apache.torque.TorqueException

getMessageBodys

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

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

Returns:

the collection of associated objects

Throws:

org.apache.torque.TorqueException

getMessageBodys

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

getMessageBodys

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

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

getMessageBodys

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

getMessageBodysJoinMessageRow

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

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 field (Java) name passed in as a String.

Overrides:

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

Parameters:

name - field name

Returns:

value

setByName

public boolean setByName(java.lang.String name,
                         java.lang.Object value)
                  throws org.apache.torque.TorqueException,
                         java.lang.IllegalArgumentException

Set a field in the object by field (Java) name.

Overrides:

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

Parameters:

name - field name

value - field value

Returns:

True if value was set, false if not (invalid name / protected field).

Throws:

java.lang.IllegalArgumentException - if object type of value does not match field object type.

org.apache.torque.TorqueException - If a problem occures with the set[Field] method.

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

setByPeerName

public boolean setByPeerName(java.lang.String name,
                             java.lang.Object value)
                      throws org.apache.torque.TorqueException,
                             java.lang.IllegalArgumentException

Set field values by Peer Field Name

Overrides:

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

Parameters:

name - field name

value - field value

Returns:

True if value was set, false if not (invalid name / protected field).

Throws:

java.lang.IllegalArgumentException - if object type of value does not match field object type.

org.apache.torque.TorqueException - If a problem occures with the set[Field] method.

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

setByPosition

public boolean setByPosition(int position,
                             java.lang.Object value)
                      throws org.apache.torque.TorqueException,
                             java.lang.IllegalArgumentException

Set field values by its position (zero based) in the XML schema.

Overrides:

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

Parameters:

position - The field position

value - field value

Returns:

True if value was set, false if not (invalid position / protected field).

Throws:

java.lang.IllegalArgumentException - if object type of value does not match field object type.

org.apache.torque.TorqueException - If a problem occures with the set[Field] method.

save

public void save()
          throws org.apache.torque.TorqueException

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

org.apache.torque.TorqueException

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(long mailboxId,
                          long uid)
                   throws org.apache.torque.TorqueException

Set the PrimaryKey using SimpleKeys.

Parameters:

mailboxId - long

uid - long

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 MessageRow 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

copy

public MessageRow copy(boolean deepcopy)
                throws org.apache.torque.TorqueException

Makes a copy of this object. It creates a new object filling in the simple attributes. If the parameter deepcopy is true, it then fills all the association collections and sets the related objects to isNew=true.

Parameters:

deepcopy - whether to copy the associated objects.

Throws:

org.apache.torque.TorqueException

copyInto

protected MessageRow copyInto(MessageRow copyObj)
                       throws org.apache.torque.TorqueException

Fills the copyObj with the contents of this object. The associated objects are also copied and treated as new objects.

Parameters:

copyObj - the object to fill.

Throws:

org.apache.torque.TorqueException

copyInto

protected MessageRow copyInto(MessageRow copyObj,
                              boolean deepcopy)
                       throws org.apache.torque.TorqueException

Fills the copyObj with the contents of this object. If deepcopy is true, The associated objects are also copied and treated as new objects.

Parameters:

copyObj - the object to fill.

deepcopy - whether the associated objects should be copied.

Throws:

org.apache.torque.TorqueException

getPeer

public MessageRowPeer 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.

getTableMap

public org.apache.torque.map.TableMap getTableMap()
                                           throws org.apache.torque.TorqueException

Retrieves the TableMap object related to this Table data without compiler warnings of using getPeer().getTableMap().

Overrides:

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

Returns:

The associated TableMap object.

Throws:

org.apache.torque.TorqueException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object