opale
Class OpaleSession

java.lang.Object
  |
  +--opale.OpaleSession
Direct Known Subclasses:
ODE, Pack2D

public class OpaleSession
extends java.lang.Object

Cette classe encapsule des objets Opale. De plus elle attribue à chacune de ces instances des identificateurs (sous forme de String) et elle permet de sauvegarder ou de relire des fichiers de données écrits dans un language utilisateur.

Since:
Opale V1b5

Constructor Summary
OpaleSession()
          Constructeur par défaut.
 
Method Summary
 int add(OpaleObject ob, java.lang.String s)
          Ajoute un objet à la liste si l'id est libre et l'objet non déjà inséré.
 void clean()
          Nettoie l'instance courante en la vidant des objets.
 boolean contains(OpaleObject o)
          Teste si l'objet passé en paramètre est déjà stocké.
 boolean contains(java.lang.String s)
          Teste si la chaine passée en paramètre est un identificateur utilisé.
 OpaleObject fromId(java.lang.String id)
          Renvoie un objet à partir de son identificateur.
 java.lang.String getId(OpaleObject obj)
          Renvoie l'identificateur d'un objet.
 java.lang.String getLinearId()
          Renvoie un id construit automatiquement du style "obj_n" où n est le nombre d'élément+1.
 java.lang.String getNameObject(java.lang.String username)
          Renvoie le nom de la classe d'un objet OpaleObject à partir de son nom utilisateur.
 OpaleObject getObject(int i)
          Renvoie l'element à la position spécifiée dans le vecteur.
 OpaleObject getObject(java.lang.String name)
          Renvoie l'element à à partir de son identificateur.
 java.lang.String getUserName(java.lang.String objname)
          Renvoie le nom utilisateur d'une classe d'un objet Object à partir de son nom de classe en Java.
 java.lang.String[] getUserNameObject()
          Renvoie un tableau de String qui contient tous les noms utilisateurs des objets graphiques.
 void intoTab(java.lang.Object[] tab)
          Copie la liste d'objets dans un tableau.
 void read(java.io.StreamTokenizer f)
          Lit dans un fichier une liste d'objets.
 int remove(OpaleObject obj)
          Supprime un objet de type Equation, probleme ou TimeScheme.
 int size()
          Retourne la taille de la liste des objets.
 void write(java.io.PrintWriter f)
          Ecrit dans un flux le contenu de cette classe.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OpaleSession

public OpaleSession()
Constructeur par défaut. Ce constructeur va chercher la ressource "list_object.cfg" afin de résoudre les noms utilisateurs donnés aux classes des objets graphiques. Si ce fichier est introuvable, le programme sort en erreur.
Method Detail

clean

public void clean()
Nettoie l'instance courante en la vidant des objets.

remove

public int remove(OpaleObject obj)
Supprime un objet de type Equation, probleme ou TimeScheme.
Parameters:
OpaleObject - obj, l'objet à supprimer.
Returns:
int, -1 si addition impossible, 0 sinon.

add

public int add(OpaleObject ob,
               java.lang.String s)
Ajoute un objet à la liste si l'id est libre et l'objet non déjà inséré.
Parameters:
OpaleObject - ob, l'objet à ajouter.
String - s, l'id de l'objet.
Returns:
int, -1 si addition impossible, 0 sinon.

getObject

public OpaleObject getObject(int i)
Renvoie l'element à la position spécifiée dans le vecteur.
Parameters:
int - i la position de l'objet à retourner.
Returns:
OpaleObject, l'objet retourné

getObject

public OpaleObject getObject(java.lang.String name)
Renvoie l'element à à partir de son identificateur.
Parameters:
String - name, l'identificateur.
Returns:
OpaleObject, l'objet retourné
Since:
Opâle-ODE 0.11

size

public int size()
Retourne la taille de la liste des objets.
Returns:
int, le nombre d'objets dans la liste.

intoTab

public void intoTab(java.lang.Object[] tab)
Copie la liste d'objets dans un tableau.
Parameters:
Object[] - tab, le tableau qui contiendra les objets.

getUserNameObject

public java.lang.String[] getUserNameObject()
Renvoie un tableau de String qui contient tous les noms utilisateurs des objets graphiques.
Returns:
String[] le tableau de noms.

getNameObject

public java.lang.String getNameObject(java.lang.String username)
Renvoie le nom de la classe d'un objet OpaleObject à partir de son nom utilisateur.
Parameters:
String - le nom utilisateur.
Returns:
String le nom de la classe.

getUserName

public java.lang.String getUserName(java.lang.String objname)
Renvoie le nom utilisateur d'une classe d'un objet Object à partir de son nom de classe en Java.
Parameters:
String - le nom de la classe.
Returns:
String le nom utilisateur.

getId

public java.lang.String getId(OpaleObject obj)
Renvoie l'identificateur d'un objet.
Parameters:
OpaleObject, - un objet.
Returns:
String, l'identificateur correspondant.

getLinearId

public java.lang.String getLinearId()
Renvoie un id construit automatiquement du style "obj_n" où n est le nombre d'élément+1.
Returns:
String, l'id généré.

contains

public boolean contains(java.lang.String s)
Teste si la chaine passée en paramètre est un identificateur utilisé.
Parameters:
String - id, la chaine a tester.
Returns:
boolean, true si utilisé, false sinon.

contains

public boolean contains(OpaleObject o)
Teste si l'objet passé en paramètre est déjà stocké.
Parameters:
OpaleObject, - l'objet à tester.
Returns:
boolean, true si utilisé, false sinon.

fromId

public OpaleObject fromId(java.lang.String id)
Renvoie un objet à partir de son identificateur.
Parameters:
String, - l'identificateur correspondant.
Returns:
OpaleObject, null si l'identificateur ne correspond à aucun objet ; l'objet sinon..

read

public void read(java.io.StreamTokenizer f)
          throws InvalidFormatException
Lit dans un fichier une liste d'objets.
Parameters:
StreamTokenizer - f, le fichier à lire.

write

public void write(java.io.PrintWriter f)
           throws InvalidFormatException
Ecrit dans un flux le contenu de cette classe.
Parameters:
PrintWriter - f, le fichier dans lequel on veut ecrire.