eu.fthevenet.binjr.data.workspace

Class TimeSeriesInfo<T>

java.lang.Object

eu.fthevenet.binjr.data.workspace.TimeSeriesInfo<T>

All Implemented Interfaces:

Dirtyable

public class TimeSeriesInfo<T>
extends java.lang.Object
implements Dirtyable

A class that represents and holds the current state of the representation of a single time series

Author:

Frederic Thevenet

Property Summary

Type	Property and Description
javafx.beans.property.BooleanProperty	dirty A BooleanProperty that observes the changes made to the Dirtyable instance
javafx.beans.property.Property<javafx.scene.paint.Color>	displayColor The displayColor property
javafx.beans.property.StringProperty	displayName The displayName property
javafx.beans.property.Property<TimeSeriesProcessor<T>>	processor The processor property.
javafx.beans.property.BooleanProperty	selected The selected property

Constructor Summary

Constructors

Constructor and Description
TimeSeriesInfo(TimeSeriesInfo<T> seriesInfo) Copy constructor to deep clone a TimeSeriesInfo instance.

Method Summary

Modifier and Type	Method and Description
void	cleanUp() Clear the dirty status of the Dirtyable instance
javafx.beans.property.BooleanProperty	dirtyProperty() A BooleanProperty that observes the changes made to the Dirtyable instance
javafx.beans.property.Property<javafx.scene.paint.Color>	displayColorProperty() The displayColor property
javafx.beans.property.StringProperty	displayNameProperty() The displayName property
static <T> TimeSeriesInfo<T>	fromBinding(TimeSeriesBinding<T> binding) Returns a new instance of the TimeSeriesInfo class built from the specified TimeSeriesBinding
TimeSeriesBinding<T>	getBinding() Gets the TimeSeriesBinding to get the data from
javafx.scene.paint.Color	getDisplayColor() Returns the display color for the series
java.lang.String	getDisplayName() Gets the display name fo the series
TimeSeriesProcessor<T>	getProcessor() Gets the data processor for the series
java.lang.Boolean	isDirty() Gets the value of the property dirty.
boolean	isSelected() Returns true if the series is selected, false otherwise
javafx.beans.property.Property<TimeSeriesProcessor<T>>	processorProperty() The processor property.
javafx.beans.property.BooleanProperty	selectedProperty() The selected property
void	setDisplayColor(javafx.scene.paint.Color displayColor) Sets the display color for the series
void	setDisplayName(java.lang.String displayName) Sets the display name fo the series
void	setProcessor(TimeSeriesProcessor<T> processor) Sets the data processor for the series
void	setSelected(boolean selected) Set to true if the series is selected, false otherwise

Methods inherited from class java.lang.Object

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

Property Detail

displayName

public javafx.beans.property.StringProperty displayNameProperty

The displayName property

See Also:

getDisplayName(), setDisplayName(String)

selected

public javafx.beans.property.BooleanProperty selectedProperty

The selected property

See Also:

isSelected(), setSelected(boolean)

displayColor

public javafx.beans.property.Property<javafx.scene.paint.Color> displayColorProperty

The displayColor property

See Also:

getDisplayColor(), setDisplayColor(Color)

processor

public javafx.beans.property.Property<TimeSeriesProcessor<T>> processorProperty

The processor property.

See Also:

getProcessor(), setProcessor(TimeSeriesProcessor)

dirty

public javafx.beans.property.BooleanProperty dirtyProperty

Specified by:

dirtyProperty in interface Dirtyable

See Also:

isDirty()

Constructor Detail

TimeSeriesInfo

public TimeSeriesInfo(TimeSeriesInfo<T> seriesInfo)

Copy constructor to deep clone a TimeSeriesInfo instance.

Remark:

All the properties of the new TimeSeriesInfo instance are new objects, assigned the same values, except for the binding property which holds a copy of the reference.
In other words, the TimeSeriesBinding reference is shared amongst all clones produced by this constructor.

Parameters:

seriesInfo - the TimeSeriesInfo instance to clone.

Method Detail

fromBinding

public static <T> TimeSeriesInfo<T> fromBinding(TimeSeriesBinding<T> binding)

Returns a new instance of the TimeSeriesInfo class built from the specified TimeSeriesBinding

Type Parameters:

T - the type of Y data for that series

Parameters:

binding - the TimeSeriesBinding to build the TimeSeriesInfo from

Returns:

a new instance of the TimeSeriesInfo class built from the specified TimeSeriesBinding

getDisplayName

public java.lang.String getDisplayName()

Gets the display name fo the series

Returns:

the display name fo the series

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name fo the series

Parameters:

displayName - the display name fo the series

displayNameProperty

public javafx.beans.property.StringProperty displayNameProperty()

The displayName property

See Also:

getDisplayName(), setDisplayName(String)

isSelected

public boolean isSelected()

Returns true if the series is selected, false otherwise

Returns:

true if the series is selected, false otherwise

setSelected

public void setSelected(boolean selected)

Set to true if the series is selected, false otherwise

Parameters:

selected - true if the series is selected, false otherwise

selectedProperty

public javafx.beans.property.BooleanProperty selectedProperty()

The selected property

See Also:

isSelected(), setSelected(boolean)

getDisplayColor

public javafx.scene.paint.Color getDisplayColor()

Returns the display color for the series

Returns:

the display color for the series

setDisplayColor

public void setDisplayColor(javafx.scene.paint.Color displayColor)

Sets the display color for the series

Parameters:

displayColor - the display color for the series

displayColorProperty

public javafx.beans.property.Property<javafx.scene.paint.Color> displayColorProperty()

The displayColor property

See Also:

getDisplayColor(), setDisplayColor(Color)

getBinding

public TimeSeriesBinding<T> getBinding()

Gets the TimeSeriesBinding to get the data from

Returns:

the TimeSeriesBinding to get the data from

getProcessor

public TimeSeriesProcessor<T> getProcessor()

Gets the data processor for the series

Returns:

the data processor for the series

setProcessor

public void setProcessor(TimeSeriesProcessor<T> processor)

Sets the data processor for the series

Parameters:

processor - the data processor for the series

processorProperty

public javafx.beans.property.Property<TimeSeriesProcessor<T>> processorProperty()

The processor property.

See Also:

getProcessor(), setProcessor(TimeSeriesProcessor)

isDirty

public java.lang.Boolean isDirty()

Gets the value of the property dirty.

Specified by:

isDirty in interface Dirtyable

Returns:

true if the Dirtyable instance needs to be persisted, false otherwise

dirtyProperty

public javafx.beans.property.BooleanProperty dirtyProperty()

Description copied from interface: Dirtyable

A BooleanProperty that observes the changes made to the Dirtyable instance

Specified by:

dirtyProperty in interface Dirtyable

See Also:

isDirty()

cleanUp

public void cleanUp()

Description copied from interface: Dirtyable

Clear the dirty status of the Dirtyable instance

Specified by:

cleanUp in interface Dirtyable