XTableView / Filter Match Rules

• Default MatchRule

  In the screenshot below we've preselected the EQUAL match rule of the birthday filter by calling FilterModel#setMatchRule(ComparisonType.EQUAL).

  All screenshots were taken from XTableCustomMatchRuleDemo which can be downloaded from the link below.

  XTableColumn dateCol = new XTableColumn<>("Birthday");
  ...
  // regular date filter
  dateCol.setColumnFilter(new DateColumnFilter<>());
  // set match rule EQUAL as default
  dateCol.getColumnFilter().getFilterModel().setMatchRule(ComparisonType.EQUAL);
  ...
  

  

• Custom MatchRule

  Generally there are two types of match rules - fixed and variable. Fixed means the match value is already integrated in the match rule. Variable means the match value will be defined by the end user. In example if you want to make a rule which lists all persons with birthday on sunday, there's no need for any user input - a match value is not required. In this case the last parameter of the SimplePredicateProvider constructor has to be set to true.

  XTableColumn dateCol = new XTableColumn<>("Birthday");
  ...
  PredicateProvider bornOnSunday = new SimplePredicateProvider<>((value, matchValue) -> value != null ? value.getDayOfWeek() == DayOfWeek.SUNDAY : false, "born on sunday", true);
  dateCol.setColumnFilter(new DateColumnFilter(new ComparableFilterModel(FXCollections.observableArrayList(ComparisonType.BEFORE, ComparisonType.AFTER, bornOnSunday))));
  ...
  

  Note: The resulting table content of the match rule can vary because the birthday data will be randomly created on application startup.
  

  Fixed Match Rule

  In the example below we define a fixed match rule as a class member variable to list people with the age over 50. The rule will be added to the default rules which are defined in the ComparisonType class.

  private PredicateProvider over50 = new SimplePredicateProvider<>((value, matchValue) -> value != null ? value.intValue() > 50 : false, "over 50", true);
  ...
  XTableColumn ageCol = new XTableColumn<>("Age");
  ...
  ObservableList rules = FXCollections.observableArrayList(ComparisonType.values());
  rules.addAll(under20, over50);
  ageCol.setColumnFilter(new ComparableColumnFilter(new ComparableFilterModel(rules), TextFormatterFactory.INTEGER_TEXTFORMATTER_FACTORY));
  

  Note: The resulting table content of the match rule can vary because the birthday data will be randomly created on application startup.
  

  Variable Match Rule

  In the example below a variable match rule will be defined to list all persons with a birthday plus/minus 10 years from the given date. The passed match value inserted by the end user will be processed in the match rule.

  XTableColumn dateCol = new XTableColumn<>("Birthday");
  table.getColumns().addAll(dateCol);
  ...
  // date filter with custom match rules
  PredicateProvider bornOnSunday = new SimplePredicateProvider<>((value, matchValue) -> value != null ? value.getDayOfWeek() == DayOfWeek.SUNDAY : false, "born on sunday", true);
  dateCol.setColumnFilter(new DateColumnFilter(new ComparableFilterModel(FXCollections.observableArrayList(ComparisonType.BEFORE, ComparisonType.AFTER, bornOnSunday))));
  PredicateProvider daysAroundRule = createDaysAroundRule(10);
  dateCol.getColumnFilter().getFilterModel().getMatchRules().add(daysAroundRule);
  ...
  private PredicateProvider createDaysAroundRule(int yearsAround)
    return new SimplePredicateProvider<>((value, matchValue) -> {
      LocalDate lower = matchValue.minusYears(yearsAround);
      LocalDate upper = matchValue.plusYears(yearsAround);
      return RangeType.ALL_INCLUSIVE.asBiPredicate().test(value, new Boundaries<>(lower, upper));
      }, "+/- " + yearsAround + " years");
  }    
  

  Note: The resulting table content of the match rule can vary because the birthday data will be randomly created on application startup.
  

See also