com.whitestein.lsps.engine.lang

Class ExternalRecordEntityAdapter

java.lang.Object

com.whitestein.lsps.engine.lang.RecordEntityAdapter

com.whitestein.lsps.engine.lang.ExternalRecordEntityAdapter

All Implemented Interfaces:

AssociationHandler

Direct Known Subclasses:

PojoExternalRecordEntityAdapter, ProcessInstanceAdapter, SharedRecordEntityAdapter

public abstract class ExternalRecordEntityAdapter
extends RecordEntityAdapter

Common implementation for pojo and ExternalRecordEntity based adapters.

Author:

bhl

Constructor Summary

Constructors

Constructor and Description
ExternalRecordEntityAdapter(Object entity, ExternalValue externalValue, RecordType type, ModelInstance modelInstance, ModelProvider modelProvider) Creates new instance.

Method Summary

Modifier and Type	Method and Description
protected void	addToNonSharedAssociationCache(RecordProperty property, Object runtimeValue) Adds value to internal values association cache.
protected boolean	canRemoveThisFromReverseAssociation(RecordHolder removed, RecordAssociation reverseAssociation) Returns true if this entity/holder can be removed from reverse association.
protected boolean	canSetProperty(String name) Returns true if a property can be updated.
void	cleanAndRenewVersion()
protected abstract void	clearEntity() Clears reference to the entity.
protected abstract Object	convertToRuntime(RecordProperty property, Object rawValue) Converts raw value to runtime value.
protected String	createEntityIdentificationString(Object entity) Creates entity identification string.
protected Object	createEntityJavaIdentification() Creates java identification object.
void	fireNewEntityChange() Fire change for created entity.
protected void	firePropertyChange(String name, Object value) Fire property change event.
protected Long	getAuditRevisionId() Returns audit revision id
Object	getEntity() Returns the adapted entity.
String	getEntityIdentificationString() Returns the unique string for this record (primary key and if needed version) private String entityIdentificationString;
protected Object	getEntityInternal() Returns entity.
Object	getEntityNotNull() This method should be called instead of getEntity() when entity is expected to be not null.
ExternalRecordType	getExternalRecordType() Returns external record type.
ExternalValue	getExternalValue() finds an existing external value for entity hold by this adapter.
protected Field	getField(Class<?> cls, String name) returns field from class or super-classes.
protected abstract Object	getFromEntity(Object entity, RecordProperty property)
protected Object	getFromEntity(RecordProperty property) Returns value of property from entity.
ExternalRecordHolder	getHolder() Returns holder for the underlying entity.
Object	getJavaIdentification() Returns the unique object for this record (primary key).
protected ModelInstance	getModelInstance() Returns model instance.
protected ModelProvider	getModelProvider() Returns model provider
Object	getProperty(RecordProperty property) Returns value of the property.
protected Object	getPropertyInternal(RecordProperty property) Gets property internal.
protected abstract Object	getRawFromEntity(Object entity, RecordProperty property) Returns unmodified value from entity.
protected Object	getRawFromEntity(RecordProperty property)
RecordType	getType() Returns record type.
Long	getVersion() Returns string representation of the entity version, used for multi-transactional optimistic locking.
protected void	initEntityIdentificationString()
protected boolean	isExternalValueCreated() Returns true if external value is created.
protected abstract boolean	isInitialized(Object object)
boolean	needsToBeReloaded() Returns true if entity needs to be reloaded from database.
protected void	postSetAssociation(RecordAssociation assoc, Object value) Executes after association is set.
protected abstract void	refresh()
protected abstract void	reloadIfNeeded() Reloads entity.
protected abstract void	removeEntity(Object entity) Removes entity.
protected abstract void	removeFromAllAssociations(Set<ExternalRecordAssociation> ignoreAssociations) Removes this entity from all association.
void	removeThis() Removes the adapted entity.
protected void	setEntityInternal(Object entity) Sets entity.
protected void	setPropertyInternal(RecordProperty property, Object value, boolean ignoreCompositions) Sets property.
void	updateVersion() Updates version string.

Methods inherited from class com.whitestein.lsps.engine.lang.RecordEntityAdapter

getConverter, getEvaluationConverter, getHolderFactory, getHolderInternal, getJavaObject, remove, removeAddedFromOldParents, removeNullObjects, setAssociation, setField, setHolderInternal, setProperty, setThisSideOfAssociation

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whitestein.lsps.lang.exec.AssociationHandler

isUpdateNecessary

Constructor Detail

ExternalRecordEntityAdapter

public ExternalRecordEntityAdapter(Object entity,
                                   ExternalValue externalValue,
                                   RecordType type,
                                   ModelInstance modelInstance,
                                   ModelProvider modelProvider)

Creates new instance.

Parameters:

entity -

externalValue -

type -

modelInstance -

modelProvider -

Method Detail

getModelInstance

protected ModelInstance getModelInstance()

Description copied from class: RecordEntityAdapter

Returns model instance.

Specified by:

getModelInstance in class RecordEntityAdapter

Returns:

model instance

getModelProvider

protected ModelProvider getModelProvider()

Description copied from class: RecordEntityAdapter

Returns model provider

Specified by:

getModelProvider in class RecordEntityAdapter

Returns:

model provider

getType

public RecordType getType()

Description copied from class: RecordEntityAdapter

Returns record type.

Specified by:

getType in class RecordEntityAdapter

Returns:

record type

initEntityIdentificationString

protected void initEntityIdentificationString()

getEntityInternal

protected Object getEntityInternal()

Returns entity.

Returns:

entity

setEntityInternal

protected void setEntityInternal(Object entity)

Sets entity.

Parameters:

entity -

needsToBeReloaded

public boolean needsToBeReloaded()

Returns true if entity needs to be reloaded from database.

Returns:

true if entity needs to be reloaded from database

getEntity

public Object getEntity()

Returns the adapted entity.

Returns:

the adapted entity

getEntityNotNull

public Object getEntityNotNull()

This method should be called instead of getEntity() when entity is expected to be not null.

Returns:

entity

reloadIfNeeded

protected abstract void reloadIfNeeded()

Reloads entity.

getExternalRecordType

public ExternalRecordType getExternalRecordType()

Returns external record type.

Returns:

external record type

isExternalValueCreated

protected boolean isExternalValueCreated()

Returns true if external value is created.

Returns:

true if external value is created

getHolder

public ExternalRecordHolder getHolder()

Returns holder for the underlying entity.

Overrides:

getHolder in class RecordEntityAdapter

Returns:

holder for the underlying entity

getExternalValue

public ExternalValue getExternalValue()

finds an existing external value for entity hold by this adapter. If not found a new value is created.

Returns:

an external value

getAuditRevisionId

protected Long getAuditRevisionId()

Returns audit revision id

Returns:

null for this type

getEntityIdentificationString

public String getEntityIdentificationString()

Returns the unique string for this record (primary key and if needed version) private String entityIdentificationString;

Returns:

the string which references this record (primary key and if needed version)

createEntityIdentificationString

protected String createEntityIdentificationString(Object entity)

Creates entity identification string.

Parameters:

entity -

Returns:

entity identification string

getJavaIdentification

public Object getJavaIdentification()

Returns the unique object for this record (primary key). For a composite identification a map (propertyName -> java value) is returned. For simple identification the corresponding java value is returned.

Returns:

unique object for this record

createEntityJavaIdentification

protected Object createEntityJavaIdentification()

Creates java identification object. (Java representation of PK).

Returns:

java identification object

updateVersion

public void updateVersion()

Updates version string.

getVersion

public Long getVersion()

Returns string representation of the entity version, used for multi-transactional optimistic locking.

Returns:

string representation of the entity version, used for multi-transactional optimistic locking

getProperty

public Object getProperty(RecordProperty property)

Returns value of the property.

Specified by:

getProperty in class RecordEntityAdapter

Parameters:

property -

Returns:

value of the property

getPropertyInternal

protected Object getPropertyInternal(RecordProperty property)

Gets property internal.

Parameters:

property -

Returns:

property value

setPropertyInternal

protected void setPropertyInternal(RecordProperty property,
                                   Object value,
                                   boolean ignoreCompositions)

Description copied from class: RecordEntityAdapter

Sets property.

Specified by:

setPropertyInternal in class RecordEntityAdapter

getRawFromEntity

protected abstract Object getRawFromEntity(Object entity,
                                           RecordProperty property)

Returns unmodified value from entity.

Parameters:

entity -

property -

Returns:

unmodified value from entity

getRawFromEntity

protected Object getRawFromEntity(RecordProperty property)

getFromEntity

protected abstract Object getFromEntity(Object entity,
                                        RecordProperty property)

getFromEntity

protected Object getFromEntity(RecordProperty property)

Returns value of property from entity.

Parameters:

property -

Returns:

value of property from entity

convertToRuntime

protected abstract Object convertToRuntime(RecordProperty property,
                                           Object rawValue)

Converts raw value to runtime value.

Parameters:

property -

rawValue -

Returns:

converted value

addToNonSharedAssociationCache

protected void addToNonSharedAssociationCache(RecordProperty property,
                                              Object runtimeValue)

Adds value to internal values association cache. Internal values must be cached so that they are not constructed each time they are called and so that they have same identity during multiple invocations.

Parameters:

property -

runtimeValue -

canSetProperty

protected boolean canSetProperty(String name)

Description copied from class: RecordEntityAdapter

Returns true if a property can be updated.

Overrides:

canSetProperty in class RecordEntityAdapter

Returns:

true if a property can be updated

firePropertyChange

protected void firePropertyChange(String name,
                                  Object value)

Description copied from class: RecordEntityAdapter

Fire property change event.

Specified by:

firePropertyChange in class RecordEntityAdapter

fireNewEntityChange

public void fireNewEntityChange()

Fire change for created entity.

canRemoveThisFromReverseAssociation

protected boolean canRemoveThisFromReverseAssociation(RecordHolder removed,
                                                      RecordAssociation reverseAssociation)

Description copied from class: RecordEntityAdapter

Returns true if this entity/holder can be removed from reverse association.

Specified by:

canRemoveThisFromReverseAssociation in class RecordEntityAdapter

Returns:

true if this entity/holder can be removed from reverse association

postSetAssociation

protected void postSetAssociation(RecordAssociation assoc,
                                  Object value)

Description copied from class: RecordEntityAdapter

Executes after association is set.

Overrides:

postSetAssociation in class RecordEntityAdapter

removeThis

public void removeThis()

Removes the adapted entity.

Specified by:

removeThis in class RecordEntityAdapter

isInitialized

protected abstract boolean isInitialized(Object object)

removeFromAllAssociations

protected abstract void removeFromAllAssociations(Set<ExternalRecordAssociation> ignoreAssociations)

Removes this entity from all association. Ignore provided set of associations because it is already removed from these associations.

Parameters:

ignoreAssociations -

removeEntity

protected abstract void removeEntity(Object entity)

Removes entity.

Parameters:

entity -

clearEntity

protected abstract void clearEntity()

Clears reference to the entity.

getField

protected Field getField(Class<?> cls,
                         String name)
                  throws SecurityException,
                         NoSuchFieldException

returns field from class or super-classes.

Parameters:

cls -

name -

Returns:

field from class or super-classes

Throws:

SecurityException

NoSuchFieldException

refresh

protected abstract void refresh()

cleanAndRenewVersion

public void cleanAndRenewVersion()