pro.taskana.monitor.internal.reports

Class ClassificationReportBuilderImpl

java.lang.Object

pro.taskana.monitor.internal.reports.ClassificationReportBuilderImpl

All Implemented Interfaces:

ClassificationReport.Builder, Report.Builder<MonitorQueryItem,TimeIntervalColumnHeader>, TimeIntervalReportBuilder<ClassificationReport.Builder,MonitorQueryItem,TimeIntervalColumnHeader>

public class ClassificationReportBuilderImpl
extends Object
implements ClassificationReport.Builder

The implementation of ClassificationReportBuilder.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	classificationCategory
protected List<String>	classificationIds
protected List<H>	columnHeaders
protected WorkingDaysToDaysConverter	converter
protected Map<TaskCustomField,String>	customAttributeFilter
protected List<String>	domains
protected List<String>	excludedClassificationIds
protected boolean	inWorkingDays
protected MonitorMapper	monitorMapper
protected List<TaskState>	states
protected InternalTaskanaEngine	taskanaEngine
protected List<String>	workbasketIds

Constructor Summary

Constructors

Constructor and Description
ClassificationReportBuilderImpl(InternalTaskanaEngine taskanaEngine, MonitorMapper monitorMapper)

Method Summary

Modifier and Type	Method and Description
protected ClassificationReport.Builder	_this()
ClassificationReport.DetailedClassificationReport	buildDetailedReport() Returns a ClassificationReport.DetailedClassificationReport containing all tasks after applying the filters.
ClassificationReport.DetailedClassificationReport	buildDetailedReport(TaskTimestamp timestamp)
ClassificationReport	buildReport()
ClassificationReport	buildReport(TaskTimestamp timestamp) Builds the given report.
B	classificationCategoryIn(List<String> classificationCategory) Adds a list of classificationCategories to the builder.
B	classificationIdIn(List<String> classificationIds) Adds a list of classificationIds to the builder.
B	customAttributeFilterIn(Map<TaskCustomField,String> customAttributeFilter) Adds a map of custom attributes and custom attribute values to the builder.
protected String	determineGroupedBy()
B	domainIn(List<String> domains) Adds a list of domains to the builder.
B	excludedClassificationIdIn(List<String> excludedClassificationIds) Adds a list of excludedClassificationIds to the builder.
B	inWorkingDays() If this filter is used, the days of the report are counted in working days.
List<String>	listCustomAttributeValuesForCustomAttributeName(TaskCustomField taskCustomField) Returns a list of all values of an entered custom field that are in the report.
List<String>	listTaskIdsForSelectedItems(List<SelectedItem> selectedItems, TaskTimestamp timestamp) Returns a list of all taskIds of the report that are in the list of selected items.
B	stateIn(List<TaskState> states) Adds a list of states to the builder.
B	withColumnHeaders(List<H> columnHeaders) Adds a list TimeIntervalColumnHeaders to the builder to subdivide the report into clusters.
B	workbasketIdIn(List<String> workbasketIds) Adds a list of workbasket ids to the builder.

Methods inherited from class java.lang.Object

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

Methods inherited from interface pro.taskana.monitor.api.reports.TimeIntervalReportBuilder

classificationCategoryIn, classificationIdIn, customAttributeFilterIn, domainIn, excludedClassificationIdIn, inWorkingDays, listCustomAttributeValuesForCustomAttributeName, listTaskIdsForSelectedItems, stateIn, withColumnHeaders, workbasketIdIn

Field Detail

taskanaEngine

protected InternalTaskanaEngine taskanaEngine

monitorMapper

protected MonitorMapper monitorMapper

columnHeaders

protected List<H extends TimeIntervalColumnHeader> columnHeaders

inWorkingDays

protected boolean inWorkingDays

workbasketIds

protected List<String> workbasketIds

states

protected List<TaskState> states

classificationCategory

protected List<String> classificationCategory

domains

protected List<String> domains

classificationIds

protected List<String> classificationIds

excludedClassificationIds

protected List<String> excludedClassificationIds

customAttributeFilter

protected Map<TaskCustomField,String> customAttributeFilter

converter

protected WorkingDaysToDaysConverter converter

Constructor Detail

ClassificationReportBuilderImpl

public ClassificationReportBuilderImpl(InternalTaskanaEngine taskanaEngine,
                                       MonitorMapper monitorMapper)

Method Detail

buildReport

public ClassificationReport buildReport()
                                 throws NotAuthorizedException,
                                        InvalidArgumentException

Specified by:

buildReport in interface ClassificationReport.Builder

Specified by:

buildReport in interface Report.Builder<MonitorQueryItem,TimeIntervalColumnHeader>

Throws:

NotAuthorizedException

InvalidArgumentException

buildReport

public ClassificationReport buildReport(TaskTimestamp timestamp)
                                 throws InvalidArgumentException,
                                        NotAuthorizedException

Description copied from interface: TimeIntervalReportBuilder

Builds the given report.

Specified by:

buildReport in interface ClassificationReport.Builder

Specified by:

buildReport in interface TimeIntervalReportBuilder<ClassificationReport.Builder,MonitorQueryItem,TimeIntervalColumnHeader>

Parameters:

timestamp - The task timestamp of interest

Returns:

The build report

Throws:

InvalidArgumentException - when an error occurs

NotAuthorizedException - if the user has no rights to access the monitor

buildDetailedReport

public ClassificationReport.DetailedClassificationReport buildDetailedReport()
                                                                      throws InvalidArgumentException,
                                                                             NotAuthorizedException

Description copied from interface: ClassificationReport.Builder

Returns a ClassificationReport.DetailedClassificationReport containing all tasks after applying the filters. If the column headers are set the report is subdivided into clusters. Its FoldableRows contain an additional list of Rows for the classifications of the attachments of the tasks.

Specified by:

buildDetailedReport in interface ClassificationReport.Builder

Returns:

the DetailedClassificationReport

Throws:

InvalidArgumentException - if the column headers are not initialized

NotAuthorizedException - if the user has no rights to access the monitor

buildDetailedReport

public ClassificationReport.DetailedClassificationReport buildDetailedReport(TaskTimestamp timestamp)
                                                                      throws InvalidArgumentException,
                                                                             NotAuthorizedException

Specified by:

buildDetailedReport in interface ClassificationReport.Builder

Throws:

InvalidArgumentException

NotAuthorizedException

_this

protected ClassificationReport.Builder _this()

determineGroupedBy

protected String determineGroupedBy()

withColumnHeaders

public B withColumnHeaders(List<H> columnHeaders)

Description copied from interface: TimeIntervalReportBuilder

Adds a list TimeIntervalColumnHeaders to the builder to subdivide the report into clusters.

Specified by:

withColumnHeaders in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

columnHeaders - the column headers the report should consist of.

Returns:

the TimeIntervalReportBuilder

inWorkingDays

public B inWorkingDays()

Description copied from interface: TimeIntervalReportBuilder

If this filter is used, the days of the report are counted in working days.

Specified by:

inWorkingDays in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Returns:

the TimeIntervalReportBuilder

workbasketIdIn

public B workbasketIdIn(List<String> workbasketIds)

Description copied from interface: TimeIntervalReportBuilder

Adds a list of workbasket ids to the builder. The created report contains only tasks with a workbasket id in this list.

Specified by:

workbasketIdIn in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

workbasketIds - a list of workbasket ids

Returns:

the TimeIntervalReportBuilder

stateIn

public B stateIn(List<TaskState> states)

Description copied from interface: TimeIntervalReportBuilder

Adds a list of states to the builder. The created report contains only tasks with a state in this list.

Specified by:

stateIn in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

states - a list of states

Returns:

the TimeIntervalReportBuilder

classificationCategoryIn

public B classificationCategoryIn(List<String> classificationCategory)

Description copied from interface: TimeIntervalReportBuilder

Adds a list of classificationCategories to the builder. The created report contains only tasks with a category in this list.

Specified by:

classificationCategoryIn in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

classificationCategory - a list of classificationCategories

Returns:

the TimeIntervalReportBuilder

classificationIdIn

public B classificationIdIn(List<String> classificationIds)

Description copied from interface: TimeIntervalReportBuilder

Adds a list of classificationIds to the builder. The created report contains only tasks with a classificationId in this list.

Specified by:

classificationIdIn in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

classificationIds - a list of classificationIds

Returns:

the TimeIntervalReportBuilder

excludedClassificationIdIn

public B excludedClassificationIdIn(List<String> excludedClassificationIds)

Description copied from interface: TimeIntervalReportBuilder

Adds a list of excludedClassificationIds to the builder. The created report contains only tasks with a classificationId NOT in this list.

Specified by:

excludedClassificationIdIn in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

excludedClassificationIds - a list of excludedClassificationIds

Returns:

the TimeIntervalReportBuilder

domainIn

public B domainIn(List<String> domains)

Description copied from interface: TimeIntervalReportBuilder

Adds a list of domains to the builder. The created report contains only tasks with a domain in this list.

Specified by:

domainIn in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

domains - a list of domains

Returns:

the TimeIntervalReportBuilder

customAttributeFilterIn

public B customAttributeFilterIn(Map<TaskCustomField,String> customAttributeFilter)

Description copied from interface: TimeIntervalReportBuilder

Adds a map of custom attributes and custom attribute values to the builder. The created report contains only tasks with a custom attribute value in this list.

Specified by:

customAttributeFilterIn in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

customAttributeFilter - a map of custom attributes and custom attribute value

Returns:

the TimeIntervalReportBuilder

listTaskIdsForSelectedItems

public List<String> listTaskIdsForSelectedItems(List<SelectedItem> selectedItems,
                                                TaskTimestamp timestamp)
                                         throws NotAuthorizedException,
                                                InvalidArgumentException

Description copied from interface: TimeIntervalReportBuilder

Returns a list of all taskIds of the report that are in the list of selected items.

Specified by:

listTaskIdsForSelectedItems in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

selectedItems - a list of selectedItems

timestamp - the task timestamp of interest

Returns:

the list of all taskIds

Throws:

NotAuthorizedException - if the user has no rights to access the monitor

InvalidArgumentException - if the column headers are not initialized

listCustomAttributeValuesForCustomAttributeName

public List<String> listCustomAttributeValuesForCustomAttributeName(TaskCustomField taskCustomField)
                                                             throws NotAuthorizedException

Description copied from interface: TimeIntervalReportBuilder

Returns a list of all values of an entered custom field that are in the report.

Specified by:

listCustomAttributeValuesForCustomAttributeName in interface TimeIntervalReportBuilder<B extends TimeIntervalReportBuilder<B,I,H>,I extends AgeQueryItem,H extends TimeIntervalColumnHeader>

Parameters:

taskCustomField - the customField whose values should appear in the list

Returns:

the list of all custom attribute values

Throws:

NotAuthorizedException - if the user has no rights to access the monitor