eu.fthevenet.binjr.data.workspace

Class Source

java.lang.Object

eu.fthevenet.binjr.data.workspace.Source

All Implemented Interfaces:

Dirtyable, java.io.Closeable, java.lang.AutoCloseable

public class Source
extends java.lang.Object
implements Dirtyable, java.io.Closeable

A class that represents and holds the current state of a single data source

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<java.lang.Boolean>	editable
javafx.beans.property.Property<java.lang.String>	name

Constructor Summary

Constructors

Constructor and Description
Source() Initializes a new instance of the Source class

Method Summary

Modifier and Type	Method and Description
void	cleanUp() Clear the dirty status of the Dirtyable instance
void	close()
javafx.beans.property.BooleanProperty	dirtyProperty() A BooleanProperty that observes the changes made to the Dirtyable instance
javafx.beans.property.Property<java.lang.Boolean>	editableProperty()
DataAdapter	getAdapter()
java.lang.String	getAdapterClassName() The name of the class that implements the DataAdapter for the Source
java.util.UUID	getAdapterId() Gets the id of the DataAdapter attached to the source
java.util.Map<java.lang.String,java.lang.String>	getAdapterParams() Returns a map of the parameters required to establish a connection to the data source
BindingManager	getBindingManager()
java.lang.Boolean	getEditable() Gets the value of the property editable.
java.lang.String	getName() The name of the Source
java.lang.Boolean	isDirty() Gets the value of the property dirty.
javafx.beans.property.Property<java.lang.String>	nameProperty()
static Source	of(DataAdapter adapter) Creates an instance of the Source class from the provided DataAdapter
void	setAdapter(DataAdapter adapter)
void	setAdapterId(java.util.UUID adapterId) Sets the id of the DataAdapter attached to the source
void	setEditable(java.lang.Boolean editable) Sets the value of the property editable.
void	setName(java.lang.String name) The name of the Source

Methods inherited from class java.lang.Object

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

Property Detail

name

public javafx.beans.property.Property<java.lang.String> nameProperty

See Also:

getName(), setName(String)

dirty

public javafx.beans.property.BooleanProperty dirtyProperty

Specified by:

dirtyProperty in interface Dirtyable

See Also:

isDirty()

editable

public javafx.beans.property.Property<java.lang.Boolean> editableProperty

See Also:

getEditable(), setEditable(Boolean)

Constructor Detail

Source

public Source()

Initializes a new instance of the Source class

Method Detail

of

public static Source of(DataAdapter adapter)

Creates an instance of the Source class from the provided DataAdapter

Parameters:

adapter - the DataAdapter to create the Source instance from

Returns:

an instance of the Source class from the provided DataAdapter

getName

public java.lang.String getName()

The name of the Source

Returns:

the name of the Source

setName

public void setName(java.lang.String name)

The name of the Source

Parameters:

name - the name of the Source

nameProperty

public javafx.beans.property.Property<java.lang.String> nameProperty()

See Also:

getName(), setName(String)

getAdapterClassName

public java.lang.String getAdapterClassName()

The name of the class that implements the DataAdapter for the Source

Returns:

the name of the class that implements the DataAdapter for the Source

getAdapterParams

public java.util.Map<java.lang.String,java.lang.String> getAdapterParams()

Returns a map of the parameters required to establish a connection to the data source

Returns:

a map of the parameters required to establish a connection to the data source

getAdapterId

public java.util.UUID getAdapterId()

Gets the id of the DataAdapter attached to the source

Returns:

the id of the DataAdapter attached to the source

setAdapterId

public void setAdapterId(java.util.UUID adapterId)

Sets the id of the DataAdapter attached to the source

Parameters:

adapterId - the id of the DataAdapter attached to the source

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

getAdapter

public DataAdapter getAdapter()

getBindingManager

public BindingManager getBindingManager()

close

public void close()

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

setAdapter

public void setAdapter(DataAdapter adapter)

getEditable

public java.lang.Boolean getEditable()

Gets the value of the property editable.

editableProperty

public javafx.beans.property.Property<java.lang.Boolean> editableProperty()

See Also:

getEditable(), setEditable(Boolean)

setEditable

public void setEditable(java.lang.Boolean editable)

Sets the value of the property editable.