com.zavtech.morpheus.viz.jfree

Class JFCatDataset<X extends Comparable,S extends Comparable>

java.lang.Object

org.jfree.data.general.AbstractDataset

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

All Implemented Interfaces:

XyDataset<X,S>, ObjectInputValidation, Serializable, Cloneable, org.jfree.data.category.CategoryDataset, org.jfree.data.general.Dataset, org.jfree.data.KeyedValues2D, org.jfree.data.Values2D

class JFCatDataset<X extends Comparable,S extends Comparable>
extends org.jfree.data.general.AbstractDataset
implements XyDataset<X,S>, org.jfree.data.category.CategoryDataset

A JFreeChart dataset adapter for category plots

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 com.zavtech.morpheus.index.Index<X>	domainKeys
private Supplier<Class<X>>	domainType
private IntFunction<X>	domainValueFunction
private com.zavtech.morpheus.frame.DataFrame<?,S>	frame
private static Double	NAN
private Consumer<JFCatDataset<X,S>>	refreshHandler
private com.zavtech.morpheus.index.Index<S>	seriesKeys

Constructor Summary

Constructors

Modifier	Constructor and Description
private	JFCatDataset(Consumer<JFCatDataset<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
<R> com.zavtech.morpheus.frame.DataFrame<R,S>	frame() Returns the current frame for this data, which can be null
int	getColumnCount()
int	getColumnIndex(Comparable colKey)
Comparable	getColumnKey(int colIndex)
List	getColumnKeys()
int	getRowCount()
int	getRowIndex(Comparable rowKey)
Comparable	getRowKey(int rowIndex)
List	getRowKeys()
Number	getValue(Comparable rowKey, Comparable colKey)
Number	getValue(int rowIndex, int colIndex)
boolean	isEmpty() Returns true if this dataset is empty
static <X extends Comparable,S extends Comparable> JFCatDataset<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
static <X extends Comparable,S extends Comparable> JFCatDataset<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 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.general.AbstractDataset

addChangeListener, clone, fireDatasetChanged, 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.general.Dataset

addChangeListener, getGroup, removeChangeListener, setGroup

Field Detail

NAN

private static final Double NAN

seriesKeys

private com.zavtech.morpheus.index.Index<S extends Comparable> seriesKeys

domainKeys

private com.zavtech.morpheus.index.Index<X extends Comparable> domainKeys

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<JFCatDataset<X extends Comparable,S extends Comparable>> refreshHandler

Constructor Detail

JFCatDataset

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

Constructor

Parameters:

refreshHandler - the refresh handler

Method Detail

of

public static <X extends Comparable,S extends Comparable> JFCatDataset<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

public static <X extends Comparable,S extends Comparable> JFCatDataset<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 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 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 <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

contains

public 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

domainFunction

public 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

withLowerDomainInterval

public 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 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

getRowCount

public int getRowCount()

Specified by:

getRowCount in interface org.jfree.data.Values2D

getColumnCount

public int getColumnCount()

Specified by:

getColumnCount in interface org.jfree.data.Values2D

getRowKeys

public List getRowKeys()

Specified by:

getRowKeys in interface org.jfree.data.KeyedValues2D

getColumnKeys

public List getColumnKeys()

Specified by:

getColumnKeys in interface org.jfree.data.KeyedValues2D

getRowKey

public Comparable getRowKey(int rowIndex)

Specified by:

getRowKey in interface org.jfree.data.KeyedValues2D

getColumnKey

public Comparable getColumnKey(int colIndex)

Specified by:

getColumnKey in interface org.jfree.data.KeyedValues2D

getRowIndex

public int getRowIndex(Comparable rowKey)

Specified by:

getRowIndex in interface org.jfree.data.KeyedValues2D

getColumnIndex

public int getColumnIndex(Comparable colKey)

Specified by:

getColumnIndex in interface org.jfree.data.KeyedValues2D

getValue

public Number getValue(Comparable rowKey,
                       Comparable colKey)

Specified by:

getValue in interface org.jfree.data.KeyedValues2D

getValue

public Number getValue(int rowIndex,
                       int colIndex)

Specified by:

getValue in interface org.jfree.data.Values2D