Package docking.widgets.table.constraint

Class SingleValueColumnConstraint<T>

java.lang.Object

docking.widgets.table.constraint.SingleValueColumnConstraint<T>

Type Parameters:

T - the column type

All Implemented Interfaces:

ColumnConstraint<T>, java.lang.Comparable<ColumnConstraint<T>>

Direct Known Subclasses:

AtLeastColumnConstraint, AtLeastDateColumnConstraint, AtMostColumnConstraint, AtMostDateColumnConstraint

public abstract class SingleValueColumnConstraint<T>
extends java.lang.Object
implements ColumnConstraint<T>

Abstract base class for single value constraints such as "At Most" or "At Least"

Field Summary

Fields

Modifier and Type	Field	Description
protected EditorProvider<T>	editorProvider
protected java.lang.String	name	This constraints' name

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SingleValueColumnConstraint(java.lang.String name, T constraintValue, EditorProvider<T> editorProvider, java.lang.String group)	Constructor

Method Summary

Modifier and Type	Method	Description
abstract SingleValueColumnConstraint<T>	copy(T newValue)	subclasses must override to generate new versions of themselves but with new comparison value.
boolean	equals(java.lang.Object o)
java.lang.Class<T>	getColumnType()	Returns the column type that this constraint can be used to filter.
T	getConstraintValue()	Returns the constraint value
java.lang.String	getConstraintValueString()	Returns the "value" of the constraint in string form
ColumnConstraintEditor<T>	getEditor(ColumnData<T> columnDataSource)	Returns a ColumnConstraintEditor which will provide gui components for users to edit the constraint values.
java.lang.String	getGroup()	Returns a "group" string that is used to logically group column constraints for presentation to the user
java.lang.String	getName()	Returns the name of the constraint
int	hashCode()
ColumnConstraint<T>	parseConstraintValue(java.lang.String newValue, java.lang.Object dataSource)	Parses the constraint value string for deserialization purposes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface docking.widgets.table.constraint.ColumnConstraint

accepts, asString, compareTo, getConstraintValueTooltip

Field Detail

name

protected final java.lang.String name

This constraints' name

It sometimes makes grammatical sense to set a more useful name than the default; while 'at least' makes sense for a number-based constraint, 'after' reads better for date-based constraints.

editorProvider

protected EditorProvider<T> editorProvider

Constructor Detail

SingleValueColumnConstraint

protected SingleValueColumnConstraint(java.lang.String name,
                                      T constraintValue,
                                      EditorProvider<T> editorProvider,
                                      java.lang.String group)

Constructor

Parameters:

name - the name of the constraint.

constraintValue - the value of this constraint to be compared with column values.

editorProvider - the editor provider that generates the appropriate editors for constraints of this type.

group - the group of the constraint for visual grouping when presenting to the user.

Method Detail

getGroup

public java.lang.String getGroup()

Description copied from interface: ColumnConstraint

Returns a "group" string that is used to logically group column constraints for presentation to the user

Specified by:

getGroup in interface ColumnConstraint<T>

Returns:

the group this constraint belongs to.

getName

public java.lang.String getName()

Description copied from interface: ColumnConstraint

Returns the name of the constraint

Specified by:

getName in interface ColumnConstraint<T>

Returns:

the name of the constraint.

getConstraintValue

public final T getConstraintValue()

Returns the constraint value

Returns:

the constraint value

copy

public abstract SingleValueColumnConstraint<T> copy(T newValue)

subclasses must override to generate new versions of themselves but with new comparison value.

Parameters:

newValue - the new value to compare column values against.

Returns:

a new ColumnConstraint that is the same type as this constraint but with a new comparison value.

getEditor

public ColumnConstraintEditor<T> getEditor(ColumnData<T> columnDataSource)

Description copied from interface: ColumnConstraint

Returns a ColumnConstraintEditor which will provide gui components for users to edit the constraint values.

Specified by:

getEditor in interface ColumnConstraint<T>

Parameters:

columnDataSource - This provides the constraint with access to the column data in the table model as well as the DataProvider of the table (if it has one)

Returns:

A columnConstraintEditor for editing the constraints value.

getConstraintValueString

public java.lang.String getConstraintValueString()

Description copied from interface: ColumnConstraint

Returns the "value" of the constraint in string form

This is used for serializing the constraint.

Specified by:

getConstraintValueString in interface ColumnConstraint<T>

Returns:

the "value" of the constraint in string form.

parseConstraintValue

public ColumnConstraint<T> parseConstraintValue(java.lang.String newValue,
                                                java.lang.Object dataSource)

Description copied from interface: ColumnConstraint

Parses the constraint value string for deserialization purposes.

Specified by:

parseConstraintValue in interface ColumnConstraint<T>

Parameters:

newValue - the value of the constraint in string form.

dataSource - the DataSource from the Table.

Returns:

a new ColumnConstraint

getColumnType

public java.lang.Class<T> getColumnType()

Description copied from interface: ColumnConstraint

Returns the column type that this constraint can be used to filter.

Specified by:

getColumnType in interface ColumnConstraint<T>

Returns:

the column type

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object