Annotation Interface Component.FilterCriteria

Enclosing class:
Component

@Target(TYPE) @Retention(RUNTIME) @Documented public static @interface Component.FilterCriteria
Annotation that simplifies the definition of filter criteria for input components. Instead of repeating the full Component.ConfigurableAttribute annotation with all values, this annotation allows specifying only the criteria to activate using SqlOperator values.

Example usage:

 @Component.FilterCriteria({
     SqlOperator.IS_NOT_EQUAL_TO,
     SqlOperator.IS_NULL,
     SqlOperator.IS_NOT_NULL,
     SqlOperator.IS_LIKE
 })
 public class Input extends Control {
     // ...
 }
 

This is equivalent to:

 @Component.ConfigurableAttribute(
     name = Input.FILTER_CRITERION_ATTRIBUTE,
     label = "Filter criteria",
     type = StringDataType.NAME,
     values = {
         @Component.ConfigurableAttribute.Value(value = "", label = "Default"),
         @Component.ConfigurableAttribute.Value(value = "ne", label = "Not Equal"),
         @Component.ConfigurableAttribute.Value(value = "isnull", label = "Is Null"),
         @Component.ConfigurableAttribute.Value(value = "isnotnull", label = "Is Not Null"),
         @Component.ConfigurableAttribute.Value(value = "like", label = "Like")
     },
     properties = {
         @Component.ConfigurableAttribute.Property(key = "type", value = "string"),
         @Component.ConfigurableAttribute.Property(key = "fullsize", value = "true")
     }
 )
 
See Also:
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    The filter criteria to activate for this component.
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    Whether this annotation overrides the parent's filter criteria configuration.
  • Element Details

    • value

      SqlOperator[] value
      The filter criteria to activate for this component. The DEFAULT criterion is always included automatically.
      Returns:
      array of SqlOperator filter criteria to activate
    • overrideParent

      boolean overrideParent
      Whether this annotation overrides the parent's filter criteria configuration. Default is false.
      Returns:
      true if this should override parent configuration
      Default:
      true