org.drombler.commons.data

Interface DataHandler<K>

Type Parameters:

K - the type of the unique key of this data handler

All Superinterfaces:

AutoCloseable, Bean, org.drombler.commons.context.LocalContextProvider, UniqueKeyProvider<K>

public interface DataHandler<K>
extends org.drombler.commons.context.LocalContextProvider, UniqueKeyProvider<K>, Bean, AutoCloseable

A data handler. A data handler usually knows how to read, save etc. a particular kind of data. To fully integrate with the framework it should observe registered DataCapabilityProviders and add the found data capabilities to it's local context.

Author:

puce

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRTY_PROPERTY_NAME The name of the 'dirty' property.
static String	INITIALIZED_PROPERTY_NAME The name of the 'initialized' property.
static String	TITLE_PROPERTY_NAME The name of the 'title' property.
static String	TOOLTIP_TEXT_PROPERTY_NAME The name of the 'tooltipText' property.
static String	UNIQUE_KEY_PROPERTY_NAME The name of the 'uniqueKey' property.

Method Summary

Modifier and Type	Method and Description
void	addCloseEventListener(CloseEventListener listener) Registers a listener, which gets notified when this DataHandler gets closed.
String	getTitle() Gets the title of this data handler.
String	getTooltipText() Gets the tooltip text.
boolean	isDirty() A flag if the content of this data handler is dirty. If the content is marked as dirty it should be reloaded from its source when it's accessed the next time. This is a bound property.
boolean	isInitialized() A flag if this data handler is initialized. This is a bound property.
void	markDirty() Marks the content of this data handler as dirty. If the content has been modified but the user discarded the changes, the data handler should be marked as dirty to indicate that the content needs to be reloaded from its source when it's accessed the next time.
void	removeCloseEventListener(CloseEventListener listener) Unregisters a listener, which gets notified when this DataHandler gets closed.

Methods inherited from interface org.drombler.commons.context.LocalContextProvider

getLocalContext

Methods inherited from interface org.softsmithy.lib.util.UniqueKeyProvider

getUniqueKey

Methods inherited from interface org.softsmithy.lib.beans.Bean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

UNIQUE_KEY_PROPERTY_NAME

static final String UNIQUE_KEY_PROPERTY_NAME

The name of the 'uniqueKey' property.

See Also:

UniqueKeyProvider.getUniqueKey(), Constant Field Values

TITLE_PROPERTY_NAME

static final String TITLE_PROPERTY_NAME

The name of the 'title' property.

See Also:

getTitle(), Constant Field Values

TOOLTIP_TEXT_PROPERTY_NAME

static final String TOOLTIP_TEXT_PROPERTY_NAME

The name of the 'tooltipText' property.

See Also:

getTooltipText(), Constant Field Values

DIRTY_PROPERTY_NAME

static final String DIRTY_PROPERTY_NAME

The name of the 'dirty' property.

See Also:

isDirty(), Constant Field Values

INITIALIZED_PROPERTY_NAME

static final String INITIALIZED_PROPERTY_NAME

The name of the 'initialized' property.

See Also:

isInitialized(), Constant Field Values

Method Detail

getTitle

String getTitle()

Gets the title of this data handler. It's intended to be used e.g. in tabs and cells.

This is a bound property.

Returns:

the title of this data handler

See Also:

TITLE_PROPERTY_NAME

getTooltipText

String getTooltipText()

Gets the tooltip text. This text is intended to be used in tooltips.

This is a bound property.

Returns:

the tooltip text

See Also:

TOOLTIP_TEXT_PROPERTY_NAME

markDirty

void markDirty()

Marks the content of this data handler as dirty.

If the content has been modified but the user discarded the changes, the data handler should be marked as dirty to indicate that the content needs to be reloaded from its source when it's accessed the next time.

See Also:

isDirty()

isDirty

boolean isDirty()

A flag if the content of this data handler is dirty.

If the content is marked as dirty it should be reloaded from its source when it's accessed the next time.

This is a bound property.

Returns:

true, if the content is marked as dirty, else false

See Also:

DIRTY_PROPERTY_NAME

isInitialized

boolean isInitialized()

A flag if this data handler is initialized.

This is a bound property.

Returns:

true, if the data handler is initialized, else false

See Also:

INITIALIZED_PROPERTY_NAME

addCloseEventListener

void addCloseEventListener(CloseEventListener listener)

Registers a listener, which gets notified when this DataHandler gets closed.

Parameters:

listener - the listener to add

removeCloseEventListener

void removeCloseEventListener(CloseEventListener listener)

Unregisters a listener, which gets notified when this DataHandler gets closed.

Parameters:

listener - the listener to remove