FilterPredicate (DataFrame 0.6.1 API)

java.lang.Object
- de.unknownreality.dataframe.filter.FilterPredicate

Direct Known Subclasses:

ComparePredicate, MatchPredicate
```
public abstract class FilterPredicate
extends Object
```
Created by Alex on 09.03.2016.

Field Summary

Fields
Modifier and Type Field and Description

static FilterPredicate EMPTY_FILTER

Fields
Modifier and Type	Field and Description
`static FilterPredicate`	`EMPTY_FILTER`

Constructor Summary

Constructors
Constructor and Description

FilterPredicate()

Constructors
Constructor and Description
`FilterPredicate()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static FilterPredicate`	`and(FilterPredicate... predicates)` Returns `true` if all input predicates return `true`.
`FilterPredicate`	`and(FilterPredicate p)` Creates a new `AND` predicate using this predicate and an input predicate
`static FilterPredicate`	`and(FilterPredicate p1, FilterPredicate p2)` Returns `true` if both input predicates return `true`.
`static FilterPredicate`	`btwn(String name, Object low, Object high)` Returns a predicate that checks whether the row column value is between two comparison values.
`static FilterPredicate`	`compile(String predicateString)`
`static FilterPredicate`	`empty()` Creates an `empty` predicate.
`static FilterPredicate`	`eq(FilterPredicate p1, FilterPredicate p2)` Compares two predicates and returns `true` if the results are equal `return p1.valid(row) == p2.valid(row)`
`static FilterPredicate`	`eq(String name, Object value)` Creates a `ComparePredicate` using `equals operation`
`static FilterPredicate`	`eqColumn(String nameA, String nameB)` Creates a `ColumnComparePredicate` using `equals operation`
`static FilterPredicate`	`ge(String name, Object value)` Creates a `ComparePredicate` using `greater or equal operation`
`static FilterPredicate`	`geColumn(String nameA, String nameB)` Creates a `ColumnComparePredicate` using `greater or equal operation`
`static FilterPredicate`	`gt(String name, Object value)` Creates a `ComparePredicate` using `greater than operation`
`static FilterPredicate`	`gtColumn(String nameA, String nameB)` Creates a `ColumnComparePredicate` using `greater than operation`
`static FilterPredicate`	`in(String name, Collection<Object> values)` Returns a predicate that checks whether the row column value is contained in a collection of comparison values.
`static FilterPredicate`	`in(String name, Object[] values)` Returns a predicate that checks whether the row column value is contained in an array of comparison values.
`static FilterPredicate`	`in(String name, Set<Object> values)` Returns a predicate that checks whether the row column value is contained in a set of comparison values.
`static FilterPredicate`	`le(String name, Object value)` Creates a `ComparePredicate` using `lower or equal operation`
`static FilterPredicate`	`leColumn(String nameA, String nameB)` Creates a `ColumnComparePredicate` using `lower or equal operation`
`static FilterPredicate`	`lt(String name, Object value)` Creates a `ComparePredicate` using `lower than operation`
`static FilterPredicate`	`ltColumn(String nameA, String nameB)` Creates a `ColumnComparePredicate` using `lower than operation`
`static FilterPredicate`	`matches(String name, Pattern pattern)` Returns a `MatchPredicate` that checks whether the row column value matches a specified `Pattern`.
`static FilterPredicate`	`matches(String name, String patternString)` Returns a `MatchPredicate` that checks whether the row column value matches a specified pattern string.
`static FilterPredicate`	`ne(FilterPredicate p1, FilterPredicate p2)` Compares two predicates and returns `true` if the results are not equal `return p1.valid(row) !`
`static FilterPredicate`	`ne(String name, Object value)` Creates a `ComparePredicate` using `not equals operation`
`static FilterPredicate`	`neColumn(String nameA, String nameB)` Creates a `ColumnComparePredicate` using `not equals operation`
`FilterPredicate`	`neg()` Negates this predicate
`FilterPredicate`	`nor(FilterPredicate p)` Creates a new `NOR` predicate using this predicate and an input predicate
`static FilterPredicate`	`nor(FilterPredicate p1, FilterPredicate p2)` Returns `true` if one input predicate returns `true` and the other predicate returns `false`.
`static FilterPredicate`	`not(FilterPredicate filterPredicate)` Returns the not predicate for a specified input predicate.
`static FilterPredicate`	`or(FilterPredicate... predicates)` Returns `true` if at least one input predicate returns `true`.
`FilterPredicate`	`or(FilterPredicate p)` Creates a new `OR` predicate using this predicate and an input predicate
`static FilterPredicate`	`or(FilterPredicate p1, FilterPredicate p2)` Returns `true` if at least one input predicate returns `true`.
`abstract String`	`toString()` Returns a string representation for this predicate
`abstract boolean`	`valid(Row row)` Returns `true` if the row is valid for this predicate
`FilterPredicate`	`xor(FilterPredicate p)` Creates a new `XOR` predicate using this predicate and an input predicate
`static FilterPredicate`	`xor(FilterPredicate p1, FilterPredicate p2)` Returns `true` if one input predicate returns `true` and the other predicate returns `false`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - EMPTY_FILTER
```
public static final FilterPredicate EMPTY_FILTER
```
- Constructor Detail
  - FilterPredicate
```
public FilterPredicate()
```
- Method Detail
  - valid
```
public abstract boolean valid(Row row)
```
    Returns true if the row is valid for this predicate
    
    Parameters:
    
    row - tested row
    
    Returns:
    
    true if the row is valid
  - toString
```
public abstract String toString()
```
    Returns a string representation for this predicate
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation
  - empty
```
public static FilterPredicate empty()
```
    Creates an empty predicate. Always returns true.
    
    Returns:
    
    empty predicate
  - and
```
public FilterPredicate and(FilterPredicate p)
```
    Creates a new AND predicate using this predicate and an input predicate
    
    Parameters:
    
    p - input predicate
    
    Returns:
    
    AND predicate
    
    See Also:
    
    and(FilterPredicate, FilterPredicate)
  - or
```
public FilterPredicate or(FilterPredicate p)
```
    Creates a new OR predicate using this predicate and an input predicate
    
    Parameters:
    
    p - input predicate
    
    Returns:
    
    OR predicate
    
    See Also:
    
    or(FilterPredicate, FilterPredicate)
  - xor
```
public FilterPredicate xor(FilterPredicate p)
```
    Creates a new XOR predicate using this predicate and an input predicate
    
    Parameters:
    
    p - input predicate
    
    Returns:
    
    XOR predicate
    
    See Also:
    
    xor(FilterPredicate, FilterPredicate)
  - nor
```
public FilterPredicate nor(FilterPredicate p)
```
    Creates a new NOR predicate using this predicate and an input predicate
    
    Parameters:
    
    p - input predicate
    
    Returns:
    
    NOR predicate
    
    See Also:
    
    xor(FilterPredicate, FilterPredicate)
  - neg
```
public FilterPredicate neg()
```
    Negates this predicate
    
    Returns:
    
    negated predicate
  - not
```
public static FilterPredicate not(FilterPredicate filterPredicate)
```
    Returns the not predicate for a specified input predicate. return !filterPredicate.valid(row)
    
    Parameters:
    
    filterPredicate - input predicate
    
    Returns:
    
    Returns the negates result of the input predicate
  - ne
```
public static FilterPredicate ne(FilterPredicate p1,
                                 FilterPredicate p2)
```
    Compares two predicates and returns true if the results are not equal return p1.valid(row) != p2.valid(row)
    
    Parameters:
    
    p1 - first input predicate
    
    p2 - second input predicate
    
    Returns:
    
    true if one input predicates returns true and the other returns false
  - eq
```
public static FilterPredicate eq(FilterPredicate p1,
                                 FilterPredicate p2)
```
    Compares two predicates and returns true if the results are equal return p1.valid(row) == p2.valid(row)
    
    Parameters:
    
    p1 - first input predicate
    
    p2 - second input predicate
    
    Returns:
    
    true if both input predicates return either true or false
  - and
```
public static FilterPredicate and(FilterPredicate... predicates)
```
    Returns true if all input predicates return true. return p1.valid(row) AND p2.valid(row) AND ... AND pn.valid(row)
    
    Parameters:
    
    predicates - input predicates
    
    Returns:
    
    true if all input predicates return true
  - or
```
public static FilterPredicate or(FilterPredicate... predicates)
```
    Returns true if at least one input predicate returns true. return p1.valid(row) OR p2.valid(row) OR ... OR pn.valid(row)
    
    Parameters:
    
    predicates - input predicates
    
    Returns:
    
    true if at least one input predicate returns true
  - and
```
public static FilterPredicate and(FilterPredicate p1,
                                  FilterPredicate p2)
```
    Returns true if both input predicates return true. return p1.valid(row) AND p2.valid(row)
    
    Parameters:
    
    p1 - first input predicate
    
    p2 - second input predicate
    
    Returns:
    
    true if both input predicates return true
  - or
```
public static FilterPredicate or(FilterPredicate p1,
                                 FilterPredicate p2)
```
    Returns true if at least one input predicate returns true. return p1.valid(row) OR p2.valid(row)
    
    Parameters:
    
    p1 - first input predicate
    
    p2 - second input predicate
    
    Returns:
    
    true if at least one input predicate returns true
  - xor
```
public static FilterPredicate xor(FilterPredicate p1,
                                  FilterPredicate p2)
```
    Returns true if one input predicate returns true and the other predicate returns false. return p1.valid(row) OR p2.valid(row)
    
    Parameters:
    
    p1 - first input predicate
    
    p2 - second input predicate
    
    Returns:
    
    true if one input predicate returns true and the other returns false
  - nor
```
public static FilterPredicate nor(FilterPredicate p1,
                                  FilterPredicate p2)
```
    Returns true if one input predicate returns true and the other predicate returns false. return !p1.valid(row) AND !p2.valid(row)
    
    Parameters:
    
    p1 - first input predicate
    
    p2 - second input predicate
    
    Returns:
    
    true if one input predicate returns true and the other returns false
  - ne
```
public static FilterPredicate ne(String name,
                                 Object value)
```
    Creates a ComparePredicate using not equals operation
    
    Parameters:
    
    name - row column name
    
    value - value for comparison
    
    Returns:
    
    'not equals' predicate
    
    See Also:
    
    ComparePredicate.Operation.NE
  - neColumn
```
public static FilterPredicate neColumn(String nameA,
                                       String nameB)
```
    Creates a ColumnComparePredicate using not equals operation
    
    Parameters:
    
    nameA - first row column name
    
    nameB - second row column name
    
    Returns:
    
    'not equals' predicate
    
    See Also:
    
    ComparePredicate.Operation.NE
  - eq
```
public static FilterPredicate eq(String name,
                                 Object value)
```
    Creates a ComparePredicate using equals operation
    
    Parameters:
    
    name - row column name
    
    value - value for comparison
    
    Returns:
    
    'equals' predicate
    
    See Also:
    
    ComparePredicate.Operation.EQ
  - eqColumn
```
public static FilterPredicate eqColumn(String nameA,
                                       String nameB)
```
    Creates a ColumnComparePredicate using equals operation
    
    Parameters:
    
    nameA - first row column name
    
    nameB - second row column name
    
    Returns:
    
    'equals' predicate
    
    See Also:
    
    ComparePredicate.Operation.EQ
  - gt
```
public static FilterPredicate gt(String name,
                                 Object value)
```
    Creates a ComparePredicate using greater than operation
    
    Parameters:
    
    name - row column name
    
    value - value for comparison
    
    Returns:
    
    'greater than' predicate
    
    See Also:
    
    ComparePredicate.Operation.GT
  - gtColumn
```
public static FilterPredicate gtColumn(String nameA,
                                       String nameB)
```
    Creates a ColumnComparePredicate using greater than operation
    
    Parameters:
    
    nameA - first row column name
    
    nameB - second row column name
    
    Returns:
    
    'greater than' predicate
    
    See Also:
    
    ComparePredicate.Operation.GT
  - lt
```
public static FilterPredicate lt(String name,
                                 Object value)
```
    Creates a ComparePredicate using lower than operation
    
    Parameters:
    
    name - row column name
    
    value - value for comparison
    
    Returns:
    
    'lower than' predicate
    
    See Also:
    
    ComparePredicate.Operation.LT
  - ltColumn
```
public static FilterPredicate ltColumn(String nameA,
                                       String nameB)
```
    Creates a ColumnComparePredicate using lower than operation
    
    Parameters:
    
    nameA - first row column name
    
    nameB - second row column name
    
    Returns:
    
    'lower than' predicate
    
    See Also:
    
    ComparePredicate.Operation.LT
  - ge
```
public static FilterPredicate ge(String name,
                                 Object value)
```
    Creates a ComparePredicate using greater or equal operation
    
    Parameters:
    
    name - row column name
    
    value - value for comparison
    
    Returns:
    
    'greater or equal' predicate
    
    See Also:
    
    ComparePredicate.Operation.GE
  - geColumn
```
public static FilterPredicate geColumn(String nameA,
                                       String nameB)
```
    Creates a ColumnComparePredicate using greater or equal operation
    
    Parameters:
    
    nameA - first row column name
    
    nameB - second row column name
    
    Returns:
    
    'greater or equal' predicate
    
    See Also:
    
    ComparePredicate.Operation.LE
  - le
```
public static FilterPredicate le(String name,
                                 Object value)
```
    Creates a ComparePredicate using lower or equal operation
    
    Parameters:
    
    name - row column name
    
    value - value for comparison
    
    Returns:
    
    'lower or equal' predicate
    
    See Also:
    
    ComparePredicate.Operation.LE
  - leColumn
```
public static FilterPredicate leColumn(String nameA,
                                       String nameB)
```
    Creates a ColumnComparePredicate using lower or equal operation
    
    Parameters:
    
    nameA - first row column name
    
    nameB - second row column name
    
    Returns:
    
    'lower or equal' predicate
    
    See Also:
    
    ComparePredicate.Operation.LE
  - in
```
public static FilterPredicate in(String name,
                                 Object[] values)
```
    Returns a predicate that checks whether the row column value is contained in an array of comparison values.
    comparison_values.contains(row.getValue(name))
    
    Parameters:
    
    name - row column name
    
    values - values for comparison
    
    Returns:
    
    'in' predicate.
  - in
```
public static FilterPredicate in(String name,
                                 Collection<Object> values)
```
    Returns a predicate that checks whether the row column value is contained in a collection of comparison values.
    comparison_values.contains(row.getValue(name))
    
    Parameters:
    
    name - row column name
    
    values - values for comparison
    
    Returns:
    
    'in' predicate.
  - in
```
public static FilterPredicate in(String name,
                                 Set<Object> values)
```
    Returns a predicate that checks whether the row column value is contained in a set of comparison values.
    comparison_values.contains(row.getValue(name))
    
    Parameters:
    
    name - row column name
    
    values - values for comparison
    
    Returns:
    
    'in' predicate.
  - btwn
```
public static FilterPredicate btwn(String name,
                                   Object low,
                                   Object high)
```
    Returns a predicate that checks whether the row column value is between two comparison values.
    row.get(name) > low AND row.get(name) < high
    
    Parameters:
    
    name - row column name
    
    low - low value
    
    high - high value
    
    Returns:
    
    'between' predicate.
  - matches
```
public static FilterPredicate matches(String name,
                                      Pattern pattern)
```
    Returns a MatchPredicate that checks whether the row column value matches a specified Pattern.
    pattern.matches(row.get(name))
    
    Parameters:
    
    name - row column name
    
    pattern - match pattern
    
    Returns:
    
    'matches' predicate.
  - matches
```
public static FilterPredicate matches(String name,
                                      String patternString)
```
    Returns a MatchPredicate that checks whether the row column value matches a specified pattern string.
    
    Parameters:
    
    name - row column name
    
    patternString - match pattern string
    
    Returns:
    
    'matches' predicate.
    
    See Also:
    
    matches(String, Pattern)
  - compile
```
public static FilterPredicate compile(String predicateString)
```

Class FilterPredicate

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

EMPTY_FILTER

Constructor Detail

FilterPredicate

Method Detail

valid

toString

empty

and

or

xor

nor

neg

not

ne

eq

and

or

and

or

xor

nor

ne

neColumn

eq

eqColumn

gt

gtColumn

lt

ltColumn

ge

geColumn

le

leColumn

in

in

in

btwn

matches

matches

compile