org.sandev.TaskHeap.PlanCalculator
Class PlanCalculatorNodeDecl

java.lang.Object
  org.sandev.TaskHeap.PlanCalculator.PlanCalculatorNodeDecl

Direct Known Subclasses:

PlanCalculatorNodeBase, PlanCalculatorNodeInstance

public class PlanCalculatorNodeDecl

extends java.lang.Object

The PlanCalculator calculates the timeEstimate for a plan. You send it a PlanRecalc, and it sends you back the plan with the time estimate filled in. A website deployment will typically run one instance of this node to provide plan calculation support for all heap users. A standalone client application might run its own local instance of this node to allow users to work through various scenarios without updating the central heap.

PlanComponents are updated separately. There is no "locking" behavior for plans, and recalculation is done off of the data retrieved at the time. Transaction locking is optimistic.

outbound synchronous message calls:

• PlanCollection callPlanQuery(PlanQuery msg)
  node instance configuration: outgoingSyncPlanQuery
• TaskCollection callTaskQuery(TaskQuery msg)
  node instance configuration: outgoingSyncTaskQuery
• ExternalPlanCollection callExternalPlanQuery(ExternalPlanQuery msg)
  node instance configuration: outgoingSyncExternalPlanQuery
• Ping callUpdaterNode(Ping msg)
  node instance configuration: outgoingSyncUpdaterNode

inbound synchronous message calls:

• PlanRecalc onReceive(PlanRecalc msg)
  node instance configuration: incomingSyncPlanRecalc

outbound asynchronous message sends:

• void send(Plan msg)
  node instance configuration: outgoingAsyncPlan

Field Summary

java.lang.String	iDLookupInstanceName The instance name of a local node that implements IDLookup.
int	recursionLevel When recalculating a plan, the calculator walks the tree of plan components starting from the given plan.

Constructor Summary

PlanCalculatorNodeDecl()

Methods inherited from class java.lang.Object

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

Field Detail

recursionLevel

public int recursionLevel

When recalculating a plan, the calculator walks the tree of plan components starting from the given plan. It is often unnecessary to recurse the entire depth of the tree, if a plan component is owned by somebody else, then it is typically their responsibility to update it. The default recursion setting stops when it encounters a Plan that is owned by someone else.

If a plan component is not owned, then it is included as part of the calculation for its immediately containing plan, according to the current top level plan being calculated.

declared default value: FULL

enumerated constant values:

• _OWNER = 0
  
• _FULL = 1
  

iDLookupInstanceName

public java.lang.String iDLookupInstanceName

The instance name of a local node that implements IDLookup. We use this to retrieve plan component information not passed in during computation.

Constructor Detail

PlanCalculatorNodeDecl

public PlanCalculatorNodeDecl()