cds.simbad.ident
Class Catalog

java.lang.Object
  extended bycds.simbad.ident.Catalog
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
CatalogFull

public class Catalog
extends java.lang.Object
implements java.io.Serializable

Classe contenant les infos provenant du fichier de description le nom standard du catalogue, la liste des pgm rencontre, la liste des exemples, la description

See Also:
Serialized Form

Field Summary
protected  java.lang.String description
           
protected  java.lang.String otype
           
protected  java.util.ArrayList pgmList
           
protected  java.util.ArrayList reList
           
protected  int size
           
protected  java.lang.String stdName
           
 
Constructor Summary
Catalog(java.lang.String stdName)
           
 
Method Summary
 void addExample(java.lang.String example)
          adds a example.
 void addFormat(java.lang.String fmt)
          adds a format.
 void addPgm(Pgm pgm)
          Add a programme to the catalogue
 void addSynonym(java.lang.String syn)
          adds a synonym.
 void addVersion(java.lang.String version)
          adds a version definition.
 void clearExamples()
          clears the list of examples.
 void clearFormats()
          clears the list of formats.
 void clearSynonyms()
          clears the list of synonyms.
 void clearVersions()
          clears the list of versions.
 boolean equals(java.lang.Object o)
          MOD-BB 21-01-04 Ajout de cette methode.
 java.lang.String getComment()
          returns the comment associated with the catalogue
 java.lang.String getDescription()
          return the catalogue description
 java.lang.String[] getExamples()
          returns a String array with all the examples.
 java.lang.String[] getFormats()
          returns a String array with all the formats.
 java.lang.String getName()
          return the standard name of the catalogue
 java.lang.String getOType()
          return the object type
 Pgm getPgm(int index)
          Returns the Program specified by its index
 Pgm[] getPgmList()
          Returns the array of the programs for this catalogue
 int getSize()
          return the size of this catalogue.
 java.lang.String[] getSynonyms()
          returns a String array with all the synonyms.
 java.lang.String[] getVersions()
          returns a String array with all the versions.
 void setComment(java.lang.String comment)
          adds a general comment.
 void setDescription(java.lang.String descr)
          Sets the description text for the catalogue
 void setName(java.lang.String name)
          sets the standard name of the catalogue
 void setOType(java.lang.String otype)
          Sets the object type for this catalogue
 void setSize(int size)
          Sets the size of this catalogue
 java.util.ArrayList toRE()
          Returns the list of all regular expressions derived from the programmes.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

stdName

protected java.lang.String stdName

description

protected java.lang.String description

otype

protected java.lang.String otype

size

protected int size

pgmList

protected java.util.ArrayList pgmList

reList

protected java.util.ArrayList reList
Constructor Detail

Catalog

public Catalog(java.lang.String stdName)
Method Detail

addPgm

public void addPgm(Pgm pgm)
Add a programme to the catalogue

Parameters:
pgm - Normalisation programme to add

setName

public void setName(java.lang.String name)
sets the standard name of the catalogue

Parameters:
name - standard name of the catalogue

getName

public java.lang.String getName()
return the standard name of the catalogue

Returns:
the standard name

setDescription

public void setDescription(java.lang.String descr)
Sets the description text for the catalogue

Parameters:
descr - catalogue short description

getDescription

public java.lang.String getDescription()
return the catalogue description

Returns:
the catalogue description

setOType

public void setOType(java.lang.String otype)
Sets the object type for this catalogue

Parameters:
otype - object type

getOType

public java.lang.String getOType()
return the object type

Returns:
the object type

setSize

public void setSize(int size)
Sets the size of this catalogue

Parameters:
size - number of object of this catalogue

getSize

public int getSize()
return the size of this catalogue. This number of objects is given 'by hand'. It is not an actual value extracted from the database.

Returns:
the catalogue size (number of objects)

getPgm

public Pgm getPgm(int index)
Returns the Program specified by its index

Parameters:
index - of the programme to return
Returns:
programme at the given index or null

getPgmList

public Pgm[] getPgmList()
Returns the array of the programs for this catalogue

Returns:
the Pgm object array

toString

public java.lang.String toString()

toRE

public java.util.ArrayList toRE()
Returns the list of all regular expressions derived from the programmes. If not yet done, the list is first created.

Returns:
the ArrayList of all regular expressions building the programme (?)

clearFormats

public void clearFormats()
clears the list of formats. This method does nothing. See CatalogFull


addFormat

public void addFormat(java.lang.String fmt)
adds a format. This method does nothing. See CatalogFull

Parameters:
fmt - format

getFormats

public java.lang.String[] getFormats()
returns a String array with all the formats.

Returns:
always null. See CatalogFull

clearExamples

public void clearExamples()
clears the list of examples. This method does nothing. See CatalogFull


addExample

public void addExample(java.lang.String example)
adds a example. This method does nothing. See CatalogFull

Parameters:
example - example to add

getExamples

public java.lang.String[] getExamples()
returns a String array with all the examples.

Returns:
always null. See CatalogFull

clearSynonyms

public void clearSynonyms()
clears the list of synonyms. This method does nothing. See CatalogFull


addSynonym

public void addSynonym(java.lang.String syn)
adds a synonym. This method does nothing. See CatalogFull

Parameters:
syn - synonym to add

getSynonyms

public java.lang.String[] getSynonyms()
returns a String array with all the synonyms.

Returns:
always null. See CatalogFull

clearVersions

public void clearVersions()
clears the list of versions. This method does nothing. See CatalogFull


addVersion

public void addVersion(java.lang.String version)
adds a version definition. This method does nothing. See CatalogFull

Parameters:
version - version to add

getVersions

public java.lang.String[] getVersions()
returns a String array with all the versions.

Returns:
always null. See CatalogFull

setComment

public void setComment(java.lang.String comment)
adds a general comment. This method does nothing. See CatalogFull

Parameters:
comment - comment to add

getComment

public java.lang.String getComment()
returns the comment associated with the catalogue

Returns:
always null. See CatalogFull

equals

public boolean equals(java.lang.Object o)
MOD-BB 21-01-04 Ajout de cette methode. Test d'egalite de Catalog.

Parameters:
o - Objet a comparer.
Returns:
Vrai si o est identique a this, faux sinon.