com.whitestein.lsps.engine.state.xml

Class CollectionValue

java.lang.Object

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

com.whitestein.lsps.engine.state.xml.CollectionValue

All Implemented Interfaces:

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

Direct Known Subclasses:

ListValue, SetValue

public abstract class CollectionValue
extends ComplexValue

Collection value.

Author:

bhl

Field Summary

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

modelInstance

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionValue() Creates an empty instance.
protected	CollectionValue(long id, ModelInstance modelInstance, String type, Collection<? extends Value> values) Creates new instance of CollectionValue.
protected	CollectionValue(long id, ModelInstance modelInstance, String type, Collection<? extends Value> values, String level, Long baseLevelValueId, Long lowestLevelValueId, Long lowerLevelValueId) Creates new instance of CollectionValue.

Method Summary

Modifier and Type	Method and Description
protected List<Value>	copyValues(ModelInstance targetModelInstance) Copies the values into the target model instance.
Value	get(int i) Returns i-th element of the collection.
Collection<Collectible>	getReferences() Returns collection of all referenced collectible objects.
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	replaceReferencedIds(Map<Long,Long> replacementMap) Replace referenced ids according to mappings in the replacement map.
void	setValues(Collection<? extends Value> values) Sets the list values.
int	size() Returns the element count.
String	toString()
List<Value>	values() Returns collection of values.

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

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

accept, makeCopy

Constructor Detail

CollectionValue

protected CollectionValue()

Creates an empty instance.

CollectionValue

protected CollectionValue(long id,
                          ModelInstance modelInstance,
                          String type,
                          Collection<? extends Value> values,
                          String level,
                          Long baseLevelValueId,
                          Long lowestLevelValueId,
                          Long lowerLevelValueId)

Creates new instance of CollectionValue.

Parameters:

id -

modelInstance -

type -

values - contained values

level -

baseLevelValueId -

lowestLevelValueId -

lowerLevelValueId -

Throws:

NullPointerException - if modelInstance or type or values is null or values contains null

CollectionValue

protected CollectionValue(long id,
                          ModelInstance modelInstance,
                          String type,
                          Collection<? extends Value> values)

Creates new instance of CollectionValue.

Parameters:

id -

modelInstance -

type -

values - contained values

Throws:

NullPointerException - if modelInstance or type or values is null or values contains null

Method Detail

size

public int size()

Returns the element count.

Returns:

the element count

get

public Value get(int i)

Returns i-th element of the collection.

Parameters:

i -

Returns:

i-th element of the collection

Throws:

IllegalArgumentException - if the i is out of bounds

values

public List<Value> values()

Returns collection of values.

Returns:

collection of values

setValues

public void setValues(Collection<? extends Value> values)

Sets the list values.

Parameters:

values -

toString

public String toString()

Overrides:

toString in class Object

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.

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.

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

getReferences

public Collection<Collectible> getReferences()

Description copied from interface: Collectible

Returns collection of all referenced collectible objects.

Returns:

collection of all referenced collectible objects

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 -

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

copyValues

protected List<Value> copyValues(ModelInstance targetModelInstance)

Copies the values into the target model instance.

Parameters:

targetModelInstance -

Returns:

a list of copies