com.zavtech.morpheus.viz.jfree

Class JFXyDataset<X extends Comparable,S extends Comparable>

java.lang.Object

org.jfree.data.general.AbstractDataset

org.jfree.data.general.AbstractSeriesDataset

org.jfree.data.xy.AbstractXYDataset

com.zavtech.morpheus.viz.jfree.JFXyDataset<X,S>

All Implemented Interfaces:

XyDataset<X,S>, ObjectInputValidation, Serializable, Cloneable, EventListener, org.jfree.data.general.Dataset, org.jfree.data.general.SeriesChangeListener, org.jfree.data.general.SeriesDataset, org.jfree.data.xy.IntervalXYDataset, org.jfree.data.xy.TableXYDataset, org.jfree.data.xy.XYDataset, org.jfree.data.xy.XYZDataset

class JFXyDataset<X extends Comparable,S extends Comparable>
extends org.jfree.data.xy.AbstractXYDataset
implements XyDataset<X,S>, org.jfree.data.xy.IntervalXYDataset, org.jfree.data.xy.TableXYDataset, org.jfree.data.xy.XYZDataset

An implementation of the Morpheus XyDataset interface and various JFreeChart interfaces to support plotting of a DataFrame in JFreeChart

Author:

Xavier Witdouck

This is open source software released under the Apache 2.0 License

Field Summary

Fields

Modifier and Type	Field and Description
private com.zavtech.morpheus.array.Array<Integer>	colOrdinals
private Supplier<Class<X>>	domainType
private IntFunction<X>	domainValueFunction
private com.zavtech.morpheus.frame.DataFrame<?,S>	frame
private Function<X,X>	lowerDomainIntervalFunction
private static Double	NAN
private Consumer<JFXyDataset<X,S>>	refreshHandler
private Function<X,X>	upperDomainIntervalFunction

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JFXyDataset(Consumer<JFXyDataset<X,S>> refreshHandler) Constructor

Method Summary

Modifier and Type	Method and Description
void	clear(boolean notify) Clears all data for this dataset
boolean	contains(S seriesKey) Returns true if this data contains the series specified
IntFunction<X>	domainFunction() Returns the domain function for this dataset
Class<X>	domainType() Returns the domain type for this dataset
void	fireDatasetChanged()
<R> com.zavtech.morpheus.frame.DataFrame<R,S>	frame() Returns the current frame for this data, which can be null
Number	getEndX(int series, int item)
double	getEndXValue(int series, int item)
Number	getEndY(int series, int item)
double	getEndYValue(int series, int item)
int	getItemCount()
int	getItemCount(int series)
int	getSeriesCount()
S	getSeriesKey(int series)
Number	getStartX(int series, int item)
double	getStartXValue(int series, int item)
Number	getStartY(int series, int item)
double	getStartYValue(int series, int item)
Number	getX(int series, int item)
double	getXValue(int series, int item)
Number	getY(int series, int item)
double	getYValue(int series, int item)
Number	getZ(int series, int item)
double	getZValue(int series, int item)
boolean	isEmpty() Returns true if this dataset is empty
(package private) static <X extends Comparable,S extends Comparable> JFXyDataset<X,S>	of(S domainAxisKey, Supplier<com.zavtech.morpheus.frame.DataFrame<?,S>> frameSupplier) Returns a newly created model using a frame supplier where the domain is presented by a column in the DataFrame
(package private) static <X extends Comparable,S extends Comparable> JFXyDataset<X,S>	of(Supplier<com.zavtech.morpheus.frame.DataFrame<X,S>> frameSupplier) Returns a newly created model using a frame supplier where the domain is presented by the DataFrame row keys
void	refresh() Triggers a refresh of this data based on the bound supplier
private Number	toNumber(Object value) Returns a numeric representation of the value argument
private void	update(com.zavtech.morpheus.frame.DataFrame<?,S> frame, com.zavtech.morpheus.array.Array<Integer> colOrdinals, Supplier<Class<X>> domainType, IntFunction<X> domainValueFunction) Updates this model with the DataFrame, series column ordinals and domain value function
XyDataset<X,S>	withLowerDomainInterval(Function<X,X> lowerIntervalFunction) Sets the function to supply the lower domain interval value for this dataset The lower domain interval function accepts a domain key and returns the interval to subtract
XyDataset<X,S>	withUpperDomainInterval(Function<X,X> upperIntervalFunction) Sets the function to supply the upper domain interval value for this dataset The upper domain interval function accepts a domain key and returns the interval to subtract

Methods inherited from class org.jfree.data.xy.AbstractXYDataset

getDomainOrder

Methods inherited from class org.jfree.data.general.AbstractSeriesDataset

indexOf, seriesChanged

Methods inherited from class org.jfree.data.general.AbstractDataset

addChangeListener, clone, getGroup, hasListener, notifyListeners, removeChangeListener, setGroup, validateObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.data.xy.XYDataset

getDomainOrder

Methods inherited from interface org.jfree.data.general.SeriesDataset

indexOf

Methods inherited from interface org.jfree.data.general.Dataset

addChangeListener, getGroup, removeChangeListener, setGroup

Field Detail

NAN

private static final Double NAN

frame

private com.zavtech.morpheus.frame.DataFrame<?,S extends Comparable> frame

colOrdinals

private com.zavtech.morpheus.array.Array<Integer> colOrdinals

domainType

private Supplier<Class<X extends Comparable>> domainType

domainValueFunction

private IntFunction<X extends Comparable> domainValueFunction

refreshHandler

private Consumer<JFXyDataset<X extends Comparable,S extends Comparable>> refreshHandler

lowerDomainIntervalFunction

private Function<X extends Comparable,X extends Comparable> lowerDomainIntervalFunction

upperDomainIntervalFunction

private Function<X extends Comparable,X extends Comparable> upperDomainIntervalFunction

Constructor Detail

JFXyDataset

private JFXyDataset(Consumer<JFXyDataset<X,S>> refreshHandler)

Constructor

Parameters:

refreshHandler - the refresh handler for this model

Method Detail

of

static <X extends Comparable,S extends Comparable> JFXyDataset<X,S> of(Supplier<com.zavtech.morpheus.frame.DataFrame<X,S>> frameSupplier)

Returns a newly created model using a frame supplier where the domain is presented by the DataFrame row keys

Type Parameters:

X - the domain key type

S - the series key type

Parameters:

frameSupplier - the DataFrame supplier for this model

Returns:

the newly created model

of

static <X extends Comparable,S extends Comparable> JFXyDataset<X,S> of(S domainAxisKey,
                                                                       Supplier<com.zavtech.morpheus.frame.DataFrame<?,S>> frameSupplier)

Returns a newly created model using a frame supplier where the domain is presented by a column in the DataFrame

Type Parameters:

X - the domain key type

S - the series key type

Parameters:

domainAxisKey - the DataFrame column key for the domain

frameSupplier - the DataFrame supplier for this model

Returns:

the newly created model

update

private void update(com.zavtech.morpheus.frame.DataFrame<?,S> frame,
                    com.zavtech.morpheus.array.Array<Integer> colOrdinals,
                    Supplier<Class<X>> domainType,
                    IntFunction<X> domainValueFunction)

Updates this model with the DataFrame, series column ordinals and domain value function

Parameters:

frame - the DataFrame to accept

colOrdinals - the series column ordinals

domainValueFunction - the domain value function

refresh

public void refresh()

Description copied from interface: XyDataset

Triggers a refresh of this data based on the bound supplier

Specified by:

refresh in interface XyDataset<X extends Comparable,S extends Comparable>

isEmpty

public final boolean isEmpty()

Description copied from interface: XyDataset

Returns true if this dataset is empty

Specified by:

isEmpty in interface XyDataset<X extends Comparable,S extends Comparable>

Returns:

true if no data

clear

public final void clear(boolean notify)

Description copied from interface: XyDataset

Clears all data for this dataset

Specified by:

clear in interface XyDataset<X extends Comparable,S extends Comparable>

Parameters:

notify - if true, fire notification event

domainType

public Class<X> domainType()

Description copied from interface: XyDataset

Returns the domain type for this dataset

Specified by:

domainType in interface XyDataset<X extends Comparable,S extends Comparable>

Returns:

the domain type for dataset

frame

public final <R> com.zavtech.morpheus.frame.DataFrame<R,S> frame()

Description copied from interface: XyDataset

Returns the current frame for this data, which can be null

Specified by:

frame in interface XyDataset<X extends Comparable,S extends Comparable>

Returns:

the frame for this data

domainFunction

public final IntFunction<X> domainFunction()

Description copied from interface: XyDataset

Returns the domain function for this dataset

Specified by:

domainFunction in interface XyDataset<X extends Comparable,S extends Comparable>

Returns:

the domain function the yield domain values for an index

contains

public final boolean contains(S seriesKey)

Description copied from interface: XyDataset

Returns true if this data contains the series specified

Specified by:

contains in interface XyDataset<X extends Comparable,S extends Comparable>

Parameters:

seriesKey - the series key

Returns:

true if this data contains the series

withLowerDomainInterval

public final XyDataset<X,S> withLowerDomainInterval(Function<X,X> lowerIntervalFunction)

Description copied from interface: XyDataset

Sets the function to supply the lower domain interval value for this dataset The lower domain interval function accepts a domain key and returns the interval to subtract

Specified by:

withLowerDomainInterval in interface XyDataset<X extends Comparable,S extends Comparable>

Parameters:

lowerIntervalFunction - the lower domain interval function

Returns:

this model reference

withUpperDomainInterval

public final XyDataset<X,S> withUpperDomainInterval(Function<X,X> upperIntervalFunction)

Description copied from interface: XyDataset

Sets the function to supply the upper domain interval value for this dataset The upper domain interval function accepts a domain key and returns the interval to subtract

Specified by:

withUpperDomainInterval in interface XyDataset<X extends Comparable,S extends Comparable>

Parameters:

upperIntervalFunction - the upper domain interval function

Returns:

this model reference

getItemCount

public final int getItemCount()

Specified by:

getItemCount in interface org.jfree.data.xy.TableXYDataset

getSeriesCount

public final int getSeriesCount()

Specified by:

getSeriesCount in interface org.jfree.data.general.SeriesDataset

Specified by:

getSeriesCount in class org.jfree.data.general.AbstractSeriesDataset

getSeriesKey

public final S getSeriesKey(int series)

Specified by:

getSeriesKey in interface org.jfree.data.general.SeriesDataset

Specified by:

getSeriesKey in class org.jfree.data.general.AbstractSeriesDataset

getItemCount

public final int getItemCount(int series)

Specified by:

getItemCount in interface org.jfree.data.xy.XYDataset

getZ

public final Number getZ(int series,
                         int item)

Specified by:

getZ in interface org.jfree.data.xy.XYZDataset

getZValue

public final double getZValue(int series,
                              int item)

Specified by:

getZValue in interface org.jfree.data.xy.XYZDataset

getX

public final Number getX(int series,
                         int item)

Specified by:

getX in interface org.jfree.data.xy.XYDataset

getY

public final Number getY(int series,
                         int item)

Specified by:

getY in interface org.jfree.data.xy.XYDataset

getStartX

public final Number getStartX(int series,
                              int item)

Specified by:

getStartX in interface org.jfree.data.xy.IntervalXYDataset

getEndX

public final Number getEndX(int series,
                            int item)

Specified by:

getEndX in interface org.jfree.data.xy.IntervalXYDataset

getStartY

public final Number getStartY(int series,
                              int item)

Specified by:

getStartY in interface org.jfree.data.xy.IntervalXYDataset

getEndY

public Number getEndY(int series,
                      int item)

Specified by:

getEndY in interface org.jfree.data.xy.IntervalXYDataset

getXValue

public final double getXValue(int series,
                              int item)

Specified by:

getXValue in interface org.jfree.data.xy.XYDataset

Overrides:

getXValue in class org.jfree.data.xy.AbstractXYDataset

getYValue

public final double getYValue(int series,
                              int item)

Specified by:

getYValue in interface org.jfree.data.xy.XYDataset

Overrides:

getYValue in class org.jfree.data.xy.AbstractXYDataset

getStartXValue

public final double getStartXValue(int series,
                                   int item)

Specified by:

getStartXValue in interface org.jfree.data.xy.IntervalXYDataset

getEndXValue

public final double getEndXValue(int series,
                                 int item)

Specified by:

getEndXValue in interface org.jfree.data.xy.IntervalXYDataset

getStartYValue

public final double getStartYValue(int series,
                                   int item)

Specified by:

getStartYValue in interface org.jfree.data.xy.IntervalXYDataset

getEndYValue

public final double getEndYValue(int series,
                                 int item)

Specified by:

getEndYValue in interface org.jfree.data.xy.IntervalXYDataset

fireDatasetChanged

public void fireDatasetChanged()

Overrides:

fireDatasetChanged in class org.jfree.data.general.AbstractDataset

toNumber

private Number toNumber(Object value)

Returns a numeric representation of the value argument

Parameters:

value - the value to turn into a number

Returns:

the numeric value