net.sf.mpxj

Class WorkContour

java.lang.Object

net.sf.mpxj.WorkContour

All Implemented Interfaces:

ProjectEntityWithUniqueID

public final class WorkContour
extends Object
implements ProjectEntityWithUniqueID

Instances of this class represent enumerated work contour values.

Field Summary

Fields

Modifier and Type	Field and Description
static WorkContour	BACK_LOADED
static WorkContour	BELL
static WorkContour	CONTOURED
static WorkContour	DOUBLE_PEAK
static WorkContour	EARLY_PEAK
static WorkContour	FLAT
static WorkContour	FRONT_LOADED
static WorkContour	LATE_PEAK
static WorkContour	TURTLE

Constructor Summary

Constructors

Constructor and Description
WorkContour(Integer uniqueID, String name, boolean isDefault, double... curveValues) Constructor.

Method Summary

Modifier and Type	Method and Description
double[]	getCurveValues() Retrieve the values which define the curve.
String	getName() Retrieve the name of this work contour.
Integer	getUniqueID() Retrieve the Unique ID value of the entity.
boolean	isContourDefault() Determine if this is a "built in" work contour from the source application.
boolean	isContourFlat() Returns true if this contour is flat.
boolean	isContourManual() Returns true if the timephased data has been manually edited.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

FLAT

public static final WorkContour FLAT

BACK_LOADED

public static final WorkContour BACK_LOADED

FRONT_LOADED

public static final WorkContour FRONT_LOADED

DOUBLE_PEAK

public static final WorkContour DOUBLE_PEAK

EARLY_PEAK

public static final WorkContour EARLY_PEAK

LATE_PEAK

public static final WorkContour LATE_PEAK

BELL

public static final WorkContour BELL

TURTLE

public static final WorkContour TURTLE

CONTOURED

public static final WorkContour CONTOURED

Constructor Detail

WorkContour

public WorkContour(Integer uniqueID,
                   String name,
                   boolean isDefault,
                   double... curveValues)

Constructor.

Parameters:

uniqueID - unique ID

name - work contour name

isDefault - true if this is a "built in" contour provided by the source application

curveValues - curve values, 21 values representing 5% duration intervals, including 0%, total of values must be 100%

Method Detail

getUniqueID

public Integer getUniqueID()

Description copied from interface: ProjectEntityWithUniqueID

Retrieve the Unique ID value of the entity.

Specified by:

getUniqueID in interface ProjectEntityWithUniqueID

Returns:

Unique ID value

getCurveValues

public double[] getCurveValues()

Retrieve the values which define the curve. The method returns an array of 21 doubles, each representing 5% of the duration. This includes an entry for 0%. The total of the values in the array must be 100%. Note that the CONTOURED enum will return null as the values for the work or cost per time period have been handcrafted and do not use a curve.

Returns:

curve values

getName

public String getName()

Retrieve the name of this work contour.

Returns:

contour name

isContourManual

public boolean isContourManual()

Returns true if the timephased data has been manually edited.

Returns:

true if manually edited

isContourFlat

public boolean isContourFlat()

Returns true if this contour is flat.

Returns:

true if flat

isContourDefault

public boolean isContourDefault()

Determine if this is a "built in" work contour from the source application.

Returns:

true if this is a "built in" work contour

toString

public String toString()

Overrides:

toString in class Object