DataObject

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> objectstyle >> [ cayenne overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.objectstyle.cayenne.DataObject

SOURCE |

Download org.objectstyle.cayenne.DataObject

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.objectstyle.cayenne
Interface DataObject

All Superinterfaces:: java.io.Serializable

All Known Implementing Classes:: CayenneDataObject

public interface DataObject
extends java.io.Serializable

Defines basic methods for a persistent object in Cayenne.

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.

java.util.Map getCommittedSnapshot()
          Returns a snapshot for this object corresponding to the state of the database when object was last fetched or committed.

java.util.Map getCurrentSnapshot()
          Returns a snapshot of object current values.

org.objectstyle.cayenne.access.DataContext getDataContext()
          Returns a data context this object is registered with, or null if this object has no associated DataContext.

ObjectId getObjectId()
          Returns ObjectId for this data object - piece that uniquely identifies this data object for persistence purposes.

int getPersistenceState()
          Returns current state of this data object.

java.lang.Object readPropertyDirectly(java.lang.String propName)
          Allows Cayenne framework classes to read object property values.

DataObject readToOneDependentTarget(java.lang.String relName)


void removeToManyTarget(java.lang.String relName, DataObject val, boolean setReverse)


void setDataContext(org.objectstyle.cayenne.access.DataContext ctxt)
          Sets object data context.

void setObjectId(ObjectId objectId)
          Sets ObjectId for this data object - piece that uniquely identifies this data object for persistence purposes.

void setPersistenceState(int newState)
          Modifies persistence state of this data object For valid states look in PersistenceState class.

void setToOneDependentTarget(java.lang.String relName, DataObject val)


void setToOneTarget(java.lang.String relName, DataObject val, boolean setReverse)


void writePropertyDirectly(java.lang.String propName, java.lang.Object val)
          Allows Cayenne framework classes to modify object property values.

Method Detail

getDataContext

public org.objectstyle.cayenne.access.DataContext getDataContext()

Returns a data context this object is registered with, or null if this object has no associated DataContext.

setDataContext

public void setDataContext(org.objectstyle.cayenne.access.DataContext ctxt)

Sets object data context.

getObjectId

public ObjectId getObjectId()

Returns ObjectId for this data object - piece that uniquely identifies this data object for persistence purposes.

setObjectId

public void setObjectId(ObjectId objectId)

Sets ObjectId for this data object - piece that uniquely identifies this data object for persistence purposes.

getPersistenceState

public int getPersistenceState()

Returns current state of this data object. For valid states look in PersistenceState class.

setPersistenceState

public void setPersistenceState(int newState)

Modifies persistence state of this data object For valid states look in PersistenceState class.

writePropertyDirectly

public void writePropertyDirectly(java.lang.String propName,
                                  java.lang.Object val)

Allows Cayenne framework classes to modify object property values.

readPropertyDirectly

public java.lang.Object readPropertyDirectly(java.lang.String propName)

Allows Cayenne framework classes to read object property values.

readToOneDependentTarget

public DataObject readToOneDependentTarget(java.lang.String relName)

addToManyTarget

public void addToManyTarget(java.lang.String relName,
                            DataObject val,
                            boolean setReverse)

removeToManyTarget

public void removeToManyTarget(java.lang.String relName,
                               DataObject val,
                               boolean setReverse)

setToOneTarget

public void setToOneTarget(java.lang.String relName,
                           DataObject val,
                           boolean setReverse)

setToOneDependentTarget

public void setToOneDependentTarget(java.lang.String relName,
                                    DataObject val)

getCommittedSnapshot

public java.util.Map getCommittedSnapshot()

Returns a snapshot for this object corresponding to the state of the database when object was last fetched or committed.

getCurrentSnapshot

public java.util.Map getCurrentSnapshot()

Returns a snapshot of object current values.

fetchFinished

public void fetchFinished()

Notification method called by DataContext after the object was read from the database.