Package com.storedobject.chart

Class ActivityList

java.lang.Object

com.storedobject.chart.AbstractProject

com.storedobject.chart.ActivityList

public class ActivityList
extends AbstractProject

Class to represent a list of activities (instances of ActivityList.Activity).

ActivityChart uses data from this class.

An ActivityList consists of instances of ActivityList.Activity and each ActivityList.Activity belongs to an ActivityList.ActivityGroup. Instances of ActivityList.Activity can be created via createActivity(ActivityGroup, String, LocalDateTime, int) or createActivity(ActivityGroup, String, LocalDateTime, LocalDateTime). Alternatively, a ActivityList.Activity can be created under an ActivityList.ActivityGroup via ActivityList.ActivityGroup.createActivity(String, LocalDateTime, int) or createActivity(ActivityGroup, String, LocalDateTime, LocalDateTime).

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ActivityList.Activity	Represents an activity in a ActivityList.
class	ActivityList.ActivityGroup	Represents a group of ActivityList.Activitys.

Constructor Summary

Constructors

Constructor	Description
ActivityList()	Constructor for a date-based event list.
ActivityList(ChronoUnit durationType)	Constructor.

Method Summary

Modifier and Type	Method	Description
ActivityList.Activity	createActivity(ActivityList.ActivityGroup activityGroup, String activityName, LocalDateTime start, int duration)	Create and add a ActivityList.Activity to the ActivityList.
ActivityList.Activity	createActivity(ActivityList.ActivityGroup activityGroup, String activityName, LocalDateTime start, LocalDateTime end)	Create and add a ActivityList.Activity to the ActivityList.
ActivityList.ActivityGroup	createActivityGroup(String name)	Create and add a ActivityList.ActivityGroup to the ActivityList.
void	delete(ActivityList.Activity... activities)	Delete ActivityList.Activitys from the ActivityList.
void	delete(ActivityList.ActivityGroup... activityGroups)	Delete ActivityList.ActivityGroups from the ActivityList.
final LocalDateTime	getEnd()	Get the project end.
final ActivityList.ActivityGroup	getEventGroup(int groupIndex)	Get the ActivityList.ActivityGroup of this ActivityList.
protected final String	getExtraAxisLabel(AbstractTask activity)	Get the extra axis label for the task/activity.
protected String	getExtraAxisLabel(ActivityList.ActivityGroup activityGroup)
final int	getGroupCount()	Get the number of ActivityList.Activity belonging to this group.
final int	getRowCount()
final LocalDateTime	getStart()	Get the project start.
protected String	getTooltipLabel(AbstractTask abstractActivity)	Get the tooltip label of the given task/activity (Will be used for displaying the tooltip label).
boolean	isEmpty()
final void	setStart(LocalDateTime start)	Set the start of the project.
Stream<ActivityList.Activity>	streamActivities(ActivityList.ActivityGroup activityGroup)	Get all activities in the given activity group.
Stream<ActivityList.ActivityGroup>	streamGroups()	Get all activity groups of this ActivityList.

Methods inherited from class com.storedobject.chart.AbstractProject

encode, getActivityFontSize, getAxisLabel, getDurationType, getExtraFontSize, getGroupFontSize, getLabel, getName, getTaskFontSize, getToday, max, setActivityFontSize, setExtraFontSize, setGroupFontSize, setName, setStart, setStart, setTaskBandColors, setTaskFontSize, setTimeNow, setTimeNowColor, setToday, setTodayColor, setTodayFormat, setTooltipTimeFormat, trim, trim

Methods inherited from class java.lang.Object

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

Constructor Details

ActivityList

public ActivityList()

Constructor for a date-based event list.

ActivityList

public ActivityList(ChronoUnit durationType)

Constructor.

Parameters:

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

Method Details

isEmpty

public boolean isEmpty()

createActivityGroup

public ActivityList.ActivityGroup createActivityGroup(String name)

Create and add a ActivityList.ActivityGroup to the ActivityList.

Parameters:

name - Name of the activity group.

Returns:

Activity group created.

createActivity

public ActivityList.Activity createActivity(ActivityList.ActivityGroup activityGroup,
 String activityName,
 LocalDateTime start,
 int duration)

Create and add a ActivityList.Activity to the ActivityList.

Parameters:

activityGroup - Group to which the ActivityList.Activity to be added.

activityName - Name of the ActivityList.Activity.

start - Start.

duration - Duration of the ActivityList.Activity. (Should be grater than 0).

Returns:

Activity created. (Returns null if the ActivityList.ActivityGroup passed doesn't belong to this).

createActivity

public ActivityList.Activity createActivity(ActivityList.ActivityGroup activityGroup,
 String activityName,
 LocalDateTime start,
 LocalDateTime end)

Create and add a ActivityList.Activity to the ActivityList.

Parameters:

activityGroup - Group to which the ActivityList.Activity to be added.

activityName - Name of the ActivityList.Activity.

start - Start.

end - End.

Returns:

Activity created. (Returns null if the ActivityList.ActivityGroup passed doesn't belong to this).

delete

public void delete(ActivityList.ActivityGroup... activityGroups)

Delete ActivityList.ActivityGroups from the ActivityList. (All ActivityList.Activitys and dependencies related to these groups will be dropped).

Parameters:

activityGroups - ActivityList.ActivityGroups to delete.

delete

public void delete(ActivityList.Activity... activities)

Delete ActivityList.Activitys from the ActivityList. (All dependencies related to these activities will be dropped).

Parameters:

activities - ActivityList.Activitys to delete.

setStart

public final void setStart(LocalDateTime start)

Description copied from class: AbstractProject

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.

Overrides:

setStart in class AbstractProject

Parameters:

start - Start of the project.

getStart

public final LocalDateTime getStart()

Description copied from class: AbstractProject

Get the project start.

Overrides:

getStart in class AbstractProject

Returns:

Start date/time.

getEnd

public final LocalDateTime getEnd()

Description copied from class: AbstractProject

Get the project end.

Specified by:

getEnd in class AbstractProject

Returns:

End date/time.

getRowCount

public final int getRowCount()

getEventGroup

public final ActivityList.ActivityGroup getEventGroup(int groupIndex)

Get the ActivityList.ActivityGroup of this ActivityList.

Parameters:

groupIndex - Index of the activity group to be retrieved.

Returns:

ActivityList.ActivityGroup.

getGroupCount

public final int getGroupCount()

Get the number of ActivityList.Activity belonging to this group.

Returns:

Activity count.

streamGroups

public Stream<ActivityList.ActivityGroup> streamGroups()

Get all activity groups of this ActivityList.

Note: Null will be returned if the ActivityList contains inconsistencies.

Returns:

Stream of activity groups.

streamActivities

public Stream<ActivityList.Activity> streamActivities(ActivityList.ActivityGroup activityGroup)

Get all activities in the given activity group.

Note: Null will be returned if the ActivityList contains inconsistencies.

Parameters:

activityGroup - Activity group.

Returns:

Stream of ActivityList.Activitys.

getExtraAxisLabel

protected final String getExtraAxisLabel(AbstractTask activity)

Description copied from class: AbstractProject

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

Specified by:

getExtraAxisLabel in class AbstractProject

Parameters:

activity - Task.

Returns:

Label.

getExtraAxisLabel

protected String getExtraAxisLabel(ActivityList.ActivityGroup activityGroup)

getTooltipLabel

protected String getTooltipLabel(AbstractTask abstractActivity)

Description copied from class: AbstractProject

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

Specified by:

getTooltipLabel in class AbstractProject

Parameters:

abstractActivity - Task/activity.

Returns:

Label.