desmoj.core.report.html5chart

Class ChartDataTimeSeries

java.lang.Object

desmoj.core.report.html5chart.AbstractChartDataTable<java.lang.Double>

desmoj.core.report.html5chart.ChartDataTimeSeries

All Implemented Interfaces:

AbstractChartData<java.lang.Double>

public class ChartDataTimeSeries
extends AbstractChartDataTable<java.lang.Double>

A chart data for a Time Series.
Data of a chart, which display a relationship between two variables from type Double.

Version:

DESMO-J, Ver. 2.5.1c copyright (c) 2015

Author:

Johanna Djimandjaja Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Constructor Summary

Constructors

Constructor and Description
ChartDataTimeSeries(Model ownerModel, java.util.List<java.lang.Double> timeValues, java.util.List<java.lang.Double> dataValues, java.lang.Double validFrom, java.lang.Double validTo, java.lang.String group) Create an Object to represent the data for a TimeSeries.

Method Summary

Modifier and Type	Method and Description
java.lang.Double[]	getDataValues() Return an array of data values.
java.lang.String	getGroup() Returns the group ID value.
java.lang.Double[]	getTimeValues() Returns an array of time values.
double	getValidFrom() Returns the lowest possible time value.
double	getValidTo() Returns the highest possible time value.

Methods inherited from class desmoj.core.report.html5chart.AbstractChartDataTable

getDataValue, getHighestDataValue, getNumOfData, getOwnerModel, isEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

ChartDataTimeSeries

public ChartDataTimeSeries(Model ownerModel,
                           java.util.List<java.lang.Double> timeValues,
                           java.util.List<java.lang.Double> dataValues,
                           java.lang.Double validFrom,
                           java.lang.Double validTo,
                           java.lang.String group)

Create an Object to represent the data for a TimeSeries.

Parameters:

ownerModel - Model : The owner model this chart data is associated to.

timeValues - java.util.List : List for saving the time values in the memory.

dataValues - java.util.List : List for saving the data values in the memory.

validFrom - Double : Start of the interval of the time series.

validTo - Double : End of the interval of the time series.

group - String : An ID to separate different plots into different diagrams, if desired.

Method Detail

getDataValues

public java.lang.Double[] getDataValues()

Return an array of data values.

Returns:

an array of data values

getTimeValues

public java.lang.Double[] getTimeValues()

Returns an array of time values.

Returns:

an array of time values

getValidTo

public double getValidTo()

Returns the highest possible time value.

Returns:

the highest possible time value

getValidFrom

public double getValidFrom()

Returns the lowest possible time value.

Returns:

the lowest possible time value

getGroup

public java.lang.String getGroup()

Returns the group ID value.

Returns:

the group ID value