jcckit.data

Class DataCurve

java.lang.Object

jcckit.data.DataContainer

jcckit.data.DataCurve

All Implemented Interfaces:

DataElement

public class DataCurve
extends DataContainer
implements DataElement

A curve is a DataContainer of DataPoints.

Author:

Franz-Josef Elmer

Field Summary

Fields

Modifier and Type	Field and Description
static String	TITLE_KEY Config parameter key.
static String	X_KEY Config parameter key.
static String	Y_KEY Config parameter key.

Constructor Summary

Constructors

Constructor and Description
DataCurve(ConfigParameters config) Creates an instance from the specified config parameters.
DataCurve(String title) Creates an empty instance with the specified title.

Method Summary

Modifier and Type	Method and Description
DataContainer	getContainer() Returns the DataPlot containing this curve.
String	getTitle() Returns the title of this curve.
protected boolean	isValid(DataElement element) Returns true if element is an instance of DataPoint.
void	setContainer(DataContainer container) Sets the DataPlot where this is a curve of.

Methods inherited from class jcckit.data.DataContainer

addDataListener, addElement, getElement, getIndexOf, getNumberOfElements, insertElementAt, removeDataListener, removeElementAt, replaceElementAt

Methods inherited from class java.lang.Object

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

Field Detail

X_KEY

public static final String X_KEY

Config parameter key.

See Also:

Constant Field Values

Y_KEY

public static final String Y_KEY

Config parameter key.

See Also:

Constant Field Values

TITLE_KEY

public static final String TITLE_KEY

Config parameter key.

See Also:

Constant Field Values

Constructor Detail

DataCurve

public DataCurve(String title)

Creates an empty instance with the specified title.

DataCurve

public DataCurve(ConfigParameters config)

Creates an instance from the specified config parameters.

Key & Default Value	Type	Mandatory	Description
title = empty string	String	no	Curve title.
x	double[]	yes	x-coordinates of the curve points.
y	double[]	yes	y-coordinates of the curve points.

Method Detail

getContainer

public DataContainer getContainer()

Returns the DataPlot containing this curve.

Specified by:

getContainer in interface DataElement

Returns:

null if this element is not an element of a container.

setContainer

public void setContainer(DataContainer container)

Sets the DataPlot where this is a curve of.

Specified by:

setContainer in interface DataElement

Parameters:

container - Container which should contains this element. Cann be null if this element does not belong to a container.

getTitle

public String getTitle()

Returns the title of this curve.

isValid

protected boolean isValid(DataElement element)

Returns true if element is an instance of DataPoint.

Specified by:

isValid in class DataContainer

Parameters:

element - DataElement to be checked.