Package org.jfree.data.time
Class TimePeriodValues
java.lang.Object
org.jfree.data.general.Series
org.jfree.data.time.TimePeriodValues
- All Implemented Interfaces:
Serializable
,Cloneable
A structure containing zero, one or many
TimePeriodValue
instances.
The time periods can overlap, and are maintained in the order that they are
added to the collection.
This is similar to the TimeSeries
class, except that the time
periods can have irregular lengths.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate List
The list of data pairs in the series.protected static final String
Default value for the domain description.protected static final String
Default value for the range description.private String
A description of the domain.private int
Index of the time period with the maximum end milliseconds.private int
Index of the time period with the maximum middle milliseconds.private int
Index of the time period with the maximum start milliseconds.private int
Index of the time period with the minimum end milliseconds.private int
Index of the time period with the minimum middle milliseconds.private int
Index of the time period with the minimum start milliseconds.private String
A description of the range.(package private) static final long
For serialization. -
Constructor Summary
ConstructorsConstructorDescriptionTimePeriodValues
(String name) Creates a new (empty) collection of time period values.TimePeriodValues
(String name, String domain, String range) Creates a new time series that contains no data. -
Method Summary
Modifier and TypeMethodDescriptionvoid
add
(TimePeriod period, double value) Adds a new data item to the series and sends aSeriesChangeEvent
to all registered listeners.void
add
(TimePeriod period, Number value) Adds a new data item to the series and sends aSeriesChangeEvent
to all registered listeners.void
add
(TimePeriodValue item) Adds a data item to the series and sends aSeriesChangeEvent
to all registered listeners.clone()
Returns a clone of the collection.createCopy
(int start, int end) Creates a new instance by copying a subset of the data in this collection.void
delete
(int start, int end) Deletes data from start until end index (end inclusive) and sends aSeriesChangeEvent
to all registered listeners.boolean
Tests the series for equality with another object.getDataItem
(int index) Returns one data item for the series.Returns the domain description.int
Returns the number of items in the series.int
Returns the index of the time period with the maximum end milliseconds.int
Returns the index of the time period with the maximum middle milliseconds.int
Returns the index of the time period with the maximum start milliseconds.int
Returns the index of the time period with the minimum end milliseconds.int
Returns the index of the time period with the minimum middle milliseconds.int
Returns the index of the time period with the minimum start milliseconds.Returns the range description.getTimePeriod
(int index) Returns the time period at the specified index.getValue
(int index) Returns the value at the specified index.int
hashCode()
Returns a hash code value for the object.private void
Recalculates the bounds for the collection of items.void
setDomainDescription
(String description) Sets the domain description and fires a property change event (with the property nameDomain
if the description changes).void
setRangeDescription
(String description) Sets the range description and fires a property change event with the nameRange
.void
Updates (changes) the value of a data item and sends aSeriesChangeEvent
to all registered listeners.private void
updateBounds
(TimePeriod period, int index) Update the index values for the maximum and minimum bounds.Methods inherited from class org.jfree.data.general.Series
addChangeListener, addPropertyChangeListener, addVetoableChangeListener, canEqual, firePropertyChange, fireSeriesChanged, fireVetoableChange, getDescription, getKey, getNotify, isEmpty, notifyListeners, removeChangeListener, removePropertyChangeListener, removeVetoableChangeListener, setDescription, setKey, setNotify
-
Field Details
-
serialVersionUID
static final long serialVersionUIDFor serialization.- See Also:
-
DEFAULT_DOMAIN_DESCRIPTION
Default value for the domain description.- See Also:
-
DEFAULT_RANGE_DESCRIPTION
Default value for the range description.- See Also:
-
domain
A description of the domain. -
range
A description of the range. -
data
The list of data pairs in the series. -
minStartIndex
private int minStartIndexIndex of the time period with the minimum start milliseconds. -
maxStartIndex
private int maxStartIndexIndex of the time period with the maximum start milliseconds. -
minMiddleIndex
private int minMiddleIndexIndex of the time period with the minimum middle milliseconds. -
maxMiddleIndex
private int maxMiddleIndexIndex of the time period with the maximum middle milliseconds. -
minEndIndex
private int minEndIndexIndex of the time period with the minimum end milliseconds. -
maxEndIndex
private int maxEndIndexIndex of the time period with the maximum end milliseconds.
-
-
Constructor Details
-
TimePeriodValues
Creates a new (empty) collection of time period values.- Parameters:
name
- the name of the series (null
not permitted).
-
TimePeriodValues
Creates a new time series that contains no data.Descriptions can be specified for the domain and range. One situation where this is helpful is when generating a chart for the time series - axis labels can be taken from the domain and range description.
- Parameters:
name
- the name of the series (null
not permitted).domain
- the domain description.range
- the range description.
-
-
Method Details
-
getDomainDescription
Returns the domain description.- Returns:
- The domain description (possibly
null
). - See Also:
-
setDomainDescription
Sets the domain description and fires a property change event (with the property nameDomain
if the description changes).- Parameters:
description
- the new description (null
permitted).- See Also:
-
getRangeDescription
Returns the range description.- Returns:
- The range description (possibly
null
). - See Also:
-
setRangeDescription
Sets the range description and fires a property change event with the nameRange
.- Parameters:
description
- the new description (null
permitted).- See Also:
-
getItemCount
public int getItemCount()Returns the number of items in the series.- Specified by:
getItemCount
in classSeries
- Returns:
- The item count.
-
getDataItem
Returns one data item for the series.- Parameters:
index
- the item index (in the range0
togetItemCount() -1
).- Returns:
- One data item for the series.
-
getTimePeriod
Returns the time period at the specified index.- Parameters:
index
- the item index (in the range0
togetItemCount() -1
).- Returns:
- The time period at the specified index.
- See Also:
-
getValue
Returns the value at the specified index.- Parameters:
index
- the item index (in the range0
togetItemCount() -1
).- Returns:
- The value at the specified index (possibly
null
). - See Also:
-
add
Adds a data item to the series and sends aSeriesChangeEvent
to all registered listeners.- Parameters:
item
- the item (null
not permitted).
-
updateBounds
Update the index values for the maximum and minimum bounds.- Parameters:
period
- the time period.index
- the index of the time period.
-
recalculateBounds
private void recalculateBounds()Recalculates the bounds for the collection of items. -
add
Adds a new data item to the series and sends aSeriesChangeEvent
to all registered listeners.- Parameters:
period
- the time period (null
not permitted).value
- the value.- See Also:
-
add
Adds a new data item to the series and sends aSeriesChangeEvent
to all registered listeners.- Parameters:
period
- the time period (null
not permitted).value
- the value (null
permitted).
-
update
Updates (changes) the value of a data item and sends aSeriesChangeEvent
to all registered listeners.- Parameters:
index
- the index of the data item to update.value
- the new value (null
not permitted).
-
delete
public void delete(int start, int end) Deletes data from start until end index (end inclusive) and sends aSeriesChangeEvent
to all registered listeners.- Parameters:
start
- the index of the first period to delete.end
- the index of the last period to delete.
-
equals
Tests the series for equality with another object. -
hashCode
public int hashCode()Returns a hash code value for the object. -
clone
Returns a clone of the collection.Notes:
- no need to clone the domain and range descriptions, since String object is immutable;
- we pass over to the more general method createCopy(start, end).
- Overrides:
clone
in classSeries
- Returns:
- A clone of the time series.
- Throws:
CloneNotSupportedException
- if there is a cloning problem.
-
createCopy
Creates a new instance by copying a subset of the data in this collection.- Parameters:
start
- the index of the first item to copy.end
- the index of the last item to copy.- Returns:
- A copy of a subset of the items.
- Throws:
CloneNotSupportedException
- if there is a cloning problem.
-
getMinStartIndex
public int getMinStartIndex()Returns the index of the time period with the minimum start milliseconds.- Returns:
- The index.
-
getMaxStartIndex
public int getMaxStartIndex()Returns the index of the time period with the maximum start milliseconds.- Returns:
- The index.
-
getMinMiddleIndex
public int getMinMiddleIndex()Returns the index of the time period with the minimum middle milliseconds.- Returns:
- The index.
-
getMaxMiddleIndex
public int getMaxMiddleIndex()Returns the index of the time period with the maximum middle milliseconds.- Returns:
- The index.
-
getMinEndIndex
public int getMinEndIndex()Returns the index of the time period with the minimum end milliseconds.- Returns:
- The index.
-
getMaxEndIndex
public int getMaxEndIndex()Returns the index of the time period with the maximum end milliseconds.- Returns:
- The index.
-