com.whitestein.lsps.engine.state.xml

Class RecordValue

java.lang.Object

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

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

All Implemented Interfaces:

MarshalCallback, UnmarshalCallback, Collectible, EntityWithId, EvaluationLevelAware, ModelInstanceAware, RecordChangeProxy, Value, XmlEntity

public class RecordValue
extends ComplexValue
implements RecordChangeProxy, MarshalCallback

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

Modifier	Constructor and Description
protected	RecordValue() Creates new instance of RecordValue.
	RecordValue(ExternalValue value) Creates change proxy on external value.
	RecordValue(long id, ModelInstance modelInstance, String type, Map<String,? extends Value> values) Creates new instance of RecordValue.
	RecordValue(long id, ModelInstance modelInstance, String type, Map<String,? extends Value> values, String level, Long baseLevelValueId, Long lowestLevelValueId, Long lowerLevelValueId) Creates new instance of RecordValue.
	RecordValue(long id, ModelInstance modelInstance, String type, Map<String,? extends Value> values, String level, Long baseLevelValueId, Long lowestLevelValueId, Long lowerLevelValueId, boolean isChangeProxy, Long proxiedRecordId) Creates new instance of RecordValue.
	RecordValue(ModelInstance modelInstance, ExternalRecordType externalRecordType) Creates change proxy on non-created external value.
	RecordValue(ModelInstance modelInstance, String type, Map<String,? extends Value> values) Creates new instance of RecordValue.
	RecordValue(ModelInstance modelInstance, String type, Map<String,? extends Value> values, String level, Long baseLevelValueId, Long lowestLevelValueId, Long lowerLevelValueId) Creates new instance of RecordValue.
	RecordValue(RecordValue value) Creates change proxy on record value.

Method Summary

Modifier and Type	Method and Description
<T,E extends Throwable> T	accept(ValueVisitor<T,E> visitor) Accepts visitor.
void	clear() Clears evaluation data.
void	clearProxy(Collection<String> properties) Clear properties on proxy.
void	clearTouchedProxies() Clears touched proxies.
RecordValue	createChangeProxy() Created a change proxy on this object.
Collection<? extends RecordValue>	getAllProxies() Returns all proxies of this record.
RecordChangeProxy	getOriginalRecord() Returns a record object that is original non-proxy record.
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.
Long	getPropertyInitialVersion(String name) Returns initial version of the property.
Long	getPropertyVersion(String name) Returns version of the property.
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.
Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
Set<RecordValue>	getTouchedProxies() Returns touched proxies that are or were in association with this proxy.
String	getVersionString()
boolean	hasProperties() Returns true if there is any property set.
boolean	hasProperty(String name) Returns true if the value contains the property.
protected void	initItemsMap() Initializes item map.
String	internalVersionConflictMessage(EvaluationLevelAware entity) Returns message for internal versioning conflict.
boolean	isInternalyVersioned() Returns true if the entity is internally (in scope of model instance) versioned.
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
RecordValue	makeCopy(ModelInstance targetModelInstance) Creates copy of the value in the target model instance.
void	postMarshal(javax.xml.bind.Marshaller marshaller) Callback method invoked after marshalling source to XML.
void	postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Callback method invoked after unmarshalling XML data into target.
void	preMarshal(javax.xml.bind.Marshaller marshaller) Callback method invoked before marshalling from source to XML.
void	preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Callback method invoked before unmarshalling into target.
void	rebind(ModelInstance modelInstance) Re-binds to a 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(ExternalValue val) Sets proxied record.
void	setVersionString(String versionString)
String	toString()
Map<String,Value>	values() Returns the contained values.

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

collect, commonAfterUnmarshal, createContext, findReplacementId, getBaseLevelEntity, getBaseLevelEntityId, getCompiledType, getEvaluationLevel, getHandle, getId, getLowerLevelEntity, getLowerLevelEntityId, getLowestLevelEntity, getLowestLevelEntityId, getModelInstance, getOwnContext, getType, isLocked, isLowestExistingEntity, isPersistent, replaceIdAndEvaluationLevel, setLowerLevelEntityId, setPersistent, toSimpleValue, toValue, updateLevelData

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.Value

getCompiledType, getType, toSimpleValue, toValue

Constructor Detail

RecordValue

protected RecordValue()

Creates new instance of RecordValue.

RecordValue

public RecordValue(long id,
                   ModelInstance modelInstance,
                   String type,
                   Map<String,? extends Value> values,
                   String level,
                   Long baseLevelValueId,
                   Long lowestLevelValueId,
                   Long lowerLevelValueId)

Creates new instance of RecordValue.

Parameters:

id -

modelInstance -

type -

values - a map of values, may be null

level -

baseLevelValueId -

lowestLevelValueId -

lowerLevelValueId -

Throws:

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

RecordValue

public RecordValue(long id,
                   ModelInstance modelInstance,
                   String type,
                   Map<String,? extends Value> values,
                   String level,
                   Long baseLevelValueId,
                   Long lowestLevelValueId,
                   Long lowerLevelValueId,
                   boolean isChangeProxy,
                   Long proxiedRecordId)

Creates new instance of RecordValue.

Parameters:

id -

modelInstance -

type -

values - a map of values, may be null

level -

baseLevelValueId -

lowestLevelValueId -

lowerLevelValueId -

isChangeProxy -

proxiedRecordId -

Throws:

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

RecordValue

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

Creates new instance of RecordValue.

Parameters:

id -

modelInstance -

type -

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,
                   Map<String,? extends Value> values,
                   String level,
                   Long baseLevelValueId,
                   Long lowestLevelValueId,
                   Long lowerLevelValueId)

Creates new instance of RecordValue.

Parameters:

modelInstance -

type -

values - a map of values, may be null

level -

baseLevelValueId -

lowestLevelValueId -

lowerLevelValueId -

Throws:

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

RecordValue

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

Creates new instance of RecordValue.

Parameters:

modelInstance -

type -

values - a map of values, may be null

Throws:

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

RecordValue

public RecordValue(RecordValue value)

Creates change proxy on record value.

Parameters:

value -

RecordValue

public RecordValue(ExternalValue value)

Creates change proxy on external value.

Parameters:

value -

RecordValue

public RecordValue(ModelInstance modelInstance,
                   ExternalRecordType externalRecordType)

Creates change proxy on non-created external value.

Parameters:

modelInstance -

externalRecordType -

Method Detail

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

clearTouchedProxies

public void clearTouchedProxies()

Clears touched proxies.

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

getPropertyInitialVersion

public Long getPropertyInitialVersion(String name)

Returns initial version of the property.

Parameters:

name -

Returns:

initial version of the property

getPropertyVersion

public Long getPropertyVersion(String name)

Returns version of the property.

Parameters:

name -

Returns:

version of the property

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

preMarshal

public void preMarshal(javax.xml.bind.Marshaller marshaller)

Description copied from interface: MarshalCallback

Callback method invoked before marshalling from source to XML.

This method is invoked just before marshalling process starts to marshal source.

Specified by:

preMarshal in interface MarshalCallback

postMarshal

public void postMarshal(javax.xml.bind.Marshaller marshaller)

Description copied from interface: MarshalCallback

Callback method invoked after marshalling source to XML.

This method is invoked after source and all its descendants have been marshalled.

Specified by:

postMarshal in interface MarshalCallback

preUnmarshal

public void preUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                         Object parent)

Description copied from interface: UnmarshalCallback

Callback method invoked before unmarshalling into target.

This method is invoked immediately after target was created and before the unmarshalling of this object begins.

Specified by:

preUnmarshal in interface UnmarshalCallback

parent - instance of JAXB mapped class that will eventually reference target. null when target is root element.

postUnmarshal

public void postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                          Object parent)

Description copied from interface: UnmarshalCallback

Callback method invoked after unmarshalling XML data into target.

This method is invoked after all the properties (except IDREF) are unmarshalled into target, but before target is set into its parent object.

Specified by:

postUnmarshal in interface UnmarshalCallback

parent - instance of JAXB mapped class that will reference target. null when target is root element.

initItemsMap

protected void initItemsMap()

Initializes item map.

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: ComplexValue

Replace referenced ids according to mappings in the replacement map.

Specified by:

replaceReferencedIds in interface EvaluationLevelAware

Overrides:

replaceReferencedIds in class ComplexValue

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 -

isInternalyVersioned

public boolean isInternalyVersioned()

Description copied from interface: EvaluationLevelAware

Returns true if the entity is internally (in scope of model instance) versioned.

Specified by:

isInternalyVersioned in interface EvaluationLevelAware

Overrides:

isInternalyVersioned in class ComplexValue

Returns:

true if the entity is internally (in scope of model instance) versioned

internalVersionConflictMessage

public String internalVersionConflictMessage(EvaluationLevelAware entity)

Description copied from interface: EvaluationLevelAware

Returns message for internal versioning conflict. Returns null if there is no conflict.

Specified by:

internalVersionConflictMessage in interface EvaluationLevelAware

Overrides:

internalVersionConflictMessage in class ComplexValue

Returns:

message for internal versioning conflict

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.

makeCopy

public RecordValue makeCopy(ModelInstance targetModelInstance)

Description copied from interface: Value

Creates copy of the value in the target model instance.

Specified by:

makeCopy in interface Value

Returns:

copy of the value in the target model instance

createChangeProxy

public RecordValue createChangeProxy()

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

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(ExternalValue val)

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

Parameters:

val -

getTouchedProxies

public Set<RecordValue> getTouchedProxies()

Returns touched proxies that are or were in association with this proxy.

Returns:

touched proxies

getVersionString

public String getVersionString()

setVersionString

public void setVersionString(String versionString)