Module

Module(String table, Session session)

Crée un objet qui peut être utilisé pour accéder au module EMu spécifié par table.

Paramètres :

int addFetchSet(String name, String columns)

Associe un ensemble de colonnes à un nom logique sur le serveur. Le nom peut être utilisé à la place d’une liste de colonnes lors de la récupération des données à l’aide de fetch( ).

Paramètres

Paramètres :

name (String)	Nom logique à associer à l'ensemble de colonnes.
columns (String)	Une string contenant les noms des colonnes à utiliser lorsque name est passé à fetch( ). Les noms des colonnes doivent être séparés par un semi-colon ou un comma.

Retourne :

int	Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

int addFetchSet(String name, ArrayList<String> columns)

Associe un ensemble de colonnes à un nom logique sur le serveur. Le nom peut être utilisé à la place d’une liste de colonnes lors de la récupération des données à l’aide de fetch( ).

Paramètres

Paramètres :

name (String)	Nom logique à associer à l'ensemble de colonnes.
columns (ArrayList<String>)	Une liste de String contenant les noms des colonnes à utiliser lorsque name est passé à fetch( ).

Retourne :

int	Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

int addSearchAlias(String name, String columns)

Associe un ensemble de colonnes à un nom logique sur le serveur. Le nom peut être utilisé pour spécifier les termes de recherche à transmettre à findTerms( ). La recherche devient l’équivalent d’une recherche OR impliquant les colonnes.

Paramètres

Paramètres :

name (String)	Nom logique à associer à l'ensemble de colonnes.
columns (String)	Une String contenant les noms des colonnes à utiliser lorsque name est passé à findTerms( ). Les noms des colonnes doivent être séparés par un semi-colon ou un comma.

Retourne :

int	Le nombre d'alias (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

int addSearchAlias(String name, ArrayList<String> columns)

Associe un ensemble de colonnes à un nom logique sur le serveur.

Le nom peut être utilisé pour spécifier les termes de recherche à transmettre à findTerms( ). La recherche devient l’équivalent d’une recherche OR impliquant les colonnes.

Paramètres

Paramètres :

name (String)	Nom logique à associer à l'ensemble de colonnes.
columns (ArrayList<String>)	Un tableau de Strings contenant les noms des colonnes à utiliser lorsque name est passé à findTerms( ).

Retourne :

int	Le nombre d'alias (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

int addSortSet(String name, String keys)

Associe un ensemble de clés de tri à un nom logique sur le serveur.

Le nom peut être utilisé à la place d’une liste de clés de tri lors du tri du jeu de résultats actuel à l’aide de sort( ).

Paramètres

Paramètres :

name (String)	Nom logique à associer à l'ensemble de colonnes.
keys (String)	Une String contenant les noms des clés à utiliser lorsque name est passé à sort( ). Les clés doivent être séparées par un semi-colon ou une comma.

Retourne :

int	Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

int addSortSet(String name, ArrayList<String> keys)

Associe un ensemble de clés de tri à un nom logique sur le serveur.

Paramètres

Paramètres :

name (String)	Nom logique à associer à l'ensemble de colonnes.
keys (ArrayList<String>)	Une liste de Strings contenant les noms des clés à utiliser lorsque name est passé à sort( ). Les clés doivent être séparées par un semi-colon ou une comma.

Retourne :

int	Le nombre de sets (y compris celui-ci) enregistrés sur le serveur.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

ModuleFetchResult fetch(String flag, long offset, int count, String columns)

Récupère count les enregistrements à partir de la position décrite par une combinaison de flag et offset.

Paramètres

Paramètres :

flag (String)	La position à partir de laquelle commencer à récupérer les enregistrements. Doit être l'un des éléments suivants : start, current, end
offset (long)	La position par rapport à flag à partir de laquelle commencer la récupération.
count (int)	Le nombre d’enregistrements à récupérer. Un count de 0 est autorisé pour changer l’emplacement de l’enregistrement en cours sans renvoyer de résultats. Un count inférieur à 0 entraîne le renvoi de tous les enregistrements restants dans le jeu de résultats.
columns (String)	Une String contenant les noms des colonnes à retourner pour chaque enregistrement ou le nom d’un ensemble de colonnes qui a été enregistré précédemment en utilisant addFetchSet( ). Les noms des colonnes doivent être séparés par un semi-colon ou un comma.

Retourne :

ModuleFetchResult

Un objet ModuleFetchResult.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

ModuleFetchResult fetch(String flag, int offset, int count, ArrayList<String> columns)

Récupère count les enregistrements à partir de la position décrite par une combinaison de flag et offset.

Paramètres

Paramètres :

flag (String)	La position à partir de laquelle commencer à récupérer les enregistrements. Doit être l'un des éléments suivants : start, current, end
offset (int)	La position par rapport à flag à partir de laquelle commencer la récupération.
count (int)	Le nombre d’enregistrements à récupérer. Un count de 0 est autorisé pour changer l’emplacement de l’enregistrement en cours sans renvoyer de résultats. Un count inférieur à 0 entraîne le renvoi de tous les enregistrements restants dans le jeu de résultats.
columns (ArrayList<String>)	Une liste de Strings contenant les noms des colonnes à retourner pour chaque enregistrement ou le nom d’un ensemble de colonnes qui a été enregistré précédemment en utilisant addFetchSet( ).

Retourne :

ModuleFetchResult

Un objet ModuleFetchResult.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

long findKey(long key)

Recherche un enregistrement avec la valeur clé key.

Paramètres

Paramètres :

key (long)

Clé de l’enregistrement recherché.

Retourne :

long	Le nombre d'enregistrements trouvés. Ce sera soit 1 si l’enregistrement a été trouvé, soit 0 s’il n’a pas été trouvé.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

long findKeys(ArrayList<Long> keys)

Recherche les enregistrements avec des valeurs clés dans le tableau keys.

Paramètres

Paramètres :

keys (ArrayList<Long>)

Un tableau de clés recherchées.

Retourne :

long	Le nombre d’enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

long findWhere(String where)

Recherche les enregistrements qui correspondent à la clause TexQL WHERE.

Paramètres

Paramètres :

where (String)

La clause TexQL WHERE à utiliser.

Retourne :

long	Une estimation du nombre d’enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

long restoreFromTemp(String file)

Restaure un ensemble d’enregistrements à partir d’un fichier temporaire sur la machine serveur qui contient une liste de clés, une par ligne.

Fonctionne de la même manière que restoreFromFile( ) sauf que le paramètre est relatif au répertoire temporaire du serveur.

Paramètres

Paramètres :

file (String)

Le fichier sur la machine serveur contenant les clés.

Retourne :

long	Le nombre d'enregistrements trouvés.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

ModuleSortResult sort(String keys, String[] flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys.

Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres

Paramètres :

keys (String)	Une String contenant la liste des clés de tri. Les clés doivent être séparées par un semi-colon ou une comma.
flags (String[])	Un tableau de Strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

ModuleSortResult sort(String[] keys, String flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys.

Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres

Paramètres :

keys (String[])	Un tableau de Strings contenant la liste des clés de tri.
flags (String)	Une String contenant un ensemble d’indicateurs spécifiant le comportement du tri. Les indicateurs doivent être séparés par un semi-colon ou une comma.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

ModuleSortResult sort(String[] keys, ArrayList<String> flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys. Passé sous forme d’ArrayList.

Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres

Paramètres :

keys (String[])	Un tableau de Strings contenant la liste des clés de tri.
flags (ArrayList<String>)	Une liste de Strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.

ModuleSortResult sort(ArrayList<String> keys, String[] flags)

Trie le jeu de résultats en cours à l’aide des clés de tri dans keys.

Chaque clé de tri est un nom de colonne éventuellement précédé d’un + (pour un tri croissant) ou d’un - (pour un tri décroissant).

Paramètres

Paramètres :

keys (ArrayList<String>)	Une liste de Strings contenant la liste des clés de tri.
flags (String[])	Un tableau de Strings spécifiant le comportement du tri.

Retourne :

ModuleSortResult

Un objet ModuleSortResult. Si l'indicateur report n'a pas été spécifié, le résultat sera null.

Lancers :

IMuException

Si une erreur côté serveur s'est produite.