com.zavtech.morpheus.viz.google

Class GXyDataset<X extends Comparable,S extends Comparable>

java.lang.Object

com.zavtech.morpheus.viz.google.GXyDataset<X,S>

All Implemented Interfaces:

XyDataset<X,S>

class GXyDataset<X extends Comparable,S extends Comparable>
extends Object
implements XyDataset<X,S>

An implementation of the XyDataset interface to be used with Google charts

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 Consumer<GXyDataset<X,S>>	refreshHandler

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	accept(JsCode script)
void	clear(boolean notify) Clears all data for this dataset
boolean	contains(S seriesKey) Returns true if this data contains the series specified
private Function<Object,String>	createDomainFunction(Class<?> dataType) Creates a function that yields a long time value in epoch millis given some input
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
(package private) Class<X>	getDomainKeyType() Returns the class of the domain values in this dataset
int	getDomainSize() Returns the number of values per series
X	getDomainValue(int item) Returns the domain value for the item index
Iterable<X>	getDomainValues() Returns the iterable of domain values for this dataset
double	getRangeValue(int item, int series) Returns the range value for the item and series index
int	getSeriesCount() Returns the number of series in this dataset
S	getSeriesKey(int series) Returns the series for the index specified
Iterable<S>	getSeriesKeys() Returns the series keys for this dataset
boolean	isEmpty() Returns true if this dataset is empty
static void	main(String[] args)
(package private) static <X extends Comparable,S extends Comparable> GXyDataset<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> GXyDataset<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 java.lang.Object

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

Field Detail

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

Constructor Detail

GXyDataset

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

Constructor

Parameters:

refreshHandler - the refresh handler

Method Detail

of

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

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

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

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

getDomainKeyType

Class<X> getDomainKeyType()

Returns the class of the domain values in this dataset

Returns:

the class of the domain values in this dataset

getDomainValues

public Iterable<X> getDomainValues()

Returns the iterable of domain values for this dataset

Returns:

the iterable domain values

getSeriesKeys

public Iterable<S> getSeriesKeys()

Returns the series keys for this dataset

Returns:

the series keys for dataset

getSeriesCount

public int getSeriesCount()

Returns the number of series in this dataset

Returns:

the number of series

getSeriesKey

public S getSeriesKey(int series)

Returns the series for the index specified

Parameters:

series - the series index

Returns:

the series key

getDomainSize

public int getDomainSize()

Returns the number of values per series

Returns:

the number of values per series

getDomainValue

public X getDomainValue(int item)

Returns the domain value for the item index

Parameters:

item - the item index

Returns:

the corresponding domain value

getRangeValue

public double getRangeValue(int item,
                            int series)

Returns the range value for the item and series index

Parameters:

item - the item index

series - the series index

Returns:

the range value

accept

public void accept(JsCode script)

createDomainFunction

private Function<Object,String> createDomainFunction(Class<?> dataType)

Creates a function that yields a long time value in epoch millis given some input

Parameters:

dataType - the data type

Returns:

the function to resolve epoch millis

main

public static void main(String[] args)