com.inet.report.chart.dataset

Interface GanttDataset

All Superinterfaces:

BaseDataset, java.io.Serializable

All Known Implementing Classes:

GanttForEachRecordDataset, GanttOneGroupDataset, GanttTwoGroupsDataset

public interface GanttDataset
extends BaseDataset

An interface that is implemented by data sets that have start, end and progress fields. For more information see the implementors of this interface.

Since:

8.0

See Also:

GanttForEachRecordDataset, GanttOneGroupDataset, GanttTwoGroupsDataset

Field Summary

Fields inherited from interface com.inet.report.chart.dataset.BaseDataset

TOKEN_DATASET

Method Summary

Modifier and Type	Method and Description
SummaryField	getEndField() Returns the data field which indicates the end position of each interval bar.
SummaryField	getProgressField() Returns the data field which indicates the progress status of each interval bar.
SummaryField	getStartField() Returns the data field which indicates the start position of each interval bar.
void	setEndField(int summaryOperation, Field field, Field field2nd, int nth) Sets the data field which indicates the end position of each interval bar.
void	setProgressField(int summaryOperation, Field field, Field field2nd, int nth) Sets the data field which indicates the progress status of each interval bar.
void	setStartField(int summaryOperation, Field field, Field field2nd, int nth) Sets the data field which indicates the start position of each interval bar.

Methods inherited from interface com.inet.report.chart.dataset.BaseDataset

getChart, getDataField, getDataFields, getLabelProvider, verify

Method Detail

getStartField

SummaryField getStartField()

Returns the data field which indicates the start position of each interval bar.

Returns:

the data field of type SummaryField or null if this field was not initialized.

Since:

8.0

See Also:

setStartField(int, Field, Field, int)

getEndField

SummaryField getEndField()

Returns the data field which indicates the end position of each interval bar.

Returns:

the data field of type SummaryField or null if this field was not initialized.

Since:

8.0

See Also:

setEndField(int, Field, Field, int)

getProgressField

SummaryField getProgressField()

Returns the data field which indicates the progress status of each interval bar.

Returns:

the data field of type SummaryField or null if this field was not initialized.

Since:

8.0

See Also:

setProgressField(int, Field, Field, int)

setStartField

void setStartField(int summaryOperation,
                   Field field,
                   Field field2nd,
                   int nth)

Sets the data field which indicates the start position of each interval bar. Creates a new SummaryField with these parameters.
For more information about the supported value types of the field and about using parameters 'field2nd' and 'nth' see SummaryField.
Note: this data field supports only summary operations with date result values.

Parameters:

summaryOperation - the summary operation. This supports operations with date result values only

field - the data field

field2nd - the second data field, this field can currently be ignored.

nth - the nth parameter, used for example by summary operation SummaryField.NTH_LARGEST

Throws:

java.lang.IllegalArgumentException - if the required second field or field are null or have an unsupported value type.

java.lang.IllegalArgumentException - if "nth" is less than zero.

Since:

8.0

See Also:

getStartField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)

setEndField

void setEndField(int summaryOperation,
                 Field field,
                 Field field2nd,
                 int nth)

Sets the data field which indicates the end position of each interval bar. Creates a new SummaryField with these parameters.
For more information about the supported value types of the field and about using parameters 'field2nd' and 'nth' see SummaryField.
Note: this data field supports only summary operations with date result values.

Parameters:

summaryOperation - the summary operation. This supports operations with date result values only

field - the data field

field2nd - the second data field, this field can currently be ignored.

nth - the nth parameter, used for example by summary operation SummaryField.NTH_LARGEST

Throws:

java.lang.IllegalArgumentException - if the required second field or field are null or have an unsupported value type.

java.lang.IllegalArgumentException - if "nth" is less than zero.

Since:

8.0

See Also:

getEndField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)

setProgressField

void setProgressField(int summaryOperation,
                      Field field,
                      Field field2nd,
                      int nth)

Sets the data field which indicates the progress status of each interval bar. This field is optional and supports only summary operations with number as result values. Creates a new SummaryField with these parameters.
For more information about the supported value types of the field and about using parameters 'field2nd' and 'nth' see SummaryField.
Note: this data field supports only summary operations with number result values.

Parameters:

summaryOperation - the summary operation. This supports operations with number result values only

field - the data field

field2nd - the second data field, this field can currently be ignored.

nth - the nth parameter, used for example by summary operation SummaryField.NTH_LARGEST

Throws:

java.lang.IllegalArgumentException - if the required second field or field are null or have an unsupported value type.

java.lang.IllegalArgumentException - if "nth" is less than zero.

Since:

8.0

See Also:

getEndField(), SummaryField.setSummaryOperation(int), SummaryField.setField(Field), SummaryField.setField2nd(Field), SummaryField.setSummaryNth(int)