|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataObject
Defines basic methods for a persistent object in Cayenne.
Field Summary | |
---|---|
static long |
DEFAULT_VERSION
|
Method Summary | |
---|---|
void |
addToManyTarget(java.lang.String relName,
DataObject val,
boolean setReverse)
|
void |
fetchFinished()
Notification method called by DataContext after the object was read from the database. |
DataContext |
getDataContext()
Returns a data context this object is registered with, or null if this object has no associated DataContext. |
long |
getSnapshotVersion()
Returns a version of a DataRow snapshot that was used to create this object. |
java.lang.Object |
readNestedProperty(java.lang.String path)
Returns a value of the property identified by a property path. |
java.lang.Object |
readProperty(java.lang.String propName)
Returns a value of the property identified by propName. |
java.lang.Object |
readPropertyDirectly(java.lang.String propertyName)
Returns mapped property value as curently stored in the DataObject. |
void |
removeToManyTarget(java.lang.String relName,
DataObject val,
boolean setReverse)
|
void |
resolveFault()
Deprecated. since 1.2 use 'getObjectContext().prepareForAccess(object)' |
void |
setDataContext(DataContext ctxt)
Sets object DataContext. |
void |
setSnapshotVersion(long snapshotVersion)
|
void |
setToOneTarget(java.lang.String relationshipName,
DataObject value,
boolean setReverse)
Sets to-one relationship to a new value. |
void |
validateForDelete(ValidationResult validationResult)
Performs property validation of the DELETED object, appending any validation failures to the provided validationResult object. |
void |
validateForInsert(ValidationResult validationResult)
Performs property validation of the NEW object, appending any validation failures to the provided validationResult object. |
void |
validateForUpdate(ValidationResult validationResult)
Performs property validation of the MODIFIED object, appending any validation failures to the provided validationResult object. |
void |
writeProperty(java.lang.String propertyName,
java.lang.Object value)
Sets the property to the new value. |
void |
writePropertyDirectly(java.lang.String propertyName,
java.lang.Object val)
Modifies a value of a named property without altering the object state in any way, and without triggering any database operations. |
Methods inherited from interface org.apache.cayenne.Persistent |
---|
getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState |
Field Detail |
---|
static final long DEFAULT_VERSION
Method Detail |
---|
DataContext getDataContext()
void setDataContext(DataContext ctxt)
void writePropertyDirectly(java.lang.String propertyName, java.lang.Object val)
java.lang.Object readPropertyDirectly(java.lang.String propertyName)
java.lang.Object readNestedProperty(java.lang.String path)
Property path (or nested property) is a dot-separated path used to traverse object
relationships until the final object is found. If a null object found while
traversing path, null is returned. If a list is encountered in the middle of the
path, CayenneRuntimeException is thrown. Unlike
readPropertyDirectly(String)
, this method will resolve an object if it is
HOLLOW.
Examples:
String name = (String)artist.readNestedProperty("name");
Gallery g = (Gallery)paintingInfo.readNestedProperty("toPainting.toGallery");
String name = (String)painting.readNestedProperty("toArtist.artistName");
List exhibits = (List)painting.readNestedProperty("toGallery.exhibitArray");
String name = (String)artist.readNestedProperty("paintingArray.paintingName");
java.lang.Object readProperty(java.lang.String propName)
void writeProperty(java.lang.String propertyName, java.lang.Object value)
setToOneTarget(String, DataObject, boolean)
.
propertyName
- a name of the bean property being modified.value
- a new value of the property.void addToManyTarget(java.lang.String relName, DataObject val, boolean setReverse)
void removeToManyTarget(java.lang.String relName, DataObject val, boolean setReverse)
void setToOneTarget(java.lang.String relationshipName, DataObject value, boolean setReverse)
relationshipName
- a name of the bean property being modified - same as the
name of ObjRelationship.value
- a new value of the property.setReverse
- whether to update the reverse relationship pointing from the old
and new values of the property to this object.void fetchFinished()
long getSnapshotVersion()
void setSnapshotVersion(long snapshotVersion)
void resolveFault()
void validateForInsert(ValidationResult validationResult)
void validateForUpdate(ValidationResult validationResult)
void validateForDelete(ValidationResult validationResult)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |