com.zavtech.morpheus.viz.chart.xy

Class XyTrendBase

java.lang.Object

com.zavtech.morpheus.viz.chart.xy.XyTrendBase

All Implemented Interfaces:

XyTrend

Direct Known Subclasses:

JFXyPlot.TrendLine

public abstract class XyTrendBase
extends Object
implements XyTrend

A convenience base class for building XyTrend implementations

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 double	beta
private double	intercept
private double	rSquared
private Comparable	seriesKey

Constructor Summary

Constructors

Constructor and Description
XyTrendBase(Comparable seriesKey) Constructor

Method Summary

Modifier and Type	Method and Description
private <X extends Comparable> com.zavtech.morpheus.frame.DataFrame<Integer,Object>	createSeriesData(XyDataset<X,Comparable> dataset, Comparable seriesKey) Returns a newly created DataFrame representing the series specified
<X extends Comparable> com.zavtech.morpheus.frame.DataFrame<Double,Comparable>	createTrendData(XyDataset<X,Comparable> source, Comparable seriesKey, Comparable trendKey) Returns a newly created single column DataFrame with the trend line values
double	intercept() Returns the regression intercept
double	r2() Returns the R-squared
Comparable	seriesKey() Returns the series key for this trend line
double	slope() Returns the regression slope

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.zavtech.morpheus.viz.chart.xy.XyTrend

clear, withColor, withLineWidth

Field Detail

seriesKey

private Comparable seriesKey

beta

private double beta

intercept

private double intercept

rSquared

private double rSquared

Constructor Detail

XyTrendBase

public XyTrendBase(Comparable seriesKey)

Constructor

Parameters:

seriesKey - the series key for trend

Method Detail

seriesKey

public Comparable seriesKey()

Description copied from interface: XyTrend

Returns the series key for this trend line

Specified by:

seriesKey in interface XyTrend

Returns:

the series key

r2

public double r2()

Returns the R-squared

Returns:

the R-squared

slope

public double slope()

Returns the regression slope

Returns:

slope parameter

intercept

public double intercept()

Returns the regression intercept

Returns:

intercept parameter

createTrendData

public <X extends Comparable> com.zavtech.morpheus.frame.DataFrame<Double,Comparable> createTrendData(XyDataset<X,Comparable> source,
                                                                                                      Comparable seriesKey,
                                                                                                      Comparable trendKey)

Returns a newly created single column DataFrame with the trend line values

Type Parameters:

X - the domain axis type

Parameters:

source - the source model from which to create the trend line from

seriesKey - the series key in the source model from which to generate the trend

Returns:

the newly created trend line DataFrame

createSeriesData

private <X extends Comparable> com.zavtech.morpheus.frame.DataFrame<Integer,Object> createSeriesData(XyDataset<X,Comparable> dataset,
                                                                                                     Comparable seriesKey)

Returns a newly created DataFrame representing the series specified

Parameters:

seriesKey - the series key

Returns:

the one series DataFrame