Package com.avoka.core.entity

Class BaseEntity

java.lang.Object

org.apache.cayenne.PersistentObject

org.apache.cayenne.BaseDataObject

org.apache.cayenne.CayenneDataObject

com.avoka.core.entity.BaseEntity

All Implemented Interfaces:

IEntity, Serializable, org.apache.cayenne.DataObject, org.apache.cayenne.Persistent, org.apache.cayenne.Validating

Direct Known Subclasses:

_ApplicationClientProperty, _ApplicationClientRefData, _ApplicationConnection, _ApplicationDelivery, _ApplicationForm, _ApplicationPackage, _ApplicationService, _Attachment, _AuditLog, _AuthenticationProvider, _AuthProviderParameter, _Category, _Client, _ClientKeystore, _ClientMetadataValue, _ClientPortal, _ClientProperty, _ClientReconciliationFile, _ClientRefData, _ClientRefDataData, _ClientUser, _ComposerImportAction, _ComposerPackageData, _ComposerPackageQueue, _DbVersionUpdate, _DeliveryDetails, _DeploymentProperty, _DocumentType, _EmailQueue, _EmailQueueData, _ErrorLog, _ErrorLogData, _EventLog, _EventOutbox, _FileUpload, _FileUploadData, _Folder, _Form, _FormCategory, _FormDesign, _FormDesignVersion, _FormDesignVersionInclude, _FormDesignVersionProperty, _FormFunction, _FormGroup, _FormPortal, _FormReceiptSequence, _GroovyServiceLog, _GroovyServiceLogData, _Group, _GroupAgentLock, _ImportAction, _ImportActionData, _ImportActionDetail, _IntegrityCheckerLog, _Job, _JobAction, _JobComment, _JobEventLog, _JobGroup, _JobHistory, _JobProperty, _JobStatusHistory, _JobStep, _Library, _LibraryResource, _LibraryResourceData, _LibraryResourceHistory, _LibraryShare, _MetadataListValue, _MetadataTag, _Notification, _PaymentItem, _PaymentLog, _Permission, _Portal, _PortalPage, _PortalPageHistory, _PortalProperty, _PortalResource, _PortalResourceHistory, _PortalUser, _PrefillParamXpathMap, _ProcessingStatus, _Project, _ProjectFormTag, _ProjectFormTagData, _ProjectInclude, _PromotionLog, _PropertyPrefillMap, _PropertyType, _ReleaseVersion, _RequestLog, _RequiredAttachment, _Role, _RolePermission, _ScheduledJobHistory, _SchemaExtractMap, _SchemaSeed, _SecurityManager, _SecurityManagerLog, _SecurityManagerLogData, _SecurityManagerParameter, _ServerHealthStatusMetric, _ServerNode, _ServiceConnection, _ServiceDefinition, _ServiceParameter, _ServiceParameterHistory, _Submission, _SubmissionAsyncMsg, _SubmissionAsyncMsgBody, _SubmissionAttribute, _SubmissionComment, _SubmissionData, _SubmissionDeliveryCheckpoint, _SubmissionDeliveryFunc, _SubmissionExtractData, _SubmissionExtractJson, _SubmissionExtractSearch, _SubmissionGroup, _SubmissionHistory, _SubmissionHistoryData, _SubmissionMilestone, _SubmissionProperty, _SubmissionPropertySearch, _SubmissionServiceLog, _SubmissionValidationError, _SystemHealth, _TemplateVersion, _TemplateVersionData, _TemplateVersionDeployment, _TPac, _TPacData, _TransactionHistory, _TransactionLookup, _UserAccount, _UserAuthEvent, _UserGroup, _UserPortalPref, _UserProfile, _UserProperty, _UserRole, _VersionAttachment, _VersionMetadataValue, _VersionPropertyValue, _XmlInputMap

public abstract class BaseEntity
extends org.apache.cayenne.CayenneDataObject
implements IEntity

Provides a base CayenneDataObject for application entity classes to extend.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_PROPERTY	Note there may be no corresponding id property in the database.

Fields inherited from class org.apache.cayenne.CayenneDataObject

values

Fields inherited from class org.apache.cayenne.BaseDataObject

snapshotVersion

Fields inherited from class org.apache.cayenne.PersistentObject

objectContext, objectId, persistenceState

Fields inherited from interface org.apache.cayenne.DataObject

DEFAULT_VERSION

Constructor Summary

Constructors

Constructor	Description
BaseEntity()

Method Summary

Modifier and Type	Method	Description
protected void	appendProperties(StringBuffer buffer)
Long	getId()	Return the surrogate primary key of the object.
Map	getValuesMap()	Deprecated. this method appears to not work when the entity is hollow - an empty map is returned
boolean	isNew()	Return true if the object is new or transient object.
void	setId(Long id)	Set the surrogate primary key of the object.
String	toString()

Methods inherited from class org.apache.cayenne.CayenneDataObject

makePath, readPropertyDirectly, readState, setPersistenceState, writePropertyDirectly, writeState

Methods inherited from class org.apache.cayenne.BaseDataObject

addToManyTarget, beforePropertyRead, beforePropertyWrite, getSnapshotVersion, readNestedProperty, readProperty, readSerialized, removeToManyTarget, setObjectContext, setReverseRelationship, setSnapshotVersion, setToManyTarget, setToOneTarget, toStringBuffer, unsetReverseRelationship, validateForDelete, validateForInsert, validateForSave, validateForUpdate, willConnect, writeProperty, writeSerialized

Methods inherited from class org.apache.cayenne.PersistentObject

getMapKey, getObjectContext, getObjectId, getPersistenceState, setObjectId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.cayenne.Persistent

getObjectContext, getObjectId, getPersistenceState, setObjectContext, setObjectId, setPersistenceState

Field Details

ID_PROPERTY

public static final String ID_PROPERTY

Note there may be no corresponding id property in the database.

See Also:

• Constant Field Values

Constructor Details

BaseEntity

public BaseEntity()

Method Details

getId

public Long getId()

Return the surrogate primary key of the object.

Specified by:

getId in interface IEntity

Returns:

the surrogate primary key of the object

See Also:

• IEntity.getId()

setId

public void setId(Long id)

Set the surrogate primary key of the object.

Specified by:

setId in interface IEntity

Parameters:

id - the surrogate primary key of the object to set

See Also:

• IEntity.setId(Long)

isNew

public boolean isNew()

Return true if the object is new or transient object.

Specified by:

isNew in interface IEntity

Returns:

true if the object is new or transient object

See Also:

• IEntity.isNew()

getValuesMap

public Map getValuesMap()

Deprecated.

this method appears to not work when the entity is hollow - an empty map is returned

Return map of object properties values for query by example.

Returns:

a map of object properties

toString

public String toString()

Overrides:

toString in class org.apache.cayenne.BaseDataObject

appendProperties

protected void appendProperties(StringBuffer buffer)

Overrides:

appendProperties in class org.apache.cayenne.CayenneDataObject