com.whitestein.lsps.engine.state.xml

Class ComplexValue

java.lang.Object

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

All Implemented Interfaces:

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

Direct Known Subclasses:

CollectionValue, ExpressionValue, ExternalValue, MapValue, RecordValue

public abstract class ComplexValue
extends Object
implements Value, Collectible, EntityWithId, ModelInstanceAware, EvaluationLevelAware

Value representing complex types. It has its type in addition to Value. The type cannot be null.

Author:

rba

Field Summary

Fields

Modifier and Type	Field and Description
protected ModelInstance	modelInstance Model instance.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ComplexValue() Creates new empty instance of ComplexValue.
protected	ComplexValue(long id, ModelInstance modelInstance, String type, boolean register) Creates new instance of ComplexValue.
protected	ComplexValue(long id, ModelInstance modelInstance, String type, boolean register, String level, Long baseLevelValueId, Long lowestLevelValueId, Long lowerLevelValueId) Creates new instance of ComplexValue.
protected	ComplexValue(ModelInstance modelInstance, String type, boolean register) Creates new instance of ComplexValue.
protected	ComplexValue(ModelInstance modelInstance, String type, boolean register, String level, Long baseLevelValueId, Long lowestLevelValueId, Long lowerLevelValueId) Creates new instance of ComplexValue.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears evaluation data.
void	collect() Removes itself from the process.
protected void	commonAfterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Common actions in after unmarshal
protected Context	createContext(long parentContextId)
protected Long	findReplacementId(Map<Long,Long> replacementMap, Long oldId) Returns replacement id.
ComplexValue	getBaseLevelEntity() Returns base level value.
Long	getBaseLevelEntityId() Returns id of the corresponding value in base level.
Type	getCompiledType(ModelProviderClientService modelProviderService) Returns the compiled type.
String	getEvaluationLevel() Returns evaluation level of this value.
Handle	getHandle() Returns handle.
long	getId() Returns the id.
ComplexValue	getLowerLevelEntity() Returns lower level value.
Long	getLowerLevelEntityId() Returns id of the corresponding value in previous lower level.
ComplexValue	getLowestLevelEntity() Returns lowest level value.
Long	getLowestLevelEntityId() Returns id of the corresponding value in the lowest exiting level.
ModelInstance	getModelInstance() Returns the model instance.
Context	getOwnContext(long parentContextId) Returns own context
String	getType() Returns the type.
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	isLocked() Returns true if the context is read only.
boolean	isLowestExistingEntity() Returns true if this entity is the lowest existing entity.
boolean	isPersistent() Returns true if this object cannot be collected.
boolean	isRemoved() Returns true if value is removed
void	rebind(ModelInstance modelInstance) Re-binds to a model instance.
void	replaceIdAndEvaluationLevel(Long newId, Long newBaseId, String newEvaluationLevel) Replace id, base evaluation level entity id and evaluation level in the entity.
void	replaceReferencedIds(Map<Long,Long> replacementMap) Replace referenced ids according to mappings in the replacement map.
boolean	setLowerLevelEntityId(long lowerLevelId) Sets lower level entity id if it is correct value.
void	setPersistent(boolean persistent) Sets persistent flag.
SimpleValue	toSimpleValue() If this is SimpleValue this method returns this, otherwise it returns a ValueRef to this.
Value	toValue() If this is a ValueRef this method returns the referenced value, otherwise it returns this.
void	updateLevelData(Long baseLevelValueId, Long lowestLevelValueId, Long lowerLevelValueId) Updates references to the corresponding elements in other evaluation levels.

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.engine.state.xml.Value

accept, makeCopy

Methods inherited from interface com.whitestein.lsps.common.jaxb.UnmarshalCallback

postUnmarshal, preUnmarshal

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

getReferences

Field Detail

modelInstance

protected ModelInstance modelInstance

Model instance. Should be set by subclasses.

Constructor Detail

ComplexValue

protected ComplexValue()

Creates new empty instance of ComplexValue.

ComplexValue

protected ComplexValue(long id,
                       ModelInstance modelInstance,
                       String type,
                       boolean register,
                       String level,
                       Long baseLevelValueId,
                       Long lowestLevelValueId,
                       Long lowerLevelValueId)

Creates new instance of ComplexValue.

Parameters:

id -

modelInstance -

type -

register -

level -

baseLevelValueId -

lowestLevelValueId -

lowerLevelValueId -

Throws:

NullPointerException - if modelInstance or type is null

ComplexValue

protected ComplexValue(long id,
                       ModelInstance modelInstance,
                       String type,
                       boolean register)

Creates new instance of ComplexValue.

Parameters:

id -

modelInstance -

type -

register -

Throws:

NullPointerException - if modelInstance or type is null

ComplexValue

protected ComplexValue(ModelInstance modelInstance,
                       String type,
                       boolean register,
                       String level,
                       Long baseLevelValueId,
                       Long lowestLevelValueId,
                       Long lowerLevelValueId)

Creates new instance of ComplexValue.

Parameters:

modelInstance -

type -

register -

level -

baseLevelValueId -

lowestLevelValueId -

lowerLevelValueId -

Throws:

NullPointerException - if modelInstance or type is null

ComplexValue

protected ComplexValue(ModelInstance modelInstance,
                       String type,
                       boolean register)

Creates new instance of ComplexValue.

Parameters:

modelInstance -

type -

register -

Throws:

NullPointerException - if modelInstance or type is null

Method Detail

getId

public long getId()

Description copied from interface: EntityWithId

Returns the id.

Specified by:

getId in interface EntityWithId

Returns:

the id

getType

public String getType()

Description copied from interface: Value

Returns the type.

Specified by:

getType in interface Value

Returns:

the type

getHandle

public Handle getHandle()

Returns handle.

Returns:

handle

getCompiledType

public Type getCompiledType(ModelProviderClientService modelProviderService)

Description copied from interface: Value

Returns the compiled type.

Specified by:

getCompiledType in interface Value

Returns:

the compiled type

toSimpleValue

public SimpleValue toSimpleValue()

Description copied from interface: Value

If this is SimpleValue this method returns this, otherwise it returns a ValueRef to this.

Specified by:

toSimpleValue in interface Value

Returns:

a SimpleValue

toValue

public Value toValue()

Description copied from interface: Value

If this is a ValueRef this method returns the referenced value, otherwise it returns this.

Specified by:

toValue in interface Value

Returns:

a Value

getModelInstance

public ModelInstance getModelInstance()

Description copied from interface: ModelInstanceAware

Returns the model instance.

Specified by:

getModelInstance in interface ModelInstanceAware

Returns:

the model instance

setPersistent

public void setPersistent(boolean persistent)

Sets persistent flag.

Parameters:

persistent -

isPersistent

public boolean isPersistent()

Description copied from interface: Collectible

Returns true if this object cannot be collected.

Specified by:

isPersistent in interface Collectible

Returns:

collected

collect

public void collect()

Description copied from interface: Collectible

Removes itself from the process. This method is called only when the element is not persistence and is not referenced directly or indirectly from any other persistence element.

Specified by:

collect in interface Collectible

getEvaluationLevel

public String getEvaluationLevel()

Returns evaluation level of this value.

Specified by:

getEvaluationLevel in interface EvaluationLevelAware

Returns:

evaluation level of this value

isLocked

public boolean isLocked()

Returns true if the context is read only.

Specified by:

isLocked in interface EvaluationLevelAware

Returns:

true if the context is read only

rebind

public void rebind(ModelInstance modelInstance)

Re-binds to a model instance.

Specified by:

rebind in interface ModelInstanceAware

Parameters:

modelInstance -

replaceIdAndEvaluationLevel

public void replaceIdAndEvaluationLevel(Long newId,
                                        Long newBaseId,
                                        String newEvaluationLevel)

Description copied from interface: EvaluationLevelAware

Replace id, base evaluation level entity id and evaluation level in the entity.

Specified by:

replaceIdAndEvaluationLevel in interface EvaluationLevelAware

replaceReferencedIds

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

Replace referenced ids according to mappings in the replacement map.

Specified by:

replaceReferencedIds in interface EvaluationLevelAware

Parameters:

replacementMap -

findReplacementId

protected Long findReplacementId(Map<Long,Long> replacementMap,
                                 Long oldId)

Returns replacement id.

Parameters:

replacementMap -

oldId -

Returns:

replacement id

updateLevelData

public void updateLevelData(Long baseLevelValueId,
                            Long lowestLevelValueId,
                            Long lowerLevelValueId)

Description copied from interface: EvaluationLevelAware

Updates references to the corresponding elements in other evaluation levels.

Specified by:

updateLevelData in interface EvaluationLevelAware

getBaseLevelEntityId

public Long getBaseLevelEntityId()

Returns id of the corresponding value in base level.

Specified by:

getBaseLevelEntityId in interface EvaluationLevelAware

Returns:

id of the corresponding value in base level

getBaseLevelEntity

public ComplexValue getBaseLevelEntity()

Returns base level value.

Specified by:

getBaseLevelEntity in interface EvaluationLevelAware

Returns:

base level value

getLowestLevelEntityId

public Long getLowestLevelEntityId()

Returns id of the corresponding value in the lowest exiting level.

Specified by:

getLowestLevelEntityId in interface EvaluationLevelAware

Returns:

id of the corresponding value in the lowest exiting level

getLowestLevelEntity

public ComplexValue getLowestLevelEntity()

Returns lowest level value.

Specified by:

getLowestLevelEntity in interface EvaluationLevelAware

Returns:

lowest level value

isLowestExistingEntity

public boolean isLowestExistingEntity()

Description copied from interface: EvaluationLevelAware

Returns true if this entity is the lowest existing entity.

Specified by:

isLowestExistingEntity in interface EvaluationLevelAware

Returns:

true if this entity is the lowest existing entity

getLowerLevelEntityId

public Long getLowerLevelEntityId()

Returns id of the corresponding value in previous lower level.

Specified by:

getLowerLevelEntityId in interface EvaluationLevelAware

Returns:

id of the corresponding value in previous lower level

getLowerLevelEntity

public ComplexValue getLowerLevelEntity()

Returns lower level value.

Specified by:

getLowerLevelEntity in interface EvaluationLevelAware

Returns:

lower level value

setLowerLevelEntityId

public boolean setLowerLevelEntityId(long lowerLevelId)

Sets lower level entity id if it is correct value. In case of success returns true.

Parameters:

lowerLevelId -

Returns:

in case of success returns true

commonAfterUnmarshal

protected void commonAfterUnmarshal(javax.xml.bind.Unmarshaller unmarshaller,
                                    Object parent)

Common actions in after unmarshal

Parameters:

unmarshaller -

parent -

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

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

Returns:

message for internal versioning conflict

clear

public void clear()

Description copied from interface: EvaluationLevelAware

Clears evaluation data.

Specified by:

clear in interface EvaluationLevelAware

isRemoved

public boolean isRemoved()

Description copied from interface: Value

Returns true if value is removed

Specified by:

isRemoved in interface Value

Returns:

true if value is removed

createContext

protected Context createContext(long parentContextId)

getOwnContext

public Context getOwnContext(long parentContextId)

Returns own context

Parameters:

parentContextId -

Returns:

own context