org.sandev.TaskHeap.HeapCalculator
Class HeapCalculatorNodeDecl

java.lang.Object
  org.sandev.TaskHeap.HeapCalculator.HeapCalculatorNodeDecl

Direct Known Subclasses:

HeapCalculatorNodeBase, HeapCalculatorNodeInstance

public class HeapCalculatorNodeDecl
extends java.lang.Object

The HeapCalculator is responsible for maintaining the heap display and making it available on demand. Updates to heap components pass through so the heap is updated immediately, and the calculator also listens for update notifications to handle updates made by other back end processing or other interface instances.

The heap display is stored as a transient field in the HeapAttributes and can be referenced directly from there, however that result would only be valid for the owning account viewing the heap from the top level. All other access requires filtering the resulting heap to show things like assignment indicators, drilldown displays and so forth. Because of this it is recommended that the heap display always be retrieved via query each time. Basically the HeapAttributes.heap field is reserved for use by this node.

Note the heap is only calculated for query where the HeapAttributes is specified by uniqueID. It is not computationally reasonable to calculate the heap display for several HeapAttributes at once.

All updates to the heap display should be handled within this node to enable module testing and maintenance.

An AuthUserLookup interface is implemented via a local peer node.
An IDLookup interface is implemented via a local peer node.

outbound synchronous message calls:

• AggregateUpdate callAggregateUpdate(AggregateUpdate msg)
  node instance configuration: outgoingSyncAggregateUpdate
• PlanCollection callPlanQuery(PlanQuery msg)
  node instance configuration: outgoingSyncPlanQuery

inbound synchronous message calls:

• HeapDisplay onReceive(HeapDisplay msg)
  node instance configuration: incomingSyncHeapDisplay
• AggregateUpdate onReceive(AggregateUpdate msg)
  node instance configuration: incomingSyncAggregateUpdate

inbound asynchronous message calls:

• void onDelivery(TaskUpdate msg)
  node instance configuration: incomingAsyncTaskSource
• void onDelivery(PlanUpdate msg)
  node instance configuration: incomingAsyncPlanSource
• void onDelivery(ExternalPlanUpdate msg)
  node instance configuration: incomingAsyncExternalPlanSource

Field Summary

protected java.lang.String	peerAuthUserLookupNode The instance name of our UserLookup node.
java.lang.String	peerIDLookupNode The instance name of a local node that implements IDLookup.

Constructor Summary

HeapCalculatorNodeDecl()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

peerAuthUserLookupNode

protected java.lang.String peerAuthUserLookupNode

The instance name of our UserLookup node. We rely on this local node to implement the AuthUserLookup part of the UIFormOwner interface.

Length in characters, normal: 30 max: 60

peerIDLookupNode

public java.lang.String peerIDLookupNode

The instance name of a local node that implements IDLookup.

Constructor Detail

HeapCalculatorNodeDecl

public HeapCalculatorNodeDecl()