Search2 (DaoLayer 6.1.8 API)

java.lang.Object
- ch.emf.dao.filtering.Search2

```
public class Search2
extends Object
```
Une classe pour préparer une requête JPQL de type select. La base de la requête est fournie au constructeur de la classe ce qui permet même des "inner join", chose que la classe "Search" standard ne permet pas, car elle est basée sur une seule table. Les méthodes de cette classe ajoutent ensuite les différents filtres (pour la clause WHERE avec des AND automatiques entre deux -modifiable-).

Exemple d'utilisation :
```
   Search2 search = new Search2("select p from Pesee p join p.bonLivraison b");
   search.addFilterEqual("b.imprime", true);
   search.addFilterEqual("b.client", cl);
   search.addFilterEqual("b.chantier", ch);
   search.addFilterEqual("p.article", ar);
   search.addFilterBetween("b.datePesee", dateDebut, dateFin);
   search.addSortFields("b.datePesee", "b.code");
 
```
Ensuite :
```
   pesees = dao.getList(search);
 
```
Author:

jcstritt

Opt:

nodefillcolor LemonChiffon

Constructor Summary

Constructors
Constructor and Description

Search2(String jpql)
Constructeur 2.

Search2(String jpql, String defLogOp)
Constructeur 1.

Constructors
Constructor and Description
`Search2(String jpql)` Constructeur 2.
`Search2(String jpql, String defLogOp)` Constructeur 1.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFilter(String op, String prop, Object value)` N'ajoute un filtre que si la valeur spécifiée est non nulle.
`void`	`addFilterAnd()` Ajoute une condition logique ET (and) après les filtres existants.
`void`	`addFilterBetween(String prop, Object startValue, Object endValue)` Ajoute un filtre qui teste si une valeur dans la DB se trouve entre deux valeurs de références pour une propriété donnée.
`void`	`addFilterCloseParenthesis()` Ajoute une parenthèse fermante à la clause WHERE en cours de création.
`void`	`addFilterEqual(String prop, Object value)` Ajoute un filtre qui teste une égalité.
`void`	`addFilterEqual(String prop, Object value1, Object value2)` Ajoute un filtre qui teste une double égalité avec un opérateur "ou" entre-deux.
`void`	`addFilterGreaterOrEqual(String prop, Object value)` Ajoute un filtre qui teste si des valeurs dans la BD sont plus grandes ou égales à une valeur de référence spécifiée.
`void`	`addFilterGreatherThan(String prop, Object value)` Ajoute un filtre qui teste si des valeurs dans la BD sont plus grandes q'une valeur de référence spécifiée.
`void`	`addFilterIsEmpty(String prop)` Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont vides (empty).
`void`	`addFilterIsNotEmpty(String prop)` Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont non vides (not empty).
`void`	`addFilterIsNotNull(String prop)` Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont non nulles.
`void`	`addFilterIsNull(String prop)` Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont nulles.
`void`	`addFilterLessOrEqual(String prop, Object value)` Ajoute un filtre qui teste si des valeurs dans la BD sont plus petites ou égales à une valeur de référence spécifiée.
`void`	`addFilterLessThan(String prop, Object value)` Ajoute un filtre qui teste si des valeurs dans la BD sont plus petites qu'une valeur de référence spécifiée.
`void`	`addFilterLike(String prop, String value)` Ajoute un filtre qui teste si des valeurs dans la BD ressemblent (like) à une valeur de référence spécifiée pour une propriété donnée.
`void`	`addFilterNotEqual(String prop, Object value)` Ajoute un filtre qui teste une inégalité.
`void`	`addFilterOpenParenthesis()` Ajoute une parenthèse ouvrante à la clause WHERE en cours de création.
`void`	`addFilterOr()` Ajoute une condition logique OU (or) après les filtres existants.
`void`	`addGroupByField(String prop)` Ajoute une expression de regroupement (groupe by) après les filtres déjà en cours.
`void`	`addHavingCondition(String condition)` Ajoute une expression "qui contient" (having) après les filtres déjà en cours.
`void`	`addSimpleFilter(String op, String prop, Object value)` Ajoute un simple filtre basé sur un opérateur et une valeur.
`void`	`addSortFields(String... propNames)` Ajoute une ou plusieurs propriétés de tri après la requête en cours.
`int`	`getFirstResult()` Getter pour l'attribut "index du premier résultat" (firstResult).
`String`	`getJpql()` Permet de récupérer la requête jpql juste avant que les valeurs de paramètres ne soient injectées.
`int`	`getMaxResults()` Getter pour l'attribut "nombre maximal de résultats attendus" (maxResults).
`Object[]`	`getParams()` Un tableau avec les valeurs à injecter comme paramètres dans la requête jpql en cours.
`void`	`setDefaultLogicalOp(String defLogOp)` Setter pour modifier l'opérateur logique par défaut ("and") ajouté avant chaque filtre.
`void`	`setFirstResult(int firstResult)` Setter pour l'attribut "index du premier résultat" (firstResult).
`void`	`setMaxResults(int maxResults)` Setter pour l'attribut "nb maximal de résultats attendu" (maxResults).

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

- Constructor Detail
  - Search2
```
public Search2(String jpql,
               String defLogOp)
```
    Constructeur 1.
    
    Parameters:
    
    jpql - une chaine de car. représentant las base de la requête JPQL
    
    defLogOp - opérateur par défaut entre les filtres ("and" ou "or")
  - Search2
```
public Search2(String jpql)
```
    Constructeur 2.
    L'opérateur par défaut entre les filtres est un "ET" ("and").
    
    Parameters:
    
    jpql - une chaine de car. représentant las base de la requête JPQL
- Method Detail
  - setDefaultLogicalOp
```
public void setDefaultLogicalOp(String defLogOp)
```
    Setter pour modifier l'opérateur logique par défaut ("and") ajouté avant chaque filtre. S'il est null ou vide, aucun opérateur logique ne sera ajouté.
    
    Parameters:
    
    defLogOp - l'opérateur logique par défaut ajouté automatiquement avant chaque filtre
  - addSimpleFilter
```
public void addSimpleFilter(String op,
                            String prop,
                            Object value)
```
    Ajoute un simple filtre basé sur un opérateur et une valeur.
    Il n'y a pas de test sur le contenu de la valeur du filtre et il n'y pas non plus d'opérateur logique rajouté avant le filtre lui-même.
    
    Parameters:
    
    op - l'opérateur du filtre (ex: "=").
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de test
  - addFilter
```
public void addFilter(String op,
                      String prop,
                      Object value)
```
    N'ajoute un filtre que si la valeur spécifiée est non nulle.
    L'opérateur logique par défaut est rajoutée avant le filtre (sauf s'il est vide);
    
    Parameters:
    
    op - l'opérateur du filtre (ex: "=").
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de test
  - addFilterEqual
```
public void addFilterEqual(String prop,
                           Object value)
```
    Ajoute un filtre qui teste une égalité.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de test
  - addFilterEqual
```
public void addFilterEqual(String prop,
                           Object value1,
                           Object value2)
```
    Ajoute un filtre qui teste une double égalité avec un opérateur "ou" entre-deux.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value1 - la première valeur de test
    
    value2 - la deuxième valeur de test
  - addFilterNotEqual
```
public void addFilterNotEqual(String prop,
                              Object value)
```
    Ajoute un filtre qui teste une inégalité.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de test
  - addFilterLessThan
```
public void addFilterLessThan(String prop,
                              Object value)
```
    Ajoute un filtre qui teste si des valeurs dans la BD sont plus petites qu'une valeur de référence spécifiée.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de référence
  - addFilterLessOrEqual
```
public void addFilterLessOrEqual(String prop,
                                 Object value)
```
    Ajoute un filtre qui teste si des valeurs dans la BD sont plus petites ou égales à une valeur de référence spécifiée.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de référence
  - addFilterGreatherThan
```
public void addFilterGreatherThan(String prop,
                                  Object value)
```
    Ajoute un filtre qui teste si des valeurs dans la BD sont plus grandes q'une valeur de référence spécifiée.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de référence
  - addFilterGreaterOrEqual
```
public void addFilterGreaterOrEqual(String prop,
                                    Object value)
```
    Ajoute un filtre qui teste si des valeurs dans la BD sont plus grandes ou égales à une valeur de référence spécifiée.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de référence
  - addFilterBetween
```
public void addFilterBetween(String prop,
                             Object startValue,
                             Object endValue)
```
    Ajoute un filtre qui teste si une valeur dans la DB se trouve entre deux valeurs de références pour une propriété donnée.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    startValue - la valeur de référence inférieure
    
    endValue - la valeur de référence supérieure
  - addFilterLike
```
public void addFilterLike(String prop,
                          String value)
```
    Ajoute un filtre qui teste si des valeurs dans la BD ressemblent (like) à une valeur de référence spécifiée pour une propriété donnée.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
    
    value - la valeur de référence
  - addFilterIsNull
```
public void addFilterIsNull(String prop)
```
    Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont nulles.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
  - addFilterIsNotNull
```
public void addFilterIsNotNull(String prop)
```
    Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont non nulles.
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
  - addFilterIsEmpty
```
public void addFilterIsEmpty(String prop)
```
    Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont vides (empty).
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
  - addFilterIsNotEmpty
```
public void addFilterIsNotEmpty(String prop)
```
    Ajoute un filtre qui teste si les valeurs d'une propriété spécifiée sont non vides (not empty).
    
    Parameters:
    
    prop - le nom de la propriété de filtrage
  - addFilterAnd
```
public void addFilterAnd()
```
    Ajoute une condition logique ET (and) après les filtres existants.
  - addFilterOr
```
public void addFilterOr()
```
    Ajoute une condition logique OU (or) après les filtres existants.
  - addFilterOpenParenthesis
```
public void addFilterOpenParenthesis()
```
    Ajoute une parenthèse ouvrante à la clause WHERE en cours de création.
  - addFilterCloseParenthesis
```
public void addFilterCloseParenthesis()
```
    Ajoute une parenthèse fermante à la clause WHERE en cours de création.
  - addGroupByField
```
public void addGroupByField(String prop)
```
    Ajoute une expression de regroupement (groupe by) après les filtres déjà en cours.
    
    Parameters:
    
    prop - le nom de la propriété sur laquelle il faut regrouper
  - addHavingCondition
```
public void addHavingCondition(String condition)
```
    Ajoute une expression "qui contient" (having) après les filtres déjà en cours.
    
    Parameters:
    
    condition - la condition après le mot-clé "having"
  - addSortFields
```
public void addSortFields(String... propNames)
```
    Ajoute une ou plusieurs propriétés de tri après la requête en cours.
    Exemple: "NOM ASC", "NPA DESC".
    
    Parameters:
    
    propNames - un tableau de propriétés de tri optionnelles
  - getFirstResult
```
public int getFirstResult()
```
    Getter pour l'attribut "index du premier résultat" (firstResult).
    Cela permet la pagination des résultats à retrouver.
    
    Returns:
    
    un entier exprimant l'index du premier résultat
  - setFirstResult
```
public void setFirstResult(int firstResult)
```
    Setter pour l'attribut "index du premier résultat" (firstResult).
    Cela permet la pagination des résultats à retrouver.
    
    Parameters:
    
    firstResult - l'index du premier résutat à retourner
  - getMaxResults
```
public int getMaxResults()
```
    Getter pour l'attribut "nombre maximal de résultats attendus" (maxResults).
    Cela permet la pagination des résultats à retrouver.
    
    Returns:
    
    un entier exprimant le nombre maximal de résultats attendus
  - setMaxResults
```
public void setMaxResults(int maxResults)
```
    Setter pour l'attribut "nb maximal de résultats attendu" (maxResults).
    Cela permet la pagination des résultats à retrouver.
    
    Parameters:
    
    maxResults - le nombre maximal de résultats attendus dans une requête
  - getJpql
```
public String getJpql()
```
    Permet de récupérer la requête jpql juste avant que les valeurs de paramètres ne soient injectées.
    
    Returns:
    
    la requête jpql en cours
  - getParams
```
public Object[] getParams()
```
    Un tableau avec les valeurs à injecter comme paramètres dans la requête jpql en cours.
    
    Returns:
    
    un tableau de valeurs (Objects)

Class Search2

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Search2

Search2

Method Detail

setDefaultLogicalOp

addSimpleFilter

addFilter

addFilterEqual

addFilterEqual

addFilterNotEqual

addFilterLessThan

addFilterLessOrEqual

addFilterGreatherThan

addFilterGreaterOrEqual

addFilterBetween

addFilterLike

addFilterIsNull

addFilterIsNotNull

addFilterIsEmpty

addFilterIsNotEmpty

addFilterAnd

addFilterOr

addFilterOpenParenthesis

addFilterCloseParenthesis

addGroupByField

addHavingCondition

addSortFields

getFirstResult

setFirstResult

getMaxResults

setMaxResults

getJpql

getParams