Package com.storedobject.chart

Class AbstractProject

java.lang.Object

com.storedobject.chart.AbstractProject

Direct Known Subclasses:

ActivityList, Project

public abstract class AbstractProject
extends Object

An abstract base class that implements some useful attributes and methods for defining a project.

Author:

Syam

Constructor Summary

Constructors

Constructor	Description
AbstractProject(ChronoUnit durationType)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected final String	encode(LocalDateTime time)	Encode time data according to the duration type.
int	getActivityFontSize()	Get the font-size used to render the activity details.
protected String	getAxisLabel(AbstractTask task)	Get the axis label for the task/activity task or group.
final ChronoUnit	getDurationType()	Get the duration type of this project.
abstract LocalDateTime	getEnd()	Get the project end.
protected abstract String	getExtraAxisLabel(AbstractTask task)	Get the extra axis label for the task/activity.
int	getExtraFontSize()	Get the font-size used to render the extra information of group.
int	getGroupFontSize()	Get the font-size used to render the task/activity group.
protected String	getLabel(AbstractTask task)	Get the label of the given task/activity (Will be used for displaying the label on the task/activity bar).
final String	getName()	Get the name of the project.
LocalDateTime	getStart()	Get the project start.
int	getTaskFontSize()	Get the font-size used to render the task details
final LocalDateTime	getToday()	Get today/now.
protected abstract String	getTooltipLabel(AbstractTask task)	Get the tooltip label of the given task/activity (Will be used for displaying the tooltip label).
protected static LocalDateTime	max(LocalDateTime one, LocalDateTime two)	Get max of 2 time values.
void	setActivityFontSize(int activityFontSize)	Set the font size used to render the activity details.
void	setExtraFontSize(int extraFontSize)	Set the font size used to render the extra information of group.
void	setGroupFontSize(int groupFontSize)	Set the font size used to render the group name.
void	setName(String name)	Set the name of the project.
final void	setStart(Instant start)	Set the start of the project.
final void	setStart(LocalDate start)	Set the start of the project.
void	setStart(LocalDateTime start)	Set the start of the project.
void	setTaskBandColors(Color bandColorOdd, Color bandColorEven)	Set the colors of the task/activity bands.
void	setTaskFontSize(int taskFontSize)	Set the font size used to render the task details.
void	setTimeNow(LocalDateTime now)	Set time-now.
void	setTimeNowColor(Color color)	Set the color for time-now-marker on the Gantt chart.
void	setToday(LocalDate today)	Set today.
void	setTodayColor(Color color)	Set the color for today-marker on the Gantt chart.
void	setTodayFormat(Function<LocalDateTime,String> todayFormat)	Set a formatter function to format the today-marker.
void	setTooltipTimeFormat(Function<LocalDateTime,String> tooltipTimeFormat)	Set a formatter function to format the tooltip of tasks/activities.
protected static String	trim(double v)	Trim a double value to remove unnecessary decimals.
protected LocalDateTime	trim(LocalDateTime dateTime)	Trim down a LocalDateTime to a LocalDate.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractProject

public AbstractProject(ChronoUnit durationType)

Constructor.

Parameters:

durationType - Type of duration to be used for this project. (Note: ChronoUnit.ERAS and ChronoUnit.FOREVER are not supported and if used, will be considered as ChronoUnit.MILLIS).

Method Details

getDurationType

public final ChronoUnit getDurationType()

Get the duration type of this project.

Returns:

Duration type.

setName

public void setName(String name)

Set the name of the project.

Parameters:

name - Name of the project.

getName

public final String getName()

Get the name of the project.

Returns:

Project name.

trim

protected LocalDateTime trim(LocalDateTime dateTime)

Trim down a LocalDateTime to a LocalDate.

Parameters:

dateTime - Time to trim.

Returns:

Local date.

setStart

public void setStart(LocalDateTime start)

Set the start of the project. Depending on the duration type, one of the "setStart" methods can be used. However, the start value will be appropriately trimmed if you try to set a higher resolution value.

Parameters:

start - Start of the project.

setStart

public final void setStart(LocalDate start)

Set the start of the project. Depending on the duration type, one of the "setStart" methods can be used. However, the start value will be appropriately trimmed if you try to set a higher resolution value.

Parameters:

start - Start of the project.

setStart

public final void setStart(Instant start)

Set the start of the project. Depending on the duration type, one of the "setStart" methods can be used. However, the start value will be appropriately trimmed if you try to set a higher resolution value.

Parameters:

start - Start of the project.

getStart

public LocalDateTime getStart()

Get the project start.

Returns:

Start date/time.

getEnd

public abstract LocalDateTime getEnd()

Get the project end.

Returns:

End date/time.

max

protected static LocalDateTime max(LocalDateTime one,
 LocalDateTime two)

Get max of 2 time values.

Parameters:

one - First value.

two - Second value.

Returns:

Max of the 2.

encode

protected final String encode(LocalDateTime time)

Encode time data according to the duration type.

Parameters:

time - Time.

Returns:

Formatted value.

trim

protected static String trim(double v)

Trim a double value to remove unnecessary decimals.

Parameters:

v - Value to trim.

Returns:

Trimmed value as a string.

getLabel

protected String getLabel(AbstractTask task)

Get the label of the given task/activity (Will be used for displaying the label on the task/activity bar). The default implementation returns AbstractTask.getName() + " (" + AbstractTask.getCompleted() + "%)".

In the case of a milestone (AbstractTask.isMilestone()), it returns just the milestone name.

Parameters:

task - Task/activity.

Returns:

Label.

getToday

public final LocalDateTime getToday()

Get today/now.

Returns:

Today/now.

getExtraAxisLabel

protected abstract String getExtraAxisLabel(AbstractTask task)

Get the extra axis label for the task/activity. (Will be used for displaying the 2nd line of the axis label).

Parameters:

task - Task.

Returns:

Label.

getAxisLabel

protected String getAxisLabel(AbstractTask task)

Get the axis label for the task/activity task or group. (Will be used for displaying the axis label).

The default implementation returns the name of the task/activity.

Parameters:

task - Task/activity.

Returns:

Label.

getTooltipLabel

protected abstract String getTooltipLabel(AbstractTask task)

Get the tooltip label of the given task/activity (Will be used for displaying the tooltip label).

Parameters:

task - Task/activity.

Returns:

Label.

setToday

public void setToday(LocalDate today)

Set today. By default, today = LocalDate.now(). However, it is possible to set another date. (Used in date-based projects).

Parameters:

today - Value of today.

setTodayColor

public void setTodayColor(Color color)

Set the color for today-marker on the Gantt chart. (Used in date-based projects).

Parameters:

color - Color.

setTimeNow

public void setTimeNow(LocalDateTime now)

Set time-now. By default, now = LocalDateTime.now(). However, it is possible to set another date or time. (Used in time-based projects).

Parameters:

now - Value of time-now.

setTimeNowColor

public void setTimeNowColor(Color color)

Set the color for time-now-marker on the Gantt chart. (Used in time-based projects).

Parameters:

color - Color.

setTodayFormat

public void setTodayFormat(Function<LocalDateTime,String> todayFormat)

Set a formatter function to format the today-marker. By default, today is formatted as follows:

Today: Jan 23, 1998

Parameters:

todayFormat - Formatter function.

setTooltipTimeFormat

public void setTooltipTimeFormat(Function<LocalDateTime,String> tooltipTimeFormat)

Set a formatter function to format the tooltip of tasks/activities. By default, it is formatted as follows:

Aug 07, 2002

Parameters:

tooltipTimeFormat - Formatter function.

setTaskBandColors

public void setTaskBandColors(Color bandColorOdd,
 Color bandColorEven)

Set the colors of the task/activity bands.

Parameters:

bandColorOdd - Color for odd rows.

bandColorEven - Color for even rows.

getExtraFontSize

public int getExtraFontSize()

Get the font-size used to render the extra information of group.

Returns:

Font-size. Default is 12.

setExtraFontSize

public void setExtraFontSize(int extraFontSize)

Set the font size used to render the extra information of group.

Note: You can also set different values for individual groups. See AbstractTask.setFontSize(int)

Parameters:

extraFontSize - Font-size to set (in pixels). Default is 9.

getGroupFontSize

public int getGroupFontSize()

Get the font-size used to render the task/activity group.

Returns:

Font-size. Default is 12.

setGroupFontSize

public void setGroupFontSize(int groupFontSize)

Set the font size used to render the group name.

Note: You can also set different values for individual groups. See AbstractTask.setFontSize(int)

Parameters:

groupFontSize - Font-size to set (in pixels). Default is 12.

getTaskFontSize

public int getTaskFontSize()

Get the font-size used to render the task details

Returns:

Font-size. Default is 12.

setTaskFontSize

public void setTaskFontSize(int taskFontSize)

Set the font size used to render the task details.

Note: You can also set different values for individual tasks. See AbstractTask.setFontSize(int)

Parameters:

taskFontSize - Font-size to set (in pixels). Default is 12.

getActivityFontSize

public int getActivityFontSize()

Get the font-size used to render the activity details.

Returns:

Font-size. Default is 12.

setActivityFontSize

public void setActivityFontSize(int activityFontSize)

Set the font size used to render the activity details.

Note: You can also set different values for individual activities. See AbstractTask.setFontSize(int)

Parameters:

activityFontSize - Font-size to set (in pixels). Default is 12.