Package com.inet.report.chart.dataset
Class GanttForEachRecordDataset
- java.lang.Object
-
- com.inet.report.chart.dataset.AbstractDataset
-
- com.inet.report.chart.dataset.GanttForEachRecordDataset
-
- All Implemented Interfaces:
BaseDataset,GanttDataset,java.io.Serializable
- Direct Known Subclasses:
GanttOneGroupDataset
public class GanttForEachRecordDataset extends com.inet.report.chart.dataset.AbstractDataset implements GanttDataset
This is a dataset used by Gantt charts. This evaluates data 'for each record' for three data fields (start, end and progress).- Since:
- 8.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected static intFIELDS_COUNTThe count of data fields by this kind of dataset.-
Fields inherited from interface com.inet.report.chart.dataset.BaseDataset
TOKEN_DATASET
-
-
Constructor Summary
Constructors Constructor Description GanttForEachRecordDataset(Chart2 chart)Creates a new empty dataset.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected GroupgetCategoryGroup()Returns the category group.Chart2getChart()Returns the parent chart of this dataset.protected SummaryFieldgetDataField(int index)Returns the summary field at the specified position in the list.SummaryFieldgetDataField(java.lang.String name)Returns the summary field with the specified name ornullif the summary field with this name not found in the list.java.util.ListgetDataFields()Returns the data fields of this dataset as list.SummaryFieldgetEndField()Returns the data field which indicates the end position of each interval bar.com.inet.report.chart.dataset.LabelProvidergetLabelProvider()Returns the LabelProvider responsible for providing the title, footnote, and axis labelsprotected java.lang.StringgetName()SummaryFieldgetProgressField()Returns the data field which indicates the progress status of each interval bar.SummaryFieldgetStartField()Returns the data field which indicates the start position of each interval bar.voidsetEndField(int summaryOperation, Field field, Field field2nd, int nth)Sets the data field which indicates the end position of each interval bar.voidsetProgressField(int summaryOperation, Field field, Field field2nd, int nth)Sets the data field which indicates the progress status of each interval bar.voidsetStartField(int summaryOperation, Field field, Field field2nd, int nth)Sets the data field which indicates the start position of each interval bar.voidupdateReferences()FOR INTERNAL USE ONLY.java.lang.Stringverify(ChartStyle style)Verifies the group and sum properties of current dataset.-
Methods inherited from class com.inet.report.chart.dataset.AbstractDataset
getReferencedObject, saveGroups, saveProperties, saveSummaryFields
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.inet.report.chart.dataset.BaseDataset
getReferencedObject
-
-
-
-
Field Detail
-
FIELDS_COUNT
protected static final int FIELDS_COUNT
The count of data fields by this kind of dataset.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
GanttForEachRecordDataset
public GanttForEachRecordDataset(Chart2 chart)
Creates a new empty dataset.- Parameters:
chart- the chart (nullnot permitted)- Since:
- 8.0
-
-
Method Detail
-
getChart
public Chart2 getChart()
Returns the parent chart of this dataset.- Specified by:
getChartin interfaceBaseDataset- Returns:
- the chart.
-
getCategoryGroup
protected Group getCategoryGroup()
Returns the category group. The category group is the first group of chart.- Returns:
- the group.
- Since:
- 8.0
-
getDataField
public SummaryField getDataField(java.lang.String name)
Returns the summary field with the specified name ornullif the summary field with this name not found in the list. Testing for equality using the case sensitiveequalsmethod.- Specified by:
getDataFieldin interfaceBaseDataset- Parameters:
name- the searched name of summary field (nullnot permitted)- Returns:
- the summary field with the specified name or
null. - See Also:
BaseDataset.getDataFields()
-
getDataFields
public java.util.List getDataFields()
Returns the data fields of this dataset as list.- Specified by:
getDataFieldsin interfaceBaseDataset- Returns:
- the list of data fields
- See Also:
BaseDataset.getDataField(String)
-
getStartField
public SummaryField getStartField()
Returns the data field which indicates the start position of each interval bar.- Specified by:
getStartFieldin interfaceGanttDataset- Returns:
- the data field of type
SummaryFieldornullif this field was not initialized. - See Also:
GanttDataset.setStartField(int, Field, Field, int)
-
setStartField
public 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 newSummaryFieldwith these parameters.
For more information about the supported value types of the field and about using parameters 'field2nd' and 'nth' seeSummaryField.
Note: this data field supports only summary operations with date result values.- Specified by:
setStartFieldin interfaceGanttDataset- Parameters:
summaryOperation- the summary operation. This supports operations with date result values onlyfield- the data fieldfield2nd- the second data field, this field can currently be ignored.nth- the nth parameter, used for example by summary operationSummaryField.NTH_LARGEST- See Also:
GanttDataset.getStartField(),SummaryField.setSummaryOperation(int),SummaryField.setField(Field),SummaryField.setField2nd(Field),SummaryField.setSummaryNth(int)
-
getEndField
public SummaryField getEndField()
Returns the data field which indicates the end position of each interval bar.- Specified by:
getEndFieldin interfaceGanttDataset- Returns:
- the data field of type
SummaryFieldornullif this field was not initialized. - See Also:
GanttDataset.setEndField(int, Field, Field, int)
-
setEndField
public 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 newSummaryFieldwith these parameters.
For more information about the supported value types of the field and about using parameters 'field2nd' and 'nth' seeSummaryField.
Note: this data field supports only summary operations with date result values.- Specified by:
setEndFieldin interfaceGanttDataset- Parameters:
summaryOperation- the summary operation. This supports operations with date result values onlyfield- the data fieldfield2nd- the second data field, this field can currently be ignored.nth- the nth parameter, used for example by summary operationSummaryField.NTH_LARGEST- See Also:
GanttDataset.getEndField(),SummaryField.setSummaryOperation(int),SummaryField.setField(Field),SummaryField.setField2nd(Field),SummaryField.setSummaryNth(int)
-
getProgressField
public SummaryField getProgressField()
Returns the data field which indicates the progress status of each interval bar.- Specified by:
getProgressFieldin interfaceGanttDataset- Returns:
- the data field of type
SummaryFieldornullif this field was not initialized. - See Also:
GanttDataset.setProgressField(int, Field, Field, int)
-
setProgressField
public 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 newSummaryFieldwith these parameters.
For more information about the supported value types of the field and about using parameters 'field2nd' and 'nth' seeSummaryField.
Note: this data field supports only summary operations with number result values.- Specified by:
setProgressFieldin interfaceGanttDataset- Parameters:
summaryOperation- the summary operation. This supports operations with number result values onlyfield- the data fieldfield2nd- the second data field, this field can currently be ignored.nth- the nth parameter, used for example by summary operationSummaryField.NTH_LARGEST- See Also:
GanttDataset.getEndField(),SummaryField.setSummaryOperation(int),SummaryField.setField(Field),SummaryField.setField2nd(Field),SummaryField.setSummaryNth(int)
-
getDataField
protected SummaryField getDataField(int index)
Returns the summary field at the specified position in the list.- Parameters:
index- index of summary field to return- Returns:
- the summary field at the specified position in the list.
- Throws:
java.lang.IndexOutOfBoundsException- if index is out of range.- Since:
- 8.0
-
verify
public java.lang.String verify(ChartStyle style)
Verifies the group and sum properties of current dataset.- Specified by:
verifyin interfaceBaseDataset- Parameters:
style- the chart style- Returns:
- the error message or empty string if all properties are correct.
-
getLabelProvider
public com.inet.report.chart.dataset.LabelProvider getLabelProvider()
Returns the LabelProvider responsible for providing the title, footnote, and axis labels- Specified by:
getLabelProviderin interfaceBaseDataset- Returns:
- the LabelProvider responsible for providing the title, footnote, and axis labels
-
updateReferences
public void updateReferences()
FOR INTERNAL USE ONLY. Updates the references of this dataset.- Specified by:
updateReferencesin interfaceBaseDataset
-
getName
protected java.lang.String getName()
-
-