EntityInfo (DaoLayer 6.1.8 API)

java.lang.Object
- ch.emf.dao.models.EntityInfo

```
public class EntityInfo
extends Object
```
Permet de mémoriser les informations d'une "classe-entité" JPA, soit :
- la classe elle-même;
- le nom de sa PK;
- le type de la PK.
Par rapport aux informations mémorisées, cela permet aussi toutes sortes d'opérations de construction d'une requête JPQL.

Author:

jcstritt

Opt:

nodefillcolor LemonChiffon

Constructor Summary

Constructors
Constructor and Description

EntityInfo(Class<?> cl)
Constructeur.

Constructors
Constructor and Description
`EntityInfo(Class<?> cl)` Constructeur.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`buildAggregateFunction(String func, String propName)` Retourne une clause SELECT avec l'une des functions d'agrégation AVG, SUM, MIN, MAX ou COUNT.
`String`	`buildCountClause()` Retourne une clause COUNT avec le nom de la classe-entité.
`String`	`buildDeleteClause()` Retourne une clause DELETE avec le nom de la classe-entité.
`String`	`buildFromClause()` Retourne la partie "FROM" d'une requête jpql.
`String`	`buildMaxClause(String propName)` Retourne une clause MAX sur une propriété numérique et le nom de la classe-entité.
`String`	`buildSelectClause()` Retourne une clause SELECT avec le nom de la classe-entité.
`String`	`buildUpdatePkMaxClause(Object pkMax)` Construit une clause de mise à jour de la PK maximale actuellement utilisée.
`String`	`buildWhereClause(String prop)` Retourne une clause WHERE simple avec une propriété dont la valeur sera encore à compléter.
`Method`	`findMethod(String method)` Retrouve une méthode dans la classe-entité JPA traitée.
`Class<?>`	`getEntityClass()` Retourne la classe de l'entité JPA.
`List<Field>`	`getFields()` Retourne une liste des attributs présents dans la classe-entité traitée.
`String`	`getGroupByClause(Search search)` Retourne la clause "GROUP BY" d'une requête JPQL en utilisant la liste des champs ajoutés dans un objet "Search" avec des "addGroupByField".
`String`	`getHavingClause(Search search)` Retourne la clause "HAVING" d'une requête JPQL en utilisant la liste des conditions ajoutés dans un objet "Search" avec des "addHavingCondition".
`String`	`getOrderByClause(Search search)` Retourne la clause "ORDER BY" d'une requête JPQL en utilisant les informations de tri présent dans l'objet "Search" passé en paramêtre.
`String`	`getOrderByClause(String sortFields)` Retourne la clause "ORDER BY" d'une requête JPQL en spécifiant directement la une chaine de caractères avec la liste des champs de tri.
`Object[]`	`getParams(Search search)` Retourne un tableau de paramètres pour un futur objet Query.
`long`	`getPkAllocationSize()` Retourne le pas entre chaque PK spécifié dans la table de séquence.
`long`	`getPkInitialValue()` Retourne la valeur initiale de la PK dans la table de séquence.
`String`	`getPkName()` Retourne le nom de la PK.
`Type`	`getPkType()` Retourne le type de la PK.
`String`	`getSelectClause(Search search)` Retourne la clause "SELECT" d'une requête JPQL en se basant sur le contenu de l'object "search" passé en paramètre.
`String`	`getWhereClause(Search search)` Retourne la clause "WHERE" d'un requete JPQL en se basant sur le contenu de l'objet "Search" passé en paramètre.
`boolean`	`isTableSeqUsed()` Retourne TRUE si une table de séquence est utilisée pour les PK.
`String`	`toString()` Surcharge de toString pour un meilleur affichage de l'objet.

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

- Constructor Detail
  - EntityInfo
```
public EntityInfo(Class<?> cl)
```
    Constructeur.
    
    Parameters:
    
    cl - la classe "entity" à gérer
- Method Detail
  - getEntityClass
```
public Class<?> getEntityClass()
```
    Retourne la classe de l'entité JPA.
    
    Returns:
    
    entity class
  - getPkName
```
public String getPkName()
```
    Retourne le nom de la PK.
    
    Returns:
    
    PK name
  - getPkType
```
public Type getPkType()
```
    Retourne le type de la PK.
    
    Returns:
    
    PK type
  - isTableSeqUsed
```
public boolean isTableSeqUsed()
```
    Retourne TRUE si une table de séquence est utilisée pour les PK.
    
    Returns:
    
    true or false
  - getPkInitialValue
```
public long getPkInitialValue()
```
    Retourne la valeur initiale de la PK dans la table de séquence.
    
    Returns:
    
    valeur initiale de la PK
  - getPkAllocationSize
```
public long getPkAllocationSize()
```
    Retourne le pas entre chaque PK spécifié dans la table de séquence.
    
    Returns:
    
    la taille du pas entre chaque PK
  - buildFromClause
```
public String buildFromClause()
```
    Retourne la partie "FROM" d'une requête jpql.
    
    Returns:
    
    une chaine de caractères avec la clause FROM
  - buildSelectClause
```
public String buildSelectClause()
```
    Retourne une clause SELECT avec le nom de la classe-entité.
    
    Returns:
    
    une chaîne de caractères avec la clause SELECT
  - buildDeleteClause
```
public String buildDeleteClause()
```
    Retourne une clause DELETE avec le nom de la classe-entité.
    
    Returns:
    
    une chaîne de caractères avec la clause DELETE
  - buildWhereClause
```
public String buildWhereClause(String prop)
```
    Retourne une clause WHERE simple avec une propriété dont la valeur sera encore à compléter.
    
    Parameters:
    
    prop - une propriété avec une valeur encore à fournir
    
    Returns:
    
    une chaîne de caractères avec la clause WHERE
  - buildAggregateFunction
```
public String buildAggregateFunction(String func,
                                     String propName)
```
    Retourne une clause SELECT avec l'une des functions d'agrégation AVG, SUM, MIN, MAX ou COUNT.
    
    Parameters:
    
    func - la fonction d'agrégation
    
    propName - la propriété sur laquelle se fait l'agrégation
    
    Returns:
    
    une chaîne de caractères avec requête JPQL d'aggrégation
  - buildCountClause
```
public String buildCountClause()
```
    Retourne une clause COUNT avec le nom de la classe-entité.
    
    Returns:
    
    une chaîne de caractères avec requête JPQL pour compter
  - buildMaxClause
```
public String buildMaxClause(String propName)
```
    Retourne une clause MAX sur une propriété numérique et le nom de la classe-entité.
    
    Parameters:
    
    propName - le nom d'une propriété
    
    Returns:
    
    une chaîne de caractères avec requête JPQL avec la fonction MAX
  - buildUpdatePkMaxClause
```
public String buildUpdatePkMaxClause(Object pkMax)
```
    Construit une clause de mise à jour de la PK maximale actuellement utilisée.
    
    Parameters:
    
    pkMax - la PK max actuellement utilisée
    
    Returns:
    
    une chaine jpql de mise à jour de cette PK dans la table de séquence
  - findMethod
```
public Method findMethod(String method)
```
    Retrouve une méthode dans la classe-entité JPA traitée.
    
    Parameters:
    
    method - le nom d'une méthode à retrouver
    
    Returns:
    
    l'objet Method recherché
  - getFields
```
public List<Field> getFields()
```
    Retourne une liste des attributs présents dans la classe-entité traitée.
    Utile pour créer des combobox de filtrage. Ne prend pas en compte les attributs commençant par fk ou pk, ainsi que les attributs marqués avec "static".
    
    Returns:
    
    une liste des attributs de la classe-entité
  - getSelectClause
```
public String getSelectClause(Search search)
```
    Retourne la clause "SELECT" d'une requête JPQL en se basant sur le contenu de l'object "search" passé en paramètre.
    
    Parameters:
    
    search - l'objet de recherche qui spécifie les champs du select
    
    Returns:
    
    la clause "select" en JPQL
  - getWhereClause
```
public String getWhereClause(Search search)
```
    Retourne la clause "WHERE" d'un requete JPQL en se basant sur le contenu de l'objet "Search" passé en paramètre.
    
    Parameters:
    
    search - l'objet de recherche qui limite la recherche
    
    Returns:
    
    la clause "where" en JPQL
  - getGroupByClause
```
public String getGroupByClause(Search search)
```
    Retourne la clause "GROUP BY" d'une requête JPQL en utilisant la liste des champs ajoutés dans un objet "Search" avec des "addGroupByField".
    
    Parameters:
    
    search - l'objet de recherche
    
    Returns:
    
    la clause "GROUP BY" en jpql
  - getHavingClause
```
public String getHavingClause(Search search)
```
    Retourne la clause "HAVING" d'une requête JPQL en utilisant la liste des conditions ajoutés dans un objet "Search" avec des "addHavingCondition".
    
    Parameters:
    
    search - l'objet de recherche
    
    Returns:
    
    la clause "HAVING" en jpql
  - getOrderByClause
```
public String getOrderByClause(Search search)
```
    Retourne la clause "ORDER BY" d'une requête JPQL en utilisant les informations de tri présent dans l'objet "Search" passé en paramêtre.
    
    Parameters:
    
    search - l'objet de recherche qui limite (filtre) la recherche
    
    Returns:
    
    la clause "order by" en JPQL
  - getOrderByClause
```
public String getOrderByClause(String sortFields)
```
    Retourne la clause "ORDER BY" d'une requête JPQL en spécifiant directement la une chaine de caractères avec la liste des champs de tri.
    
    Parameters:
    
    sortFields - les différents champs pour l'ordre de tri (ex: nom, prenom)
    
    Returns:
    
    la clause "order by" en JPQL
  - getParams
```
public Object[] getParams(Search search)
```
    Retourne un tableau de paramètres pour un futur objet Query.
    Ces valeurs sont présentes dans les filtres ajoutés à un objet "Search".
    
    Parameters:
    
    search - l'objet de recherche
    
    Returns:
    
    un tableau avec les valeurs des paramètres pour un objet "Query"
  - toString
```
public String toString()
```
    Surcharge de toString pour un meilleur affichage de l'objet.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    un string représentant l'objet

Class EntityInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EntityInfo

Method Detail

getEntityClass

getPkName

getPkType

isTableSeqUsed

getPkInitialValue

getPkAllocationSize

buildFromClause

buildSelectClause

buildDeleteClause

buildWhereClause

buildAggregateFunction

buildCountClause

buildMaxClause

buildUpdatePkMaxClause

findMethod

getFields

getSelectClause

getWhereClause

getGroupByClause

getHavingClause

getOrderByClause

getOrderByClause

getParams

toString