com.whitestein.lsps.engine.state.xml

Class RecordValue

java.lang.Object

com.whitestein.lsps.engine.state.xml.ComplexValue

com.whitestein.lsps.engine.state.xml.ComplexValueWithEvalLevels

com.whitestein.lsps.engine.state.xml.RecordValue

All Implemented Interfaces:

Collectible, CommonRecordValue, EntityWithId, EvaluationLevelAware, ModelInstanceAware, RecordChangeProxy, Value

public class RecordValue
extends ComplexValueWithEvalLevels
implements RecordChangeProxy, CommonRecordValue

Persistent value representing a record. A record is basically a map with given string keys (field names).

Author:

rba

Field Summary

Fields inherited from class com.whitestein.lsps.engine.state.xml.ComplexValue

modelInstance

Constructor Summary

Constructors

Constructor and Description
RecordValue(long id, ModelInstance modelInstance, String type, RecordType compiledType, Map<String,? extends Value> values) Creates new instance of RecordValue.
RecordValue(long id, ModelInstance modelInstance, String type, RecordType compiledType, Map<String,? extends Value> values, String level, long baseLevelValueId, ComplexValue lowerLevelValue) Creates new instance of RecordValue.
RecordValue(ModelInstance modelInstance, ExternalRecordType externalRecordType, RecordProxySetValue proxySet, boolean isLazySpreading) Creates change proxy on non-created external value and adds it provided proxy set.
RecordValue(ModelInstance modelInstance, String type, RecordType compiledType, Map<String,? extends Value> values) Creates new instance of RecordValue.
RecordValue(ModelInstance modelInstance, String type, RecordType compiledType, Map<String,? extends Value> values, String level, long baseLevelValueId, ComplexValue lowerLevelValue) Creates new instance of RecordValue.
RecordValue(RecordChangeProxy value, RecordProxySetValue proxySet, boolean isLazySpreading) Creates change proxy on record value.
RecordValue(SRecordValue source, ModelInstance modelInstance) Creates a new instance from the serialized companion.

Method Summary

Modifier and Type	Method and Description
<T,E extends Throwable> T	accept(ValueVisitor<T,E> visitor) Accepts visitor.
void	addPropertyToCreateProxy(String name)
void	clear() Clears evaluation data.
void	clearProxy(Collection<String> properties) Clear properties on proxy.
protected void	convertToDirectReferences()
RecordValue	createChangeProxy(RecordProxySetValue proxySet, boolean isLazySpreading) Created a change proxy on this object.
protected Context	createContext(long parentContextId)
RecordValue	createCopy(ModelInstance targetModelInstance) Creates a copy without references to other objects.
void	finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source, CopyHelper helper) Copy references.
Collection<? extends RecordValue>	getAllProxies() Returns all proxies of this record.
RecordType	getCachedCompiledType()
RecordType	getCompiledType(ModelProvider modelProvider) Returns the compiled type.
RecordChangeProxy	getOriginalRecord() Returns a record object that is original non-proxy record.
Context	getOwnContext(long parentContextId) Returns own context
Set<String>	getProperties() Returns the unmodifiable set of property names.
Value	getProperty(String name) Returns record property by its name or null if given property does not exist.
RecordChangeProxy	getProxiedRecord() Returns proxied record.
Long	getProxiedRecordId() Returns id of proxied record.
int	getProxyLevel() Gets number of proxies from this object to original non-proxy record.
RecordProxySetValue	getProxySet() Returns proxy set in which the proxy is registered.
Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
Long	getVersion()
boolean	hasProperties() Returns true if there is any property set.
boolean	hasProperty(String name) Returns true if the value contains the property.
boolean	isLazySpreadingProxy() Returns true if the proxy is lazy spreading.
boolean	isPropertyInitialValueChanged(String name) Returns true if the property with a given name changed its value.
boolean	isPropertyToCreateProxy(String name)
boolean	isProxy() Returns true if this is change proxy for a record.
boolean	isProxyOf(RecordChangeProxy record) Returns true if this is direct or non-direct proxy of the record.
boolean	isRemoved() Returns true if value is removed
void	rebind(ModelInstance modelInstance) Re-binds to a model instance.
void	refreshDirectReferences() Re-set references to elements from the same model instance.
void	remove() Set this value to removed.
void	replaceReferencedIds(Map<Long,Long> replacementMap) Replace referenced ids according to mappings in the replacement map.
void	setProperty(String name, Value value) Sets record property.
void	setProxiedRecord(CommonRecordValue val) Sets proxied record.
void	setProxySet(RecordProxySetValue proxySet)
void	setVersion(Long version)
SRecordValue	toSerializable(SModelInstance smi, MarshallerConfig config) Creates a serializable object.
String	toString()
Map<String,Value>	values() Returns the contained values.

Methods inherited from class com.whitestein.lsps.engine.state.xml.ComplexValueWithEvalLevels

fillSerializable, getBaseLevelEntity, getBaseLevelEntityId, getEvaluationLevel, getLowerLevelEntity, getLowerLevelEntityId, replaceIdAndEvaluationLevel, setLowerLevelEntity

Methods inherited from class com.whitestein.lsps.engine.state.xml.ComplexValue

collect, findReplacementId, getHandle, getId, getModelInstance, getType, isPersistent, toSimpleValue, toValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.whitestein.lsps.engine.state.xml.CommonRecordValue

getId, getModelInstance

Methods inherited from interface com.whitestein.lsps.engine.state.xml.Value

getType, toSimpleValue, toValue

Methods inherited from interface com.whitestein.lsps.engine.state.xml.Collectible

collect, isPersistent

Constructor Detail

RecordValue

public RecordValue(SRecordValue source,
                   ModelInstance modelInstance)

Creates a new instance from the serialized companion.

Parameters:

source -

modelInstance -

RecordValue

public RecordValue(long id,
                   ModelInstance modelInstance,
                   String type,
                   RecordType compiledType,
                   Map<String,? extends Value> values,
                   String level,
                   long baseLevelValueId,
                   ComplexValue lowerLevelValue)

Creates new instance of RecordValue.

Parameters:

id -

modelInstance -

type -

compiledType - a resolved type, may be null

values - a map of values, may be null

level -

baseLevelValueId -

lowerLevelValue -

Throws:

NullPointerException - if modelInstance or type or any of its elements is null

RecordValue

public RecordValue(long id,
                   ModelInstance modelInstance,
                   String type,
                   RecordType compiledType,
                   Map<String,? extends Value> values)

Creates new instance of RecordValue.

Parameters:

id -

modelInstance -

type -

compiledType - a resolved type, may be null

values - a map of values, may be null

Throws:

NullPointerException - if modelInstance or type or any of its elements is null

RecordValue

public RecordValue(ModelInstance modelInstance,
                   String type,
                   RecordType compiledType,
                   Map<String,? extends Value> values,
                   String level,
                   long baseLevelValueId,
                   ComplexValue lowerLevelValue)

Creates new instance of RecordValue.

Parameters:

modelInstance -

type -

compiledType - a resolved type, may be null

values - a map of values, may be null

level -

baseLevelValueId -

lowerLevelValue -

Throws:

NullPointerException - if modelInstance or type or any of its elements is null

RecordValue

public RecordValue(ModelInstance modelInstance,
                   String type,
                   RecordType compiledType,
                   Map<String,? extends Value> values)

Creates new instance of RecordValue.

Parameters:

modelInstance -

type -

compiledType - a resolved type, may be null

values - a map of values, may be null

Throws:

NullPointerException - if modelInstance or type or any of its elements is null

RecordValue

public RecordValue(RecordChangeProxy value,
                   RecordProxySetValue proxySet,
                   boolean isLazySpreading)

Creates change proxy on record value.

Parameters:

value -

proxySet -

isLazySpreading -

RecordValue

public RecordValue(ModelInstance modelInstance,
                   ExternalRecordType externalRecordType,
                   RecordProxySetValue proxySet,
                   boolean isLazySpreading)

Creates change proxy on non-created external value and adds it provided proxy set.

Parameters:

modelInstance -

externalRecordType -

proxySet -

isLazySpreading -

Method Detail

toSerializable

public SRecordValue toSerializable(SModelInstance smi,
                                   MarshallerConfig config)

Description copied from class: ComplexValueWithEvalLevels

Creates a serializable object.

Specified by:

toSerializable in interface Value

Specified by:

toSerializable in class ComplexValueWithEvalLevels

Returns:

a serializable object

getCompiledType

public RecordType getCompiledType(ModelProvider modelProvider)

Description copied from interface: Value

Returns the compiled type.

Specified by:

getCompiledType in interface Value

Overrides:

getCompiledType in class ComplexValue

Returns:

the compiled type

getCachedCompiledType

public RecordType getCachedCompiledType()

Returns:

the cached compiled type (or null)

hasProperty

public boolean hasProperty(String name)

Returns true if the value contains the property.

Parameters:

name -

Returns:

true if the value contains the property

setProperty

public void setProperty(String name,
                        Value value)

Sets record property. If such property does not exist, new property is created.

Parameters:

name - property name

value - new property value

Throws:

NullPointerException - if name or value is nuvoid checkConflictsOnInternalVersions(EvaluationLevelAware entity);ll

getProperty

public Value getProperty(String name)

Returns record property by its name or null if given property does not exist.

Parameters:

name -

Returns:

record

Throws:

NullPointerException - if name is null

getProperties

public Set<String> getProperties()

Returns the unmodifiable set of property names.

Returns:

the set of property names

hasProperties

public boolean hasProperties()

Returns true if there is any property set.

It is equivalent to !getProperties().isEmpty().

Returns:

true if there is any property set

values

public Map<String,Value> values()

Returns the contained values.

Returns:

the contained values

toString

public String toString()

Overrides:

toString in class Object

accept

public <T,E extends Throwable> T accept(ValueVisitor<T,E> visitor)
                                 throws E extends Throwable

Description copied from interface: Value

Accepts visitor.

Specified by:

accept in interface Value

Returns:

the result

Throws:

E

E extends Throwable

getReferences

public Collection<Collectible> getReferences()

Description copied from interface: Collectible

Returns collection of all referenced collectible objects.

Specified by:

getReferences in interface Collectible

Returns:

collection of all referenced collectible objects

replaceReferencedIds

public void replaceReferencedIds(Map<Long,Long> replacementMap)

Description copied from class: ComplexValueWithEvalLevels

Replace referenced ids according to mappings in the replacement map.

Specified by:

replaceReferencedIds in interface EvaluationLevelAware

Overrides:

replaceReferencedIds in class ComplexValueWithEvalLevels

rebind

public void rebind(ModelInstance modelInstance)

Re-binds to a model instance.

Specified by:

rebind in interface ModelInstanceAware

Overrides:

rebind in class ComplexValue

Parameters:

modelInstance -

clear

public void clear()

Description copied from interface: EvaluationLevelAware

Clears evaluation data.

Specified by:

clear in interface EvaluationLevelAware

Overrides:

clear in class ComplexValue

clearProxy

public void clearProxy(Collection<String> properties)

Clear properties on proxy.

Parameters:

properties -

isRemoved

public boolean isRemoved()

Description copied from interface: Value

Returns true if value is removed

Specified by:

isRemoved in interface Value

Overrides:

isRemoved in class ComplexValue

Returns:

true if value is removed

remove

public void remove()

Set this value to removed.

createCopy

public RecordValue createCopy(ModelInstance targetModelInstance)

Creates a copy without references to other objects.

Returns:

creates a copy

finishCopy

public void finishCopy(com.whitestein.lsps.engine.state.xml.Copiable source,
                       CopyHelper helper)

Copy references.

Overrides:

finishCopy in class ComplexValueWithEvalLevels

createChangeProxy

public RecordValue createChangeProxy(RecordProxySetValue proxySet,
                                     boolean isLazySpreading)

Description copied from interface: RecordChangeProxy

Created a change proxy on this object.

Specified by:

createChangeProxy in interface RecordChangeProxy

Returns:

a change proxy on this object

isProxy

public boolean isProxy()

Returns true if this is change proxy for a record.

Returns:

true if this is change proxy for a record

isProxyOf

public boolean isProxyOf(RecordChangeProxy record)

Description copied from interface: RecordChangeProxy

Returns true if this is direct or non-direct proxy of the record.

Specified by:

isProxyOf in interface RecordChangeProxy

Returns:

true if this is direct or non-direct proxy of the record

getAllProxies

public Collection<? extends RecordValue> getAllProxies()

Returns all proxies of this record.

Returns:

all proxies of this record

getProxiedRecordId

public Long getProxiedRecordId()

Returns id of proxied record. If isProxy() returns true and proxied record id is null it means that this is proxy for external/shared record that is not created so far.

Returns:

id of proxied record

getProxiedRecord

public RecordChangeProxy getProxiedRecord()

Returns proxied record.

Returns:

proxied record

getProxyLevel

public int getProxyLevel()

Description copied from interface: RecordChangeProxy

Gets number of proxies from this object to original non-proxy record. If this is not a proxy it returns 0. If this is a proxy it returns "proxy level of proxied object" + 1.

Specified by:

getProxyLevel in interface RecordChangeProxy

Returns:

level of wrapping for this object

getProxySet

public RecordProxySetValue getProxySet()

Description copied from interface: RecordChangeProxy

Returns proxy set in which the proxy is registered.

Specified by:

getProxySet in interface RecordChangeProxy

Returns:

proxy set in which the proxy is registered

isLazySpreadingProxy

public boolean isLazySpreadingProxy()

Description copied from interface: RecordChangeProxy

Returns true if the proxy is lazy spreading. It means that all accessed properties are automatically converted to proxy objects and the created proxies are again lazy spreading.

Specified by:

isLazySpreadingProxy in interface RecordChangeProxy

Returns:

true if the proxy is lazy spreading

getOriginalRecord

public RecordChangeProxy getOriginalRecord()

Description copied from interface: RecordChangeProxy

Returns a record object that is original non-proxy record. If this is a proxy it returns proxied object recursively. If this is not proxy it returns itself.

Specified by:

getOriginalRecord in interface RecordChangeProxy

Returns:

a record object that is original non-proxy record

setProxiedRecord

public void setProxiedRecord(CommonRecordValue val)

Sets proxied record. Throws exception if this is not a proxy or if already set.

Parameters:

val -

setProxySet

public void setProxySet(RecordProxySetValue proxySet)

convertToDirectReferences

protected void convertToDirectReferences()

Overrides:

convertToDirectReferences in class ComplexValueWithEvalLevels

refreshDirectReferences

public void refreshDirectReferences()

Description copied from interface: EvaluationLevelAware

Re-set references to elements from the same model instance.

Specified by:

refreshDirectReferences in interface EvaluationLevelAware

Overrides:

refreshDirectReferences in class ComplexValueWithEvalLevels

isPropertyInitialValueChanged

public boolean isPropertyInitialValueChanged(String name)

Returns true if the property with a given name changed its value.

Parameters:

name -

Returns:

true if the property with a given name changed its value

createContext

protected Context createContext(long parentContextId)

getOwnContext

public Context getOwnContext(long parentContextId)

Returns own context

Specified by:

getOwnContext in interface CommonRecordValue

Parameters:

parentContextId -

Returns:

own context

getVersion

public Long getVersion()

setVersion

public void setVersion(Long version)

isPropertyToCreateProxy

public boolean isPropertyToCreateProxy(String name)

addPropertyToCreateProxy

public void addPropertyToCreateProxy(String name)