com.whitestein.lsps.engine.state.xml

Class ExternalValue

java.lang.Object

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

com.whitestein.lsps.engine.state.xml.ExternalValue

All Implemented Interfaces:

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

public class ExternalValue
extends ComplexValue
implements RecordChangeProxy

Class used to represent an object that is not defined in the core model types.

Author:

rba

Field Summary

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

modelInstance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ExternalValue() Creates new empty instance of ExternalValue.
	ExternalValue(long id, ModelInstance modelInstance, String type, String objectIdentification, Long processInstanceId, String versionString, boolean renewVersion, boolean register, Long auditRevision) Creates new instance of ExternalValue.
	ExternalValue(ModelInstance modelInstance, String type, String objectIdentification, Long processInstanceId, Long auditRevision) Creates new instance of ExternalValue.

Method Summary

Modifier and Type	Method and Description
<T,E extends Throwable> T	accept(ValueVisitor<T,E> visitor) Accepts visitor.
void	addToCachedNonsharedAssociations(String name, ComplexValue value) Adds to cache of nonshared associations.
void	cleanAndSetRenewVersion() Cleans version string and sets renewVersion to true.
RecordValue	createChangeProxy() Created a change proxy on this object.
Long	getAuditRevision() Returns audit revision.
ComplexValue	getFromCachedNonsharedAssociations(String name) Returns value from to cache of nonshared associations.
Handle	getHandle() Returns handle.
String	getObjectIdentification() Returns the object identification.
String[]	getObjectIdentificationSegments() Returns segments of the identification.
RecordChangeProxy	getOriginalRecord() Returns a record object that is original non-proxy record.
ProcessInstance	getProcessInstance() Deprecated. information about process instance id is stored in the objectIdentificationSegments
Long	getProcessInstanceId() Deprecated. information about process instance id is stored in the objectIdentificationSegments
int	getProxyLevel() Gets number of proxies from this object to original non-proxy record.
Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
String	getVersionString() Returns string representation of the shared entity version.
boolean	hasObjectIdentification() Returns true if object identification is set.
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
boolean	isRenewVersion() Returns true if the version should be set to new value.
ExternalValue	makeCopy(ModelInstance targetModelInstance) Creates copy of the value in the target model instance.
void	postUnmarshal(javax.xml.bind.Unmarshaller unmarshaller, Object parent) Callback method invoked after unmarshalling XML data into target.
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	removeFromCacheNonsharedAssociation(String name) Removes from the nonshared association cache.
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.
void	revertRemove() Set this value to not removed.
void	setObjectIdentification(String objectIdentification) Sets the object identification.
void	setProcessInstanceId(Long processInstanceId) Deprecated. information about process instance id is stored in the objectIdentificationSegments
void	setRenewVersion(boolean renewVersion) Sets renewVersion value.
void	setVersionString(String versionString) Sets string representation of the shared entity version.
String	toString()
String	toUniqueKey() Returns unique key for this instance.

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

clear, collect, commonAfterUnmarshal, createContext, findReplacementId, getBaseLevelEntity, getBaseLevelEntityId, getCompiledType, getEvaluationLevel, getId, getLowerLevelEntity, getLowerLevelEntityId, getLowestLevelEntity, getLowestLevelEntityId, getModelInstance, getOwnContext, getType, internalVersionConflictMessage, isInternalyVersioned, isLocked, isLowestExistingEntity, isPersistent, 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

ExternalValue

protected ExternalValue()

Creates new empty instance of ExternalValue.

ExternalValue

public ExternalValue(ModelInstance modelInstance,
                     String type,
                     String objectIdentification,
                     Long processInstanceId,
                     Long auditRevision)

Creates new instance of ExternalValue.

Parameters:

modelInstance -

type -

objectIdentification -

processInstanceId -

auditRevision -

Throws:

NullPointerException - if modelInstance or type is null

ExternalValue

public ExternalValue(long id,
                     ModelInstance modelInstance,
                     String type,
                     String objectIdentification,
                     Long processInstanceId,
                     String versionString,
                     boolean renewVersion,
                     boolean register,
                     Long auditRevision)

Creates new instance of ExternalValue.

Parameters:

id -

modelInstance -

type -

objectIdentification -

processInstanceId -

versionString -

renewVersion -

register -

auditRevision -

Throws:

NullPointerException - if modelInstance or type is null

Method Detail

getObjectIdentification

public String getObjectIdentification()

Returns the object identification.

Returns:

the object identification

hasObjectIdentification

public boolean hasObjectIdentification()

Returns true if object identification is set.

Returns:

true if object identification is set

setObjectIdentification

public void setObjectIdentification(String objectIdentification)

Sets the object identification.

Parameters:

objectIdentification -

getProcessInstance

@Deprecated
public ProcessInstance getProcessInstance()

Deprecated. information about process instance id is stored in the objectIdentificationSegments

Returns the referenced process instance.

Returns:

the referenced process instance

getProcessInstanceId

@Deprecated
public Long getProcessInstanceId()

Deprecated. information about process instance id is stored in the objectIdentificationSegments

Returns the referenced process instance id.

Returns:

the referenced process instance id

setProcessInstanceId

@Deprecated
public void setProcessInstanceId(Long processInstanceId)

Deprecated. information about process instance id is stored in the objectIdentificationSegments

Sets the process instance id.

Parameters:

processInstanceId -

getHandle

public Handle getHandle()

Description copied from class: ComplexValue

Returns handle.

Overrides:

getHandle in class ComplexValue

Returns:

handle

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

toString

public String toString()

Overrides:

toString in class Object

toUniqueKey

public String toUniqueKey()

Returns unique key for this instance.

Returns:

unique key for this instance

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.

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

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

Overrides:

replaceIdAndEvaluationLevel in class ComplexValue

rebind

public void rebind(ModelInstance modelInstance)

Description copied from class: ComplexValue

Re-binds to a model instance.

Specified by:

rebind in interface ModelInstanceAware

Overrides:

rebind in class ComplexValue

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

remove

public void remove()

Set this value to removed.

revertRemove

public void revertRemove()

Set this value to not removed.

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

addToCachedNonsharedAssociations

public void addToCachedNonsharedAssociations(String name,
                                             ComplexValue value)

Adds to cache of nonshared associations.

Parameters:

name -

value -

removeFromCacheNonsharedAssociation

public void removeFromCacheNonsharedAssociation(String name)

Removes from the nonshared association cache.

Parameters:

name -

getFromCachedNonsharedAssociations

public ComplexValue getFromCachedNonsharedAssociations(String name)

Returns value from to cache of nonshared associations.

Parameters:

name -

Returns:

value from to cache of nonshared associations

makeCopy

public ExternalValue 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

getVersionString

public String getVersionString()

Returns string representation of the shared entity version.

Returns:

string representation of the shared entity version

setVersionString

public void setVersionString(String versionString)

Sets string representation of the shared entity version.

Parameters:

versionString -

isRenewVersion

public boolean isRenewVersion()

Returns true if the version should be set to new value.

Returns:

true if the version should be set to new value

setRenewVersion

public void setRenewVersion(boolean renewVersion)

Sets renewVersion value.

Parameters:

renewVersion -

cleanAndSetRenewVersion

public void cleanAndSetRenewVersion()

Cleans version string and sets renewVersion to true.

getAuditRevision

public Long getAuditRevision()

Returns audit revision.

Returns:

audit revision

getObjectIdentificationSegments

public String[] getObjectIdentificationSegments()

Returns segments of the identification.

Returns:

segments of the identification

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

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

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