|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.torque.om.BaseObject
This class contains attributes and methods that are used by all business objects within the system.
Field Summary | |
private boolean |
is_new
attribute to determine if this object has previously been saved. |
private org.apache.log4j.Category |
log
Cache the logger to avoid looking it up every time its needed. |
private boolean |
modified
A flag that indicates an object has been modified since it was last retrieved from the persistence mechanism. |
static int |
NEW_ID
The constant denoting an unset numeric database identifier. |
private static java.lang.String |
NOT_IMPLEMENTED
Shared portion of the error message thrown for methods which are not implemented. |
private ObjectKey |
primaryKey
The unique id for the object which can be used for persistence. |
Constructor Summary | |
BaseObject()
|
Method Summary | |
boolean |
equals(BaseObject bo)
Compares the primary key of this instance with the key of another. |
boolean |
equals(java.lang.Object obj)
Compares this with another BaseObject instance. |
java.lang.Object |
getByName(java.lang.String field)
Retrieves a field from the object by name. |
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 a database schema for example. |
protected org.apache.log4j.Category |
getCategory()
Deprecated. use log() |
ObjectKey |
getPrimaryKey()
getter for the object primaryKey. |
java.math.BigDecimal |
getPrimaryKeyAsBigDecimal()
Deprecated. Use getPrimaryKey() instead. Refer to ObjectKey for more information on type
conversion. |
int |
getPrimaryKeyAsInt()
Deprecated. Use getPrimaryKey() instead. Refer to ObjectKey for more information on type
conversion. |
long |
getPrimaryKeyAsLong()
Deprecated. Use getPrimaryKey() instead. Refer to ObjectKey for more information on type
conversion. |
java.lang.String |
getPrimaryKeyAsString()
Deprecated. Use getPrimaryKey() instead. Refer to ObjectKey for more information on type
conversion. |
int |
hashCode()
If the primary key is not null , return the hashcode of the
primary key. |
boolean |
isModified()
Returns whether the object has been modified. |
boolean |
isNew()
Returns whether the object has ever been saved. |
protected org.apache.log4j.Category |
log()
gets a log4j Category based on class name. |
void |
resetModified()
Sets the modified state for the object to be false. |
abstract void |
save()
Saves the object. |
abstract void |
save(java.sql.Connection con)
Stores the object in the database. |
abstract void |
save(java.lang.String dbName)
Stores the object in the database. |
void |
setModified(boolean m)
Sets the modified state for the object. |
void |
setNew(boolean b)
Setter for the isNew attribute. |
void |
setPrimaryKey(int primaryKey)
Deprecated. |
void |
setPrimaryKey(long primaryKey)
Deprecated. |
void |
setPrimaryKey(ObjectKey primaryKey)
Sets the PrimaryKey for the object as an Object. |
void |
setPrimaryKey(SimpleKey[] primaryKey)
Sets the PrimaryKey for the object as an Object. |
void |
setPrimaryKey(java.lang.String primaryKey)
Sets the PrimaryKey for the object. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int NEW_ID
private static final java.lang.String NOT_IMPLEMENTED
private boolean is_new
private ObjectKey primaryKey
private boolean modified
private transient org.apache.log4j.Category log
Constructor Detail |
public BaseObject()
Method Detail |
public ObjectKey getPrimaryKey()
getPrimaryKey
in interface Persistent
public int getPrimaryKeyAsInt()
ObjectKey
for more information on type
conversion.
public long getPrimaryKeyAsLong()
ObjectKey
for more information on type
conversion.
public java.math.BigDecimal getPrimaryKeyAsBigDecimal()
ObjectKey
for more information on type
conversion.
public java.lang.String getPrimaryKeyAsString()
ObjectKey
for more information on type
conversion.
public boolean isModified()
isModified
in interface Persistent
public boolean isNew()
isNew
in interface Persistent
public void setNew(boolean b)
setNew
in interface Persistent
b
- the state of the object.public void setPrimaryKey(int primaryKey) throws java.lang.Exception
primaryKey
- The new primaryKey for the object.
java.lang.Exception
- This method will not throw any exceptions
but this allows for children to override the method more easilypublic void setPrimaryKey(long primaryKey) throws java.lang.Exception
primaryKey
- The new PrimaryKey for the object.
java.lang.Exception
- This method will not throw any exceptions
but this allows for children to override the method more easilypublic void setPrimaryKey(java.lang.String primaryKey) throws java.lang.Exception
setPrimaryKey
in interface Persistent
primaryKey
- The new PrimaryKey for the object.
java.lang.Exception
- This method will not throw any exceptions
but this allows for children to override the method more easilypublic void setPrimaryKey(SimpleKey[] primaryKey) throws java.lang.Exception
primaryKey
- The new PrimaryKey for the object.
java.lang.Exception
- This method will not throw any exceptions
but this allows for children to override the method more easilypublic void setPrimaryKey(ObjectKey primaryKey) throws java.lang.Exception
setPrimaryKey
in interface Persistent
primaryKey
- The new PrimaryKey for the object.
java.lang.Exception
- This method will not throw any exceptions
but this allows for children to override the method more easilypublic void setModified(boolean m)
setModified
in interface Persistent
m
- The new modified state for the object.public void resetModified()
public java.lang.Object getByName(java.lang.String field)
field
- The name of the field to retrieve.
public java.lang.Object getByPeerName(java.lang.String name)
public java.lang.Object getByPosition(int pos)
public boolean equals(java.lang.Object obj)
BaseObject
instance. If
obj
is an instance of BaseObject
, delegates to
equals(BaseObject)
. Otherwise, returns false
.
obj
- The object to compare to.
public boolean equals(BaseObject bo)
bo
- The object to compare to.
public int hashCode()
null
, return the hashcode of the
primary key. Otherwise calls Object.hashCode()
.
int
valueprotected org.apache.log4j.Category getCategory()
Category
to write log to.protected org.apache.log4j.Category log()
Category
to write log to.public abstract void save() throws java.lang.Exception
Persistent
save
in interface Persistent
java.lang.Exception
Persistent.save()
public abstract void save(java.lang.String dbName) throws java.lang.Exception
Persistent
save
in interface Persistent
java.lang.Exception
Persistent.save(String)
public abstract void save(java.sql.Connection con) throws java.lang.Exception
Persistent
save
in interface Persistent
java.lang.Exception
Persistent.save(Connection)
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |