Package docking.widgets.table.constraint

Class BooleanMatchColumnConstraint

  • All Implemented Interfaces:
    ColumnConstraint<java.lang.Boolean>, java.lang.Comparable<ColumnConstraint<java.lang.Boolean>>
    public class BooleanMatchColumnConstraint
extends java.lang.Object
implements ColumnConstraint<java.lang.Boolean>
    Column Constraint for boolean values where the column values must match the constraint value of either true of false.

    • Constructor Summary

      Constructors 
      Constructor Description
      BooleanMatchColumnConstraint​(java.lang.Boolean matchValue)
      Construct a new BooleanMatchColumnConstraint that matches the given boolean value.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean accepts​(java.lang.Boolean value, TableFilterContext context)
      Compares value against the current constraint value to determine acceptance; true if value satisfies the constraints' value, false otherwise
      boolean equals​(java.lang.Object obj)  
      java.lang.Class<java.lang.Boolean> getColumnType()
      Returns the column type that this constraint can be used to filter.
      java.lang.String getConstraintValueString()
      Returns the "value" of the constraint in string form
      ColumnConstraintEditor<java.lang.Boolean> getEditor​(ColumnData<java.lang.Boolean> 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
      java.lang.Boolean getValue()
      Returns the constraints boolean value for matching.
      ColumnConstraint<java.lang.Boolean> 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, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • BooleanMatchColumnConstraint

        public BooleanMatchColumnConstraint​(java.lang.Boolean matchValue)
        Construct a new BooleanMatchColumnConstraint that matches the given boolean value.
        Parameters:
        matchValue - the value (true or false) that acceptable column values have.

    • 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<java.lang.Boolean>
        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<java.lang.Boolean>
        Returns:
        the name of the constraint.

      • accepts

        public boolean accepts​(java.lang.Boolean value,
                       TableFilterContext context)
        Description copied from interface: ColumnConstraint
        Compares value against the current constraint value to determine acceptance; true if value satisfies the constraints' value, false otherwise
        Specified by:
        accepts in interface ColumnConstraint<java.lang.Boolean>
        Parameters:
        value - the column value to be tested.
        context - provides additional information about the the table and its data. This allows the filter to base its decision on information other than just the column value.
        Returns:
        true if the column value passes the constraint, false otherwise

      • getEditor

        public ColumnConstraintEditor<java.lang.Boolean> getEditor​(ColumnData<java.lang.Boolean> 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<java.lang.Boolean>
        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.

      • getColumnType

        public java.lang.Class<java.lang.Boolean> getColumnType()
        Description copied from interface: ColumnConstraint
        Returns the column type that this constraint can be used to filter.
        Specified by:
        getColumnType in interface ColumnConstraint<java.lang.Boolean>
        Returns:
        the column type

      • getValue

        public java.lang.Boolean getValue()
        Returns the constraints boolean value for matching.
        Returns:
        the constraints boolean value for matching.

      • 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<java.lang.Boolean>
        Returns:
        the "value" of the constraint in string form.

      • parseConstraintValue

        public ColumnConstraint<java.lang.Boolean> 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<java.lang.Boolean>
        Parameters:
        newValue - the value of the constraint in string form.
        dataSource - the DataSource from the Table.
        Returns:
        a new ColumnConstraint

      • equals

        public boolean equals​(java.lang.Object obj)
        Overrides:
        equals in class java.lang.Object