com.whitestein.lsps.engine.lang

Class InternalRecordHolder

java.lang.Object

com.whitestein.lsps.engine.lang.HolderImpl<T>

com.whitestein.lsps.engine.lang.RecordHolderBase<RecordValue>

com.whitestein.lsps.engine.lang.InternalRecordHolder

All Implemented Interfaces:

AssociationHandler, RecordHolder, ValueHolder

public final class InternalRecordHolder
extends RecordHolderBase<RecordValue>
implements RecordHolder

Implementation of RecordHolder used for runtime. It is backed by given RecordValue. It translates its values using RuntimeToPersistentConverter.

Author:

rba

Field Summary

Fields inherited from class com.whitestein.lsps.engine.lang.RecordHolderBase

NO_PROPERTY_MSG

Constructor Summary

Constructors

Constructor and Description
InternalRecordHolder(RecordValue val, ModelProviderClientService modelProviderService) Creates new instance of InternalRecordHolder.
InternalRecordHolder(RecordValue val, ModelProviderClientService modelProviderService, Map<String,? extends Object> values) Creates new instance of InternalRecordHolder.

Method Summary

Modifier and Type	Method and Description
RecordHolder	createChangeProxy() Creates change proxy on this record holder.
void	createPropertyProxy(HolderFactory holderFactory, String property) Creates change proxy for all object referenced by the propery and sets the proxy values to the property.
boolean	equals(Object obj)
String	getIdentificationString() Returns identification string (string form of primary key)
Object	getJavaIdentification() Returns identification in plain java form.
RecordHolder	getOriginalRecord() Returns proxied record that is not proxy.
Object	getProperty(String name) Returns the property given the property name, if no such property exists, exception is thrown.
RecordHolder	getProxiedRecord() Returns proxied record.
int	getProxyLevel() For original record it returns 0.
RecordHolder	getRecordOnProxyLevel(int proxyLevel) Returns record on the defined proxy level or on the smaller level if such does not exist.
Collection<? extends RecordHolder>	getTouchedProxies() Returns touched proxies.
String	getVersionString() Returns version in string format.
int	hashCode()
boolean	hasOptimisticLockRelevantChanges() Returns true if record has changes of properties that affect optimistic lock version.
boolean	isProxy() Returns true if record is proxy.
boolean	isUpdateNecessary(String property) Returns true if association should be updated.
RecordHolder	mergeChanges(Namespace namespace, boolean cascade, boolean checkConflicts) If this is wrapper it merges all its changes to the wrapped record.
void	remove(boolean isCascaded) Removes record.
void	setProperty(String name, Object value) Sets the property given the property name.
void	setTempProperty(String name, String value) Deprecated. Will be removed in LSPS 3.3
void	setThisSideOfAssociation(String name, Object object) Sets value only this side of the association.

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

asMap, clearRuntimeValues, executeMethod, getAdapter, getBaseLevelHolder, getCompiled, getJavaObject, getNamespace, getType, isRemoved, setAdapter, setCompiled

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

getBaseLevelEntityId, getConverter, getEvaluationConverter, getHandle, getId, getModelInstance, getModelProviderService, getNotCompiledValue, getProcessModel, getVal, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

asMap, executeMethod, getBaseLevelEntityId, getBaseLevelHolder, getCompiled, getJavaObject, getNamespace, getType, isRemoved, setCompiled

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

getId, getNotCompiledValue

Constructor Detail

InternalRecordHolder

public InternalRecordHolder(RecordValue val,
                            ModelProviderClientService modelProviderService)

Creates new instance of InternalRecordHolder.

Parameters:

val -

modelProviderService -

Throws:

NullPointerException - if val or modelProviderService is null

InternalRecordHolder

public InternalRecordHolder(RecordValue val,
                            ModelProviderClientService modelProviderService,
                            Map<String,? extends Object> values)

Creates new instance of InternalRecordHolder.

Parameters:

val -

modelProviderService -

values -

Throws:

NullPointerException - if val or modelProviderService is null

Method Detail

getProperty

public Object getProperty(String name)

Description copied from interface: RecordHolder

Returns the property given the property name, if no such property exists, exception is thrown.

Specified by:

getProperty in interface RecordHolder

Returns:

the property given the property name

setProperty

public void setProperty(String name,
                        Object value)

Description copied from interface: RecordHolder

Sets the property given the property name.

Specified by:

setProperty in interface RecordHolder

getIdentificationString

public String getIdentificationString()

Description copied from interface: RecordHolder

Returns identification string (string form of primary key)

Specified by:

getIdentificationString in interface RecordHolder

Returns:

identification string

getVersionString

public String getVersionString()

Description copied from interface: RecordHolder

Returns version in string format.

Specified by:

getVersionString in interface RecordHolder

Returns:

version in string format

getJavaIdentification

public Object getJavaIdentification()

Description copied from interface: RecordHolder

Returns identification in plain java form.

Specified by:

getJavaIdentification in interface RecordHolder

Returns:

identification in plain java form

setTempProperty

@Deprecated
public void setTempProperty(String name,
                                        String value)

Deprecated. Will be removed in LSPS 3.3

Temp for old doc implementation

Parameters:

name -

value -

isUpdateNecessary

public boolean isUpdateNecessary(String property)

Description copied from interface: AssociationHandler

Returns true if association should be updated.

Specified by:

isUpdateNecessary in interface AssociationHandler

Overrides:

isUpdateNecessary in class RecordHolderBase<RecordValue>

Returns:

true if association should be updated

setThisSideOfAssociation

public void setThisSideOfAssociation(String name,
                                     Object object)

Description copied from interface: AssociationHandler

Sets value only this side of the association.

Specified by:

setThisSideOfAssociation in interface AssociationHandler

Overrides:

setThisSideOfAssociation in class RecordHolderBase<RecordValue>

remove

public void remove(boolean isCascaded)

Description copied from interface: RecordHolder

Removes record. If cascaded removes also orphaned entities.

Specified by:

remove in interface RecordHolder

hasOptimisticLockRelevantChanges

public boolean hasOptimisticLockRelevantChanges()

Description copied from interface: RecordHolder

Returns true if record has changes of properties that affect optimistic lock version.

Specified by:

hasOptimisticLockRelevantChanges in interface RecordHolder

Overrides:

hasOptimisticLockRelevantChanges in class RecordHolderBase<RecordValue>

Returns:

true if record has changes of properties that affect optimistic lock version

equals

public boolean equals(Object obj)

Overrides:

equals in class HolderImpl<RecordValue>

hashCode

public int hashCode()

Overrides:

hashCode in class HolderImpl<RecordValue>

createChangeProxy

public RecordHolder createChangeProxy()

Description copied from interface: RecordHolder

Creates change proxy on this record holder.

Specified by:

createChangeProxy in interface RecordHolder

Overrides:

createChangeProxy in class RecordHolderBase<RecordValue>

Returns:

change proxy on this record holder

mergeChanges

public RecordHolder mergeChanges(Namespace namespace,
                                 boolean cascade,
                                 boolean checkConflicts)
                          throws LspsException

Description copied from interface: RecordHolder

If this is wrapper it merges all its changes to the wrapped record. If cascaded is false it merges only the record. If cascaded is true it merges changes from all wrappers that can be accessed from the record and has same wrapper level. It returns wrapped record of the record with applied changes.

Specified by:

mergeChanges in interface RecordHolder

Overrides:

mergeChanges in class RecordHolderBase<RecordValue>

Returns:

wrapped record of the record with applied changes

Throws:

LspsException

getProxiedRecord

public RecordHolder getProxiedRecord()

Description copied from interface: RecordHolder

Returns proxied record.

Specified by:

getProxiedRecord in interface RecordHolder

Overrides:

getProxiedRecord in class RecordHolderBase<RecordValue>

Returns:

getRecordOnProxyLevel

public RecordHolder getRecordOnProxyLevel(int proxyLevel)

Description copied from interface: RecordHolder

Returns record on the defined proxy level or on the smaller level if such does not exist.

Specified by:

getRecordOnProxyLevel in interface RecordHolder

Overrides:

getRecordOnProxyLevel in class RecordHolderBase<RecordValue>

Returns:

proxied record on the defined proxy level or on the smaller level if such does not exist

getOriginalRecord

public RecordHolder getOriginalRecord()

Description copied from interface: RecordHolder

Returns proxied record that is not proxy.

Specified by:

getOriginalRecord in interface RecordHolder

Overrides:

getOriginalRecord in class RecordHolderBase<RecordValue>

Returns:

proxied record that is not proxy

getProxyLevel

public int getProxyLevel()

Description copied from interface: RecordHolder

For original record it returns 0. For proxy it returns "proxy level of "proxied record"+1.

Specified by:

getProxyLevel in interface RecordHolder

Overrides:

getProxyLevel in class RecordHolderBase<RecordValue>

Returns:

proxy level

createPropertyProxy

public void createPropertyProxy(HolderFactory holderFactory,
                                String property)

Description copied from interface: RecordHolder

Creates change proxy for all object referenced by the propery and sets the proxy values to the property.

Specified by:

createPropertyProxy in interface RecordHolder

Overrides:

createPropertyProxy in class RecordHolderBase<RecordValue>

getTouchedProxies

public Collection<? extends RecordHolder> getTouchedProxies()

Returns touched proxies. It is used to find all relevant entities on merge.

Returns:

touched proxies

isProxy

public boolean isProxy()

Description copied from interface: RecordHolder

Returns true if record is proxy.

Specified by:

isProxy in interface RecordHolder

Overrides:

isProxy in class RecordHolderBase<RecordValue>

Returns:

true if record is proxy