jcckit.data
Class DataCurve

java.lang.Object
  extended byjcckit.data.DataContainer
      extended byjcckit.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
static java.lang.String TITLE_KEY
          Config parameter key.
static java.lang.String X_KEY
          Config parameter key.
static java.lang.String Y_KEY
          Config parameter key.
 
Constructor Summary
DataCurve(ConfigParameters config)
          Creates an instance from the specified config parameters.
DataCurve(java.lang.String title)
          Creates an empty instance with the specified title.
 
Method Summary
 DataContainer getContainer()
          Returns the DataPlot containing this curve.
 java.lang.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 java.lang.String X_KEY
Config parameter key.

See Also:
Constant Field Values

Y_KEY

public static final java.lang.String Y_KEY
Config parameter key.

See Also:
Constant Field Values

TITLE_KEY

public static final java.lang.String TITLE_KEY
Config parameter key.

See Also:
Constant Field Values
Constructor Detail

DataCurve

public DataCurve(java.lang.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 ValueTypeMandatory Description
title = empty string Stringno Curve title.
xdouble[]yes x-coordinates of the curve points.
ydouble[]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 java.lang.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.