org.sandev.TaskHeap.structs
Class PlanTreeElementStruct

java.lang.Object
  org.sandev.TaskHeap.structs.PlanTreeElementStruct

Direct Known Subclasses:

PlanTreeElement

public class PlanTreeElementStruct

extends java.lang.Object

A single line representation of a PlanComponent used for the summary outline display. The outline display is the main view of the heap, and allows you to see the overall structure, what has changed recently, time estimates, and estimated completion dates.

This message is a tree of values.
summary fields: outlinePath name planComponentID timeEstimate targetCompletion slack status activityColor totalTime indentUnderscores lineNumber lineBackground planStatus currPlanOffset assignedTo dueDate dueColor

Field Summary

protected java.lang.String	activityColor The chromacoding color for this entry.
protected int	assignedTo An indicator as to whether this PlanComponent is assigned to you, somebody else, or nobody.
protected PlanTreeElementStruct[]	children The children of this element.
protected int	currPlanOffset Tells where this element is relative to the current plan.
protected java.lang.String	dueColor The chromacoding color for the due date.
protected java.lang.String	dueDate The dueDate of the referenced component retrieved as a canonical string like targetCompletion.
protected java.lang.String	indentUnderscores The indent level represented as a string of periods.
protected java.util.Date	lastModifiedTime The lastModifiedTime of the referenced component.
protected java.lang.String	lineBackground The background color to use for this line.
protected int	lineNumber The line number of this element within the overall tree.
protected java.lang.String	name The name of the referenced PlanComponent
protected java.lang.String	outlinePath The outline identification for this referenced PlanComponent.
protected PlanTreeElementStruct	parent The parent of this element.
protected long	planComponentID The PlanComponent this tree element represents.
protected int	planStatus And indication of whether this is a plan, and whether it is the current plan.
protected long	slack The time between the targetCompletion and the dueDate.
protected java.lang.String	status The status of the referenced plan component.
protected java.lang.String	targetCompletion The targeted completion day.
protected long	timeEstimate The estimated number of hours necessary to complete this reference component.
protected long	totalTime The total number of estimated hours for this component.

Constructor Summary

PlanTreeElementStruct()

Methods inherited from class java.lang.Object

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

Field Detail

planComponentID

protected long planComponentID

The PlanComponent this tree element represents.

reference to class: org.sandev.TaskHeap.structs.PlanComponentStruct

name

protected java.lang.String name

The name of the referenced PlanComponent

declared invalid value: "TASKHEAP_INVALID_NAME"
Length in characters, normal: 30 max: 80

outlinePath

protected java.lang.String outlinePath

The outline identification for this referenced PlanComponent. This is the path to the current element from the heap top level. A typical example value might be "1.2.2".

declared invalid value: "TASKHEAP_INVALID_OUTLINEPATH"
Length in characters, normal: 30 max: 80

timeEstimate

protected long timeEstimate

The estimated number of hours necessary to complete this reference component.

declared default value: 0
range match expression: >= 0

totalTime

protected long totalTime

The total number of estimated hours for this component.

declared default value: 0
range match expression: >= 0

targetCompletion

protected java.lang.String targetCompletion

The targeted completion day. This is the timeEstimate added to the current ElapsedTimeAccumulator and retrieved as a canonical day string.

slack

protected long slack

The time between the targetCompletion and the dueDate. When this number gets small, risk of project slip increases. When this goes negative, the corresponding component is overdue.

status

protected java.lang.String status

The status of the referenced plan component. For Tasks, this is the TaskPhase name, for Plans this is "Plan" and for ExternalPlans this is "ExternalPlan".

activityColor

protected java.lang.String activityColor

The chromacoding color for this entry. This is based on the number of days since the referenced PlanComponent was last modified.

parent

protected PlanTreeElementStruct parent

The parent of this element.

this field holds a reference to the parent instance in the tree.

children

protected PlanTreeElementStruct[] children

The children of this element.

this field holds child references in the tree.

lastModifiedTime

protected java.util.Date lastModifiedTime

The lastModifiedTime of the referenced component.

indentUnderscores

protected java.lang.String indentUnderscores

The indent level represented as a string of periods. This can be translated into spaces or other characters as needed to form a hard indent display.

lineNumber

protected int lineNumber

The line number of this element within the overall tree.

lineBackground

protected java.lang.String lineBackground

The background color to use for this line. This is based on the current index and root parent.

planStatus

protected int planStatus

And indication of whether this is a plan, and whether it is the current plan.

declared default value: NONPLAN

enumerated constant values:

• _NONPLAN = 0
  
• _NOTCURRENT = 1
  
• _CURRPLAN = 2
  

declared invalid value: -1

currPlanOffset

protected int currPlanOffset

Tells where this element is relative to the current plan. When moving a component to the current plan, it should be prepended if it is being pushed down from above, and appended if it is being moved up from below. This helps indicate what should be done.

declared default value: BEFORE

enumerated constant values:

• _BEFORE = 0
  
• _AFTER = 1
  

declared invalid value: -1

assignedTo

protected int assignedTo

An indicator as to whether this PlanComponent is assigned to you, somebody else, or nobody. Used to drive display focus indicators.

declared default value: NOBODY

enumerated constant values:

• _NOBODY = 0
  
• _YOU = 1
  
• _OTHER = 2
  

declared invalid value: -1

dueDate

protected java.lang.String dueDate

The dueDate of the referenced component retrieved as a canonical string like targetCompletion.

dueColor

protected java.lang.String dueColor

The chromacoding color for the due date. This is based on the number of days remaining until the dueDate will be reached.

Constructor Detail

PlanTreeElementStruct

public PlanTreeElementStruct()