com.zavtech.morpheus.viz.chart.xy

Interface XyDataset<X extends Comparable,S extends Comparable>

All Known Implementing Classes:

GXyDataset, JFCatDataset, JFXyDataset

public interface XyDataset<X extends Comparable,S extends Comparable>

Interface to an XY dataset that is associated with a single DataFrame which holds the data for an XYPlot.

Author:

Xavier Witdouck

This is open source software released under the Apache 2.0 License

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
boolean	isEmpty() Returns true if this dataset is empty
void	refresh() Triggers a refresh of this data based on the bound supplier
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

Method Detail

refresh

void refresh()

Triggers a refresh of this data based on the bound supplier

isEmpty

boolean isEmpty()

Returns true if this dataset is empty

Returns:

true if no data

clear

void clear(boolean notify)

Clears all data for this dataset

Parameters:

notify - if true, fire notification event

frame

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

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

Returns:

the frame for this data

domainType

Class<X> domainType()

Returns the domain type for this dataset

Returns:

the domain type for dataset

domainFunction

IntFunction<X> domainFunction()

Returns the domain function for this dataset

Returns:

the domain function the yield domain values for an index

contains

boolean contains(S seriesKey)

Returns true if this data contains the series specified

Parameters:

seriesKey - the series key

Returns:

true if this data contains the series

withLowerDomainInterval

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

Parameters:

lowerIntervalFunction - the lower domain interval function

Returns:

this model reference

withUpperDomainInterval

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

Parameters:

upperIntervalFunction - the upper domain interval function

Returns:

this model reference