jdplus.toolkit.desktop.plugin.ui.TsXYDatasets Maven / Gradle / Ivy
/*
* Copyright 2013 National Bank of Belgium
*
* Licensed under the EUPL, Version 1.1 or – as soon they will be approved
* by the European Commission - subsequent versions of the EUPL (the "Licence");
* You may not use this work except in compliance with the Licence.
* You may obtain a copy of the Licence at:
*
* http://ec.europa.eu/idabc/eupl
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the Licence is distributed on an "AS IS" basis,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the Licence for the specific language governing permissions and
* limitations under the Licence.
*/
package jdplus.toolkit.desktop.plugin.ui;
import jdplus.toolkit.base.api.timeseries.Ts;
import jdplus.toolkit.base.api.timeseries.TsData;
import jdplus.toolkit.base.api.timeseries.TsPeriod;
import ec.util.chart.swing.Charts;
import java.util.*;
import org.checkerframework.checker.nullness.qual.NonNull;
import org.jfree.data.DomainOrder;
import org.jfree.data.general.AbstractSeriesDataset;
import org.jfree.data.xy.IntervalXYDataset;
/**
* An utility class that simplifies the creation of a IntervalXYDataset from
* time series.
*
* @author Philippe Charles
*/
public final class TsXYDatasets {
private TsXYDatasets() {
// static class
}
// a shared builder used in the event dispatch thread
private static final Builder EDT_BUILDER = new Builder();
@NonNull
public static IntervalXYDataset from(@NonNull Comparable key, @NonNull TsPeriod start, @NonNull double[] data) {
return EDT_BUILDER.clear().add(key, start, data).build();
}
@NonNull
public static IntervalXYDataset from(@NonNull Comparable key, @NonNull TsData data) {
return EDT_BUILDER.clear().add(key, data).build();
}
@NonNull
public static IntervalXYDataset from(@NonNull Iterable tss) {
return EDT_BUILDER.clear().add(tss).build();
}
@NonNull
public static IntervalXYDataset from(@NonNull Ts... tss) {
return EDT_BUILDER.clear().add(tss).build();
}
@NonNull
public static Builder builder() {
return new Builder();
}
public static final class Builder {
// Let's avoid duplicated keys.
private final Set> keys = new HashSet<>();
private final List list = new ArrayList<>();
private void checkKey(Comparable key) {
Objects.requireNonNull(key, "Cannot add null key");
// Preconditions.checkArgument(!keys.contains(key), "Duplicated key");
}
private void add(TsFacade item) {
keys.add(item.getKey());
list.add(item);
}
private void addTs(Ts ts) {
Objects.requireNonNull(ts, "Ts cannot be null");
checkKey(ts.getMoniker());
if (! ts.getData().isEmpty()) {
add(FastTs.create(ts));
}
}
@NonNull
public Builder add(@NonNull Comparable key, @NonNull TsPeriod start, @NonNull double[] data) {
checkKey(key);
Objects.requireNonNull(start, "Start cannot be null");
Objects.requireNonNull(data, "Data cannot be null");
if (data.length > 0) {
add(FastTs.create(key, start, data));
}
return this;
}
@NonNull
public Builder add(@NonNull Comparable key, @NonNull TsData data) {
checkKey(key);
Objects.requireNonNull(data, "Data cannot be null");
if (!data.isEmpty()) {
add(FastTs.create(key, data));
}
return this;
}
@NonNull
public Builder add(@NonNull Iterable tss) {
for (Ts o : tss) {
addTs(o);
}
return this;
}
@NonNull
public Builder add(@NonNull Ts... tss) {
for (Ts o : tss) {
addTs(o);
}
return this;
}
@NonNull
public Builder clear() {
keys.clear();
list.clear();
return this;
}
public IntervalXYDataset build() {
switch (list.size()) {
case 0:
return Charts.emptyXYDataset();
case 1:
return new SingleTsXYDataset(list.get(0));
default:
return new MultiTsXYDataset(Collections.unmodifiableList(list));
}
}
}
//
private static abstract class AbstractTsXYDataset extends AbstractSeriesDataset implements IntervalXYDataset {
@Override
public Number getStartX(int series, int item) {
return getStartXValue(series, item);
}
@Override
public Number getEndX(int series, int item) {
return getEndXValue(series, item);
}
@Override
public Number getStartY(int series, int item) {
return getEndYValue(series, item);
}
@Override
public double getStartYValue(int series, int item) {
return getYValue(series, item);
}
@Override
public Number getEndY(int series, int item) {
return getEndYValue(series, item);
}
@Override
public double getEndYValue(int series, int item) {
return getYValue(series, item);
}
@Override
public DomainOrder getDomainOrder() {
return DomainOrder.NONE;
}
@Override
public Number getX(int series, int item) {
return getXValue(series, item);
}
@Override
public Number getY(int series, int item) {
return getYValue(series, item);
}
}
private static final class MultiTsXYDataset extends AbstractTsXYDataset {
private final List list;
private MultiTsXYDataset(@NonNull List list) {
this.list = list;
}
@Override
public int getSeriesCount() {
return list.size();
}
@Override
public Comparable getSeriesKey(int series) {
return list.get(series).getKey();
}
@Override
public double getStartXValue(int series, int item) {
return list.get(series).getStartTimeInMillis(item);
}
@Override
public double getEndXValue(int series, int item) {
return list.get(series).getEndTimeInMillis(item);
}
@Override
public int getItemCount(int series) {
return list.get(series).getItemCount();
}
@Override
public double getXValue(int series, int item) {
return list.get(series).getMiddleTimeInMillis(item);
}
@Override
public double getYValue(int series, int item) {
return list.get(series).getValue(item);
}
}
private static final class SingleTsXYDataset extends AbstractTsXYDataset {
private final TsFacade singleton;
private SingleTsXYDataset(@NonNull TsFacade singleton) {
this.singleton = singleton;
}
@Override
public int getSeriesCount() {
return 1;
}
@Override
public Comparable getSeriesKey(int series) {
return singleton.getKey();
}
@Override
public double getStartXValue(int series, int item) {
return singleton.getStartTimeInMillis(item);
}
@Override
public double getEndXValue(int series, int item) {
return singleton.getEndTimeInMillis(item);
}
@Override
public int getItemCount(int series) {
return singleton.getItemCount();
}
@Override
public double getXValue(int series, int item) {
return singleton.getMiddleTimeInMillis(item);
}
@Override
public double getYValue(int series, int item) {
return singleton.getValue(item);
}
}
private interface TsFacade {
Comparable getKey();
int getItemCount();
double getValue(int item);
long getStartTimeInMillis(int item);
long getEndTimeInMillis(int item);
long getMiddleTimeInMillis(int item);
}
/**
* A simple but efficient structure that holds every essential TS
* information and data.
*/
private static final class FastTs implements TsFacade {
// a shared calendar used in the event dispatch thread
private static final Calendar EDT_CALENDAR = Calendar.getInstance(TimeZone.getDefault(), Locale.getDefault(Locale.Category.FORMAT));
// FACTORY METHODS
@NonNull
static FastTs create(@NonNull Ts ts) {
return create(ts.getMoniker(), ts.getData());
}
@NonNull
static FastTs create(@NonNull Comparable key, @NonNull TsData data) {
return create(key, data.getStart(), data.getValues().toArray());
}
@NonNull
static FastTs create(@NonNull Comparable key, @NonNull TsPeriod start, @NonNull double[] data) {
int freq = start.annualFrequency();
int year=start.year(), pos=start.annualPosition();
return new FastTs(EDT_CALENDAR, key, freq, year, pos, data);
}
// PROPERTIES
private final Calendar cal;
private final Comparable key;
private final int freq;
private final int startYear;
private final int startPos;
private final double[] data;
private FastTs(@NonNull Calendar cal, @NonNull Comparable key, int freq, int startYear, int startPos, @NonNull double[] data) {
this.cal = cal;
this.key = key;
this.freq = freq;
this.startYear = startYear;
this.startPos = startPos;
this.data = data;
}
@Override
public Comparable getKey() {
return key;
}
@Override
public int getItemCount() {
return data.length;
}
@Override
public double getValue(int item) {
return data[item];
}
@Override
public long getStartTimeInMillis(int item) {
final int tmp = startPos + item;
cal.set(Calendar.YEAR, startYear + tmp / freq);
cal.set(Calendar.MONTH, (tmp % freq) * (12 / freq));
cal.set(Calendar.DAY_OF_MONTH, 1);
cal.set(Calendar.HOUR_OF_DAY, 0);
cal.set(Calendar.MINUTE, 0);
cal.set(Calendar.SECOND, 0);
cal.set(Calendar.MILLISECOND, 0);
return cal.getTimeInMillis();
}
@Override
public long getEndTimeInMillis(int item) {
return getStartTimeInMillis(item + 1);
}
@Override
public long getMiddleTimeInMillis(int item) {
long start = getStartTimeInMillis(item);
cal.add(Calendar.MONTH, 12 / freq);
long end = cal.getTimeInMillis();
return start + (end - start) / 2;
}
}
//
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy