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 shortDescription planComponentID timeEstimate targetCompletion slack status activityColor totalTime indentUnderscores lineNumber lineBackground planStatus currPlanOffset itemExpansion assignedTo dueDate dueColor parent.planComponentID="parentID" org.sandev.TaskHeap.util.DisplayUtil.childIndex(this,lookup,user)="childIndex"
declared printname: Plan Outline
help text: A tree display showing a one line summary for each contained plan or task. This is the main heap display showing the overall structure, what has changed recently, time estimates, and estimated completion dates.

Field Summary

protected java.lang.String	activityColor The chromacoding color for this entry.
protected int	assignedTo A responsibility assignment indicator.
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 underscores.
protected int	itemExpansion An indication of whether this item is an expanded or collapsed plan, or static.
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 An indication of whether this is a plan, and whether it is the current plan.
protected RelativeDeadlineStruct	reldef The relative deadline definition if applicable.
protected long[]	responsibilities The roles responsible for oversight of this work item.
protected java.lang.String	shortDescription The first part of the full description, used to provide additional detail if needed.
protected int	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 int	timeEstimate The estimated number of hours necessary to complete this reference component.
protected int	totalTime The total number of estimated hours for this component.

Constructor Summary

PlanTreeElementStruct()

Method Summary

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
declared printname: plan component ID
help text: The task or plan this tree element represents.

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
help text: The name of the referenced task or plan

shortDescription

protected java.lang.String shortDescription

The first part of the full description, used to provide additional detail if needed.

declared printname: short description
help text: The first part of the full description, used to provide additional detail if needed.

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
declared printname: outline path
help text: The outline identification of the referenced task or plan. This is the path to the current element from the heap top level, so for example "1.2.2" would represent the 1st plan's second contained plan's second item.

indentUnderscores

protected java.lang.String indentUnderscores

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

declared printname: indent underscores
help text: The indent level represented as a string of underscores. This is translated into spaces to create the indent display.

lineNumber

protected int lineNumber

The line number of this element within the overall tree.

declared printname: line number
help text: 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.

declared printname: line background
help text: The background color to use for this line. This is based on the current index and root parent.

planStatus

protected int planStatus

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

declared default value: NONPLAN

enumerated constant values:

• NONPLAN("nonplan") = 0
  
• NOTCURRENT("notcurrent") = 1
  
• CURRPLAN("currplan") = 2
  

declared invalid value: -1
declared printname: plan status
help text: An indication of whether this is a plan, and whether it is the current plan.

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("before") = 0
  
• AFTER("after") = 1
  
• IN("in") = 2
  

declared invalid value: -1
declared printname: current plan offset
help text: Tells where this element is relative to the current plan.

itemExpansion

protected int itemExpansion

An indication of whether this item is an expanded or collapsed plan, or static.

declared default value: STATIC

enumerated constant values:

• STATIC("static") = 0
  
• EXPANDED("expanded") = 1
  
• COLLAPSED("collapsed") = 2
  

declared invalid value: -1
declared printname: expansion
help text: An indication of whether this item is an expanded or collapsed plan, or static.

assignedTo

protected int assignedTo

A responsibility assignment indicator. Shows if this item is assigned directly to you, is assigned directly to someone else, falls under your general responsibilities, or is completely open.

declared default value: NOBODY

enumerated constant values:

• NOBODY("nobody") = 0
  
• YOU("you") = 1
  
• OTHER("other") = 2
  
• SHARED("shared") = 3
  

declared invalid value: -1
declared printname: assigned to
help text: A responsibility assignment indicator. Shows if this item is assigned directly to you, is assigned directly to someone else, falls under your general responsibilities, or is completely open.

responsibilities

protected long[] responsibilities

The roles responsible for oversight of this work item. If this element has been assigned to a specific user, then the ID of that HeapAssociation appended to this array of values.

help text: The person and roles responsible for oversight of this work item.

timeEstimate

protected int timeEstimate

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

declared default value: 0
range match expression: >= 0
declared printname: time estimate
help text: The estimated number of hours necessary to complete this task or plan. For a task this is read directly from an estimate. For a plan this is number is rolled up from the plans and tasks it contains. For an external plan, this is read from the external heap.

totalTime

protected int totalTime

The total number of estimated hours for this component.

declared default value: 0
range match expression: >= 0
declared printname: total time
help text: The total number of estimated hours for this component.

status

protected java.lang.String status

The status of the referenced plan component. For Tasks, this is the TaskPhase name, for ExternalPlans this is "External Plan", and for Plans this is "Plan (seq)" or "Plan (para)".

help text: The status of the referenced plan component. For Tasks, this is the TaskPhase name, for ExternalPlans this is "External Plan", and for Plans this is "Plan (seq)" or "Plan (para)".

lastModifiedTime

protected java.util.Date lastModifiedTime

The lastModifiedTime of the referenced component.

declared printname: last modified time
help text: When the referenced plan or task was last modified.

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.

declared printname: activity color
help text: 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.
help text: The parent of this element.

children

protected PlanTreeElementStruct[] children

The children of this element.

this field holds child references in the tree.
help text: The children of this element.

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.

declared printname: target completion
help text: The targeted completion day.

slack

protected int 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. Like other time estimates, the slack is computed in work hours.

help text: 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. Like other time estimates, the slack is computed in work hours.

dueDate

protected java.lang.String dueDate

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

declared printname: due date
help text: The due date of the referenced task or plan.

reldef

protected RelativeDeadlineStruct reldef

The relative deadline definition if applicable.

declared printname: relative deadline definition
help text: The relative deadline definition if applicable.

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.

declared printname: due color
help text: The chromacoding color for the due date. This is based on the number of days remaining until the due date will be reached.

Constructor Detail

PlanTreeElementStruct

public PlanTreeElementStruct()