com.edorasware.cmmn.model.persistence

Class CasePlanModelData

java.lang.Object

com.edorasware.cmmn.model.persistence.CasePlanModelData

public class CasePlanModelData
extends Object

A class to represent the state of a case (the state of the case’s casePlanModel). This class is serialized/deserialized to/from JSON in order to persist the state of a case.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CURRENT_VERSION <p>The latest, currently supported version of the data.

Constructor Summary

Constructors

Constructor and Description
CasePlanModelData()

Method Summary

Modifier and Type	Method and Description
void	addCaseFileItemState(String id, CaseFileItemData caseFileItemData) Put a caseFileItemData into the internal caseFileItemStates map by the provided ID.
void	addPlanItemState(String id, PlanItemData planItemData) Put a planItemData into the internal planItemStates map by the provided ID.
boolean	containsPlanItemData(String id) Check if a PlanItemData object key (Id) exists.
static CasePlanModelData	createFromJson(String json) De-serialize a JSON string into an object of this class.
Map<String,CaseFileItemData>	getCaseFileItemStates()
HashMap<String,String>	getClientProperties()
Integer	getDataVersion()
String	getParentClientId()
PlanItemData	getPlanItemData(String id) Get a PlanItemData object by key (Id).
Map<String,PlanItemData>	getPlanItemStates()
static Map<String,List<PlanItemData>>	getPlanItemStatesByPlanItemId(List<PlanItemData> stageChildren) Organize (group) a list of stage children by their respective plan Item Ids.
List<PlanItemData>	getStageChildren(String stageInstanceId) <p>Get a stage’s immediate children.
void	setClientProperties(HashMap<String,String> clientProperties)
void	setDataVersion(Integer dataVersion)
void	setParentClientId(String parentClientId)
static String	writeToJson(CasePlanModelData casePlanModelData) Serialize an instance of this class to a JSON string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CURRENT_VERSION

public static final int CURRENT_VERSION

<p>The latest, currently supported version of the data. Used during de-serialization of a JSON string to an object of this class.</p>

<p>Increment this version if there is a breaking change in the JSON representation of this class/object. Note, supporting new fields in this class or nested types is not a breaking change provided the added property is nullable and the implementation handles null values for the property gracefully.</p>

<ul> <li>Changes of field dataVersion up to version 6: various changes to member fields (pre-production releases).</li> <li>Change from version 6 to 7: changed instanceId delimiter from '' to '~'. </li> <li>Change from version 7 to 8: removed required property. The required property is now evaluated on demand.</li> <li>Change from version 8 to 9: renamed parentCaseId in CasePlanModelData to parentClientId</li> </ul>

See Also:

Constant Field Values

Constructor Detail

CasePlanModelData

public CasePlanModelData()

Method Detail

addPlanItemState

public void addPlanItemState(String id,
                             PlanItemData planItemData)

Put a planItemData into the internal planItemStates map by the provided ID.

Parameters:

id - the id

planItemData - the plan item data

addCaseFileItemState

public void addCaseFileItemState(String id,
                                 CaseFileItemData caseFileItemData)

Put a caseFileItemData into the internal caseFileItemStates map by the provided ID.

Parameters:

id - the id

caseFileItemData - the case item data

getStageChildren

public List<PlanItemData> getStageChildren(String stageInstanceId)

<p>Get a stage’s immediate children.</p>

<p>Consider re-write if we run into a mode of operation where we’re dealing with cases that have a lot of stages. The whole stage children initialization could be done with one loop over the plan item states. The current implementation runs the same loop once per stage.</p>

Parameters:

stageInstanceId - the stage instance id

Returns:

the list of plan item datas

getPlanItemStatesByPlanItemId

public static Map<String,List<PlanItemData>> getPlanItemStatesByPlanItemId(List<PlanItemData> stageChildren)

Organize (group) a list of stage children by their respective plan Item Ids.

Parameters:

stageChildren - the stage children (plan item data objects) to work on.

Returns:

a map mapping plan item Ids to plan item data instances.

getDataVersion

public Integer getDataVersion()

Returns:

the dataVersion

setDataVersion

public void setDataVersion(Integer dataVersion)

Parameters:

dataVersion - the dataVersion

getParentClientId

public String getParentClientId()

Returns:

the parent case id

setParentClientId

public void setParentClientId(String parentClientId)

Parameters:

parentClientId - the parent case id

getClientProperties

public HashMap<String,String> getClientProperties()

setClientProperties

public void setClientProperties(HashMap<String,String> clientProperties)

getPlanItemData

public PlanItemData getPlanItemData(String id)

Get a PlanItemData object by key (Id).

Parameters:

id - the id

Returns:

the plan item data

containsPlanItemData

public boolean containsPlanItemData(String id)

Check if a PlanItemData object key (Id) exists.

Parameters:

id - the id

Returns:

true if the plan item states contain the id

getPlanItemStates

public Map<String,PlanItemData> getPlanItemStates()

Returns:

the plan item states

getCaseFileItemStates

public Map<String,CaseFileItemData> getCaseFileItemStates()

createFromJson

public static CasePlanModelData createFromJson(String json)
                                        throws IOException

De-serialize a JSON string into an object of this class.

Parameters:

json - the JSON string

Returns:

the case plan model data

Throws:

IOException - if the passed JSON string could not be de-serialized.

writeToJson

public static String writeToJson(CasePlanModelData casePlanModelData)
                          throws IOException

Serialize an instance of this class to a JSON string.

Parameters:

casePlanModelData - the case plan model data

Returns:

the case plan model data as json

Throws:

IOException - if the passed casePlanModelData could not be serialized to a JSON string.