ch.emf.dao.filtering

Class Filter

java.lang.Object

ch.emf.dao.filtering.Filter

public class Filter
extends Object

Permet de définir un filtre pour la classe Search dans le but de limiter les résultats d'une requête JPQL. Ce code est un code simplifié d'un projet "hibernate-generic-dao" disponible sur le net.
Par exemple NOT, SOME, ALL et NONE ne sont pas implémentés.

Exemples d'utilisation :

   Filter.equal("nom","Paul")
   Filter.and()
   Filter.greaterThan("age", 53)
 

Author:

Jean-Claude Stritt

Opt:

nodefillcolor LemonChiffon

Field Summary

Fields

Modifier and Type	Field and Description
protected Field	field
protected Operator	operator
protected Object	value1
protected Object	value2

Constructor Summary

Constructors

Constructor and Description
Filter(Field field, Operator operator)
Filter(Field field, Operator operator, Object value)
Filter(Field field, Operator operator, Object value1, Object value2)
Filter(Operator operator)

Method Summary

Modifier and Type	Method and Description
static Filter	and() Création d'un filtre ET.
static Filter	between(Field field, Object value1, Object value2) Création d'un filtre de type "between".
static Filter	close_parenthesis() Création d'un filtre de type parenthèse fermante.
static Filter	equal(Field field, Object value) Création d'un filtre de type "égalité" (=).
Field	getField()
Operator	getOperator()
Object	getValue1()
Object	getValue2()
static Filter	greaterOrEqual(Field field, Object value) Création d'un filtre de type "plus grand ou égal".
static Filter	greaterThan(Field field, Object value) Création d'un filtre de type "plus grand que".
static Filter	ilike(Field field, String value) Création d'un filtre de type "ilike".
static Filter	in(Field field, Collection<?> coll) Création d'un filtre de type "in".
static Filter	in(Field field, Object... values) Création d'un filtre de type "in".
static Filter	isEmpty(Field field) Création d'un filtre de type "est vide".
static Filter	isNotEmpty(Field field) Création d'un filtre de type "n'est pas vide".
static Filter	isNotNull(Field field) Création d'un filtre de type "n'est pas nul".
static Filter	isNull(Field field) Création d'un filtre de type "est nul".
static Filter	lessOrEqual(Field field, Object value) Création d'un filtre de type "plus petit ou égal".
static Filter	lessThan(Field field, Object value) Création d'un filtre de type "plus petit que".
static Filter	like(Field field, String value) Création d'un filtre de type "like".
static Filter	not() Création d'un filtre de type NOT.
static Filter	notEqual(Field field, Object value) Création d'un filtre de type "n'est pas égal" (différent).
static Filter	notIn(Field field, Collection<?> coll) Création d'un filtre de type "not in".
static Filter	notIn(Field field, Object... values) Création d'un filtre de type "not in".
static Filter	open_parenthesis() Création d'un filtre de type parenthèse ouvrante.
static Filter	or() Création d'un filtre OR.
boolean	takesListOfSubFilters() Retourne VRAI si l'opérateur nécessite une suite de plusieurs filtres, ce qui est le cas pour : AND, OR
boolean	takesListOfValues() Retourne VRAI si l'opérateur nécessite une liste de valeurs, ce qui est le cas pour : IN, NOT_IN
boolean	takesNoProperty() Retourne VRAI si l'opérateur ne nécessite aucune propriété, ce qui est le cas pour : AND, OR, NOT
boolean	takesNoValue() Retourne VRAI si l'opérateur ne nécessite aucune valeur, ce qui est le cas pour : NULL, NOT_NULL, EMPTY, NOT_EMPTY
boolean	takesSingleSubFilter() Retourne VRAI si l'opérateur nécessite un seul filtre à spécifier, ce qui est le cas pour : NOT, SOME, ALL, NONE
boolean	takesSingleValue() Retourne VRAI si l'opérateur nécessite une seule operande, ce qui est le cas pour : EQUAL, NOT_EQUAL, LESS_THAN, LESS_OR_EQUAL, GREATER_THAN, GREATER_OR_EQUAL, LIKE
boolean	takesTwoValues() Retourne VRAI si l'opérateur nécessite deux operandes, ce qui est le cas pour : BETWEEN
boolean	takesValues() Retourve VRAI si une ou plusieurs valeurs sont nécessaires.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

field

protected Field field

operator

protected Operator operator

value1

protected Object value1

value2

protected Object value2

Constructor Detail

Filter

public Filter(Field field,
              Operator operator,
              Object value1,
              Object value2)

Filter

public Filter(Field field,
              Operator operator,
              Object value)

Filter

public Filter(Field field,
              Operator operator)

Filter

public Filter(Operator operator)

Method Detail

getField

public Field getField()

getOperator

public Operator getOperator()

getValue1

public Object getValue1()

getValue2

public Object getValue2()

equal

public static Filter equal(Field field,
                           Object value)

Création d'un filtre de type "égalité" (=).

Parameters:

field - le champ à filtrer

value - une valeur de filtre pour ce champ

Returns:

un filtre du type pré-cité

notEqual

public static Filter notEqual(Field field,
                              Object value)

Création d'un filtre de type "n'est pas égal" (différent).

Parameters:

field - le champ à filtrer

value - une valeur de filtre pour ce champ

Returns:

un filtre du type pré-cité

lessThan

public static Filter lessThan(Field field,
                              Object value)

Création d'un filtre de type "plus petit que".

Parameters:

field - le champ à filtrer

value - une valeur de filtre pour ce champ

Returns:

un filtre du type pré-cité

greaterThan

public static Filter greaterThan(Field field,
                                 Object value)

Création d'un filtre de type "plus grand que".

Parameters:

field - le champ à filtrer

value - une valeur de filtre pour ce champ

Returns:

un filtre du type pré-cité

lessOrEqual

public static Filter lessOrEqual(Field field,
                                 Object value)

Création d'un filtre de type "plus petit ou égal".

Parameters:

field - le champ à filtrer

value - une valeur de filtre pour ce champ

Returns:

un filtre du type pré-cité

greaterOrEqual

public static Filter greaterOrEqual(Field field,
                                    Object value)

Création d'un filtre de type "plus grand ou égal".

Parameters:

field - le champ à filtrer

value - une valeur de filtre pour ce champ

Returns:

un filtre du type pré-cité

like

public static Filter like(Field field,
                          String value)

Création d'un filtre de type "like".

Parameters:

field - le champ à filtrer

value - la valeur à filtrer de type String

Returns:

un filtre du type pré-cité

ilike

public static Filter ilike(Field field,
                           String value)

Création d'un filtre de type "ilike".

Parameters:

field - le champ à filtrer

value - la valeur à filtrer de type String

Returns:

un filtre du type pré-cité

between

public static Filter between(Field field,
                             Object value1,
                             Object value2)

Création d'un filtre de type "between".

Parameters:

field - le champ à filtrer

value1 - la première valeur

value2 - la dernière valeur

Returns:

un filtre du type pré-cité

in

public static Filter in(Field field,
                        Collection<?> coll)

Création d'un filtre de type "in". Nécessite ici une collection quelconque de valeurs.

Parameters:

field - le champ à filtrer

coll - une collection d'objets qui doivent exister

Returns:

un filtre du type pré-cité

in

public static Filter in(Field field,
                        Object... values)

Création d'un filtre de type "in". Nécessite ici une série quelconque de valeurs.

Parameters:

field - le champ à filtrer

values - un tableau d'objets qui doivent exister

Returns:

un filtre du type pré-cité

notIn

public static Filter notIn(Field field,
                           Collection<?> coll)

Création d'un filtre de type "not in". Nécessite ici une collection quelconque de valeurs.

Parameters:

field - le champ à filtrer

coll - une collection d'objets qui ne doivent pas exister

Returns:

un filtre du type pré-cité

notIn

public static Filter notIn(Field field,
                           Object... values)

Création d'un filtre de type "not in". Nécessite ici une série quelconque de valeurs.

Parameters:

field - le champ à filtrer

values - un tableau d'objets qui ne doivent pas exister

Returns:

un filtre du type pré-cité

isNull

public static Filter isNull(Field field)

Création d'un filtre de type "est nul".

Parameters:

field - le champ à filtrer

Returns:

un filtre du type pré-cité

isNotNull

public static Filter isNotNull(Field field)

Création d'un filtre de type "n'est pas nul".

Parameters:

field - le champ à filtrer

Returns:

un filtre du type pré-cité

isEmpty

public static Filter isEmpty(Field field)

Création d'un filtre de type "est vide".

Parameters:

field - le champ à filtrer

Returns:

un filtre du type pré-cité

isNotEmpty

public static Filter isNotEmpty(Field field)

Création d'un filtre de type "n'est pas vide".

Parameters:

field - le champ à filtrer

Returns:

un filtre du type pré-cité

and

public static Filter and()

Création d'un filtre ET.

Returns:

un filtre du type pré-cité

or

public static Filter or()

Création d'un filtre OR.

Returns:

un filtre du type pré-cité

not

public static Filter not()

Création d'un filtre de type NOT.

Returns:

un filtre du type pré-cité

open_parenthesis

public static Filter open_parenthesis()

Création d'un filtre de type parenthèse ouvrante.

Returns:

un filtre du type pré-cité

close_parenthesis

public static Filter close_parenthesis()

Création d'un filtre de type parenthèse fermante.

Returns:

un filtre du type pré-cité

takesSingleValue

public boolean takesSingleValue()

Retourne VRAI si l'opérateur nécessite une seule operande, ce qui est le cas pour :

   EQUAL, NOT_EQUAL, LESS_THAN, LESS_OR_EQUAL,
   GREATER_THAN, GREATER_OR_EQUAL, LIKE
 

Returns:

true ou false

takesTwoValues

public boolean takesTwoValues()

Retourne VRAI si l'opérateur nécessite deux operandes, ce qui est le cas pour :

   BETWEEN
 

Returns:

true ou false

takesListOfValues

public boolean takesListOfValues()

Retourne VRAI si l'opérateur nécessite une liste de valeurs, ce qui est le cas pour :

   IN, NOT_IN
 

Returns:

true ou false

takesValues

public boolean takesValues()

Retourve VRAI si une ou plusieurs valeurs sont nécessaires.

Returns:

true ou false

takesNoValue

public boolean takesNoValue()

Retourne VRAI si l'opérateur ne nécessite aucune valeur, ce qui est le cas pour :

   NULL, NOT_NULL, EMPTY, NOT_EMPTY
 

Returns:

true ou false

takesSingleSubFilter

public boolean takesSingleSubFilter()

Retourne VRAI si l'opérateur nécessite un seul filtre à spécifier, ce qui est le cas pour :

   NOT, SOME, ALL, NONE
 

Returns:

true ou false

takesListOfSubFilters

public boolean takesListOfSubFilters()

Retourne VRAI si l'opérateur nécessite une suite de plusieurs filtres, ce qui est le cas pour :
AND, OR

Returns:

true ou false

takesNoProperty

public boolean takesNoProperty()

Retourne VRAI si l'opérateur ne nécessite aucune propriété, ce qui est le cas pour :
AND, OR, NOT

Returns:

true ou false

toString

public String toString()

Overrides:

toString in class Object