org.datacleaner.widgets.properties

Class MinimalPropertyWidget<E>

java.lang.Object

org.datacleaner.widgets.properties.MinimalPropertyWidget<E>

Type Parameters:

E -

All Implemented Interfaces:

PropertyWidget<E>

Direct Known Subclasses:

AbstractPropertyWidget

public abstract class MinimalPropertyWidget<E>
extends Object
implements PropertyWidget<E>

Minimalistic abstract implementation of the PropertyWidget interface.

Constructor Summary

Constructors

Constructor and Description
MinimalPropertyWidget(org.datacleaner.job.builder.ComponentBuilder componentBuilder, ConfiguredPropertyDescriptor propertyDescriptor)

Method Summary

Modifier and Type	Method and Description
void	fireValueChanged()
protected void	fireValueChanged(Object newValue)
protected ActionListener	fireValueChangedActionListener()
protected void	fireValuesChanged(Map<ConfiguredPropertyDescriptor,Object> properties)
protected org.datacleaner.job.builder.AnalysisJobBuilder	getAnalysisJobBuilder()
org.datacleaner.job.builder.ComponentBuilder	getComponentBuilder()
protected E	getCurrentValue() Gets the current value of the property in the job builder.
ConfiguredPropertyDescriptor	getPropertyDescriptor() Gets the ConfiguredPropertyDescriptor that this PropertyWidget is modelling.
void	initialize(E value) Initializes the property widget with the initial value of the property
boolean	isSet() Determines if the property is set given the current state in the UI.
protected boolean	isUpdating() Determines whether a property widget is currently updating/setting it's property value.
void	onValueTouched(E value) Called on a widget if the value it contains is prone to have been changed by a another party (typically some sort of shortcut in the UI to populate values or similar).
protected void	setUpdating(boolean updating) Provides a method for setting the "updating" flag (see isUpdating()).
protected abstract void	setValue(E value)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.datacleaner.widgets.properties.PropertyWidget

getValue, getWidget

Constructor Detail

MinimalPropertyWidget

public MinimalPropertyWidget(org.datacleaner.job.builder.ComponentBuilder componentBuilder,
                             ConfiguredPropertyDescriptor propertyDescriptor)

Method Detail

initialize

public void initialize(E value)

Description copied from interface: PropertyWidget

Initializes the property widget with the initial value of the property

Specified by:

initialize in interface PropertyWidget<E>

getPropertyDescriptor

public final ConfiguredPropertyDescriptor getPropertyDescriptor()

Description copied from interface: PropertyWidget

Gets the ConfiguredPropertyDescriptor that this PropertyWidget is modelling.

Specified by:

getPropertyDescriptor in interface PropertyWidget<E>

Returns:

getComponentBuilder

public final org.datacleaner.job.builder.ComponentBuilder getComponentBuilder()

isSet

public boolean isSet()

Description copied from interface: PropertyWidget

Determines if the property is set given the current state in the UI.

Specified by:

isSet in interface PropertyWidget<E>

Returns:

fireValueChanged

public final void fireValueChanged()

fireValueChangedActionListener

protected ActionListener fireValueChangedActionListener()

getAnalysisJobBuilder

protected final org.datacleaner.job.builder.AnalysisJobBuilder getAnalysisJobBuilder()

onValueTouched

public void onValueTouched(E value)

Description copied from interface: PropertyWidget

Called on a widget if the value it contains is prone to have been changed by a another party (typically some sort of shortcut in the UI to populate values or similar). Note that this method will sometimes also be invoked at when the surrounding environment is not able to determine if it has changed or not. The property widget should therefore investigate if the incoming value does in deed differ from the existing.

Specified by:

onValueTouched in interface PropertyWidget<E>

isUpdating

protected boolean isUpdating()

Determines whether a property widget is currently updating/setting it's property value. When true, this property will not treat incoming notifications, since they will be triggered by itself.

Returns:

setUpdating

protected void setUpdating(boolean updating)

Provides a method for setting the "updating" flag (see isUpdating()).

Parameters:

updating -

getCurrentValue

protected E getCurrentValue()

Gets the current value of the property in the job builder.

Returns:

setValue

protected abstract void setValue(E value)

fireValueChanged

protected final void fireValueChanged(Object newValue)

fireValuesChanged

protected final void fireValuesChanged(Map<ConfiguredPropertyDescriptor,Object> properties)