SqlOperator (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- net.sf.mmm.util.query.base.expression.SqlOperator<T,S>

Type Parameters:

T - the generic type of the comparison type.

S - the generic type of the second comparison argument - typically same as first (<T>).

Direct Known Subclasses:

SqlOperator.SqlOperatorBetween, SqlOperator.SqlOperatorContainment, SqlOperator.SqlOperatorEmptyness, SqlOperator.SqlOperatorNumber, SqlOperator.SqlOperatorString
```
public abstract class SqlOperator<T,S>
extends Object
```
A SqlOperator represents the SQL function that compares two given values in expressions (e.g. in where clauses).

Since:

8.0.0

Author:

hohwille

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SqlOperator.SqlOperatorBetween<N extends Number>` Abstract base implementation of `SqlOperator` for comparison of `Number` with `Range` using SQL BETWEEN operation.
`static class`	`SqlOperator.SqlOperatorContainment` Abstract base implementation of `SqlOperator` for `String` comparison operations.
`static class`	`SqlOperator.SqlOperatorEmptyness` Abstract base implementation of `SqlOperator` for `Collection` `emptyness` check operations.
`static class`	`SqlOperator.SqlOperatorLike` Abstract base implementation of `SqlOperator` for SQL like match operation on `String`.
`static class`	`SqlOperator.SqlOperatorNumber` Abstract base implementation of `SqlOperator` for `Number` comparison operations.
`static class`	`SqlOperator.SqlOperatorString` Abstract base implementation of `SqlOperator` for `String` comparison operations.

Field Summary

Fields
Modifier and Type	Field and Description
`static SqlOperator<Number,Range<Number>>`	`BETWEEN` `SqlOperator` to check if objects match using SQL BETWEEN operation.
`static SqlOperator<Collection,Void>`	`EMPTY` `SqlOperator` to check if objects match using SQL EMPTY operation.
`static SqlOperator<Object,Object>`	`EQUAL` `SqlOperator` to check if objects are `equal`.
`static SqlOperator<Number,Number>`	`GREATER_OR_EQUAL` `SqlOperator` to check if some value is greater or equal to another.
`static SqlOperator<Number,Number>`	`GREATER_THAN` `SqlOperator` to check if some value is greater than another.
`static SqlOperator<Object,Collection<?>>`	`IN` `SqlOperator` to check if objects match using SQL IN operation.
`static SqlOperator<Number,Number>`	`LESS_OR_EQUAL` `SqlOperator` to check if some value is less or equal than another.
`static SqlOperator<Number,Number>`	`LESS_THAN` `SqlOperator` to check if some value is less than another.
`static SqlOperator<String,String>`	`LIKE` `SqlOperator` to check if objects match using SQL like pattern.
`static SqlOperator<Number,Range<Number>>`	`NOT_BETWEEN` `SqlOperator` to check if objects do NOT match using SQL BETWEEN operation.
`static SqlOperator<Collection,Void>`	`NOT_EMPTY` `SqlOperator` to check if objects do NOT match using SQL EMPTY operation.
`static SqlOperator<Object,Object>`	`NOT_EQUAL` `SqlOperator` to check if objects are NOT `equal`.
`static SqlOperator<Object,Collection<?>>`	`NOT_IN` `SqlOperator` to check if objects do NOT match using SQL IN operation.
`static SqlOperator<String,String>`	`NOT_LIKE` `SqlOperator` to check if objects match using SQL like pattern.
`private String`	`sql`
`private Class<T>`	`type`

Constructor Summary

Constructors
Modifier Constructor and Description

protected SqlOperator(String sql, Class<T> type)
The constructor.

Constructors
Modifier	Constructor and Description
`protected`	`SqlOperator(String sql, Class<T> type)` The constructor.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract boolean`	`evaluate(T arg1, S arg2)` This method evaluates this `SqlOperator` for the given arguments.
`String`	`getSql()` This method gets the SQL operator representation of this `SqlOperator`.
`Class<T>`	`getType()`
`abstract SqlOperator<T,S>`	`negate()`
`String`	`toString()`

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

- Field Detail
  - GREATER_THAN
```
public static final SqlOperator<Number,Number> GREATER_THAN
```
    SqlOperator to check if some value is greater than another.
  - GREATER_OR_EQUAL
```
public static final SqlOperator<Number,Number> GREATER_OR_EQUAL
```
    SqlOperator to check if some value is greater or equal to another.
  - LESS_THAN
```
public static final SqlOperator<Number,Number> LESS_THAN
```
    SqlOperator to check if some value is less than another.
  - LESS_OR_EQUAL
```
public static final SqlOperator<Number,Number> LESS_OR_EQUAL
```
    SqlOperator to check if some value is less or equal than another.
  - EQUAL
```
public static final SqlOperator<Object,Object> EQUAL
```
    SqlOperator to check if objects are equal.
  - NOT_EQUAL
```
public static final SqlOperator<Object,Object> NOT_EQUAL
```
    SqlOperator to check if objects are NOT equal.
  - LIKE
```
public static final SqlOperator<String,String> LIKE
```
    SqlOperator to check if objects match using SQL like pattern.
  - NOT_LIKE
```
public static final SqlOperator<String,String> NOT_LIKE
```
    SqlOperator to check if objects match using SQL like pattern.
  - BETWEEN
```
public static final SqlOperator<Number,Range<Number>> BETWEEN
```
    SqlOperator to check if objects match using SQL BETWEEN operation.
  - NOT_BETWEEN
```
public static final SqlOperator<Number,Range<Number>> NOT_BETWEEN
```
    SqlOperator to check if objects do NOT match using SQL BETWEEN operation.
  - EMPTY
```
public static final SqlOperator<Collection,Void> EMPTY
```
    SqlOperator to check if objects match using SQL EMPTY operation.
  - NOT_EMPTY
```
public static final SqlOperator<Collection,Void> NOT_EMPTY
```
    SqlOperator to check if objects do NOT match using SQL EMPTY operation.
  - IN
```
public static final SqlOperator<Object,Collection<?>> IN
```
    SqlOperator to check if objects match using SQL IN operation.
  - NOT_IN
```
public static final SqlOperator<Object,Collection<?>> NOT_IN
```
    SqlOperator to check if objects do NOT match using SQL IN operation.
  - sql
```
private final String sql
```
  - type
```
private final Class<T> type
```
- Constructor Detail
  - SqlOperator
```
protected SqlOperator(String sql,
                      Class<T> type)
```
    The constructor.
    
    Parameters:
    
    sql - - see getSql().
    
    type - - see getType().
- Method Detail
  - getSql
```
public String getSql()
```
    This method gets the SQL operator representation of this SqlOperator. E.g. "==", ">", ">=", etc.
    
    Returns:
    
    the SQL operator representation.
  - getType
```
public Class<T> getType()
```
    Returns:
    
    the type this SqlOperator can be applied to.
  - evaluate
```
public abstract boolean evaluate(T arg1,
                                 S arg2)
```
    This method evaluates this SqlOperator for the given arguments.
    
    Parameters:
    
    arg1 - is the first argument.
    
    arg2 - is the second argument.
    
    Returns:
    
    the result of the SqlOperator applied to the given arguments.
  - negate
```
public abstract SqlOperator<T,S> negate()
```
    Returns:
    
    the negation of this CompareOperator that evaluates to the negated result.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SqlOperator<T,S>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GREATER_THAN

GREATER_OR_EQUAL

LESS_THAN

LESS_OR_EQUAL

EQUAL

NOT_EQUAL

LIKE

NOT_LIKE

BETWEEN

NOT_BETWEEN

EMPTY

NOT_EMPTY

IN

NOT_IN

sql

type

Constructor Detail

SqlOperator

Method Detail

getSql

getType

evaluate

negate

toString