Package fr.ifremer.isisfish.datastore

Class RegionStorage

java.lang.Object
fr.ifremer.isisfish.datastore.VersionStorage
fr.ifremer.isisfish.datastore.DataStorage
fr.ifremer.isisfish.datastore.RegionStorage
public class RegionStorage extends DataStorage
Classe permettant de recuperer les TopiaContext des regions. Created: 17 août 2005 03:44:57 CEST
Version:
$Revision$ Last update: $Date$ by : $Author$
Author:
Benjamin POUSSIN <poussin@codelutin.com>

  • Field Details

  • Constructor Details

    • RegionStorage

      protected RegionStorage(File directory, String name)
      Constructor.
      Parameters:
      directory - region directory
      name - region name

  • Method Details

    • addStorageListener

      public static void addStorageListener(StorageChangeListener storageListener)

    • getRegionDirectory

      public static File getRegionDirectory()

    • getRegionDirectory

      public static File getRegionDirectory(String name)

    • getCommentForNextCommit

      public String getCommentForNextCommit() throws IOException
      Returns:
      Returns the commentForNextCommit.
      Throws:
      IOException - if IO problem while reading file

    • setCommentForNextCommit

      public void setCommentForNextCommit(String commentForNextCommit) throws IOException
      Parameters:
      commentForNextCommit - The commentForNextCommit to set.
      Throws:
      IOException - if io problem while writing file

    • clearCommentForNextCommit

      public void clearCommentForNextCommit()
      rename commentForNextCommitFile with current date at end must be used in user application after commit

    • isVersionnableFile

      protected boolean isVersionnableFile(File file)
      Description copied from class: VersionStorage
      Permet de savoir si un fichier doit etre géré par le vcs ou non. L'implantation par defaut exclus les répertoires VCS, il faut toujours appeler le super si on surcharge la methode.
      Overrides:
      isVersionnableFile in class DataStorage
      Parameters:
      file - le fichier a tester
      Returns:
      true si le fichier est versionné

    • addCommentForNextCommit

      public void addCommentForNextCommit(String commentToAdd) throws IOException
      Add new comment in comment used for the next cvs commit. This comment is prefixed by the current date.
      Parameters:
      commentToAdd - the comment to add
      Throws:
      IOException - if IO problem while writing file

    • rename

      public void rename(String toName) throws StorageException
      Description copied from class: DataStorage
      Renome juste le repertoire, s'il y a besoin de modifier des données dans le TopiaContext il faut surcharger cette methode. Il est surement necessaire de surcharger cette methode pour aussi modifier l'entre qu'il y a dans le cache.
      Overrides:
      rename in class DataStorage
      Parameters:
      toName - le nouveau nom
      Throws:
      StorageException - si problème lors du renommage

    • getMapRepository

      public File getMapRepository()

    • checkout

      public static RegionStorage checkout(String name) throws VCSException, org.nuiton.topia.TopiaException
      Checkout not existing Region locally from server
      Parameters:
      name - name of region to retrieve
      Returns:
      le storage après checkout
      Throws:
      VCSException - if problem with vcs while checkout
      org.nuiton.topia.TopiaException - if problem while restoring db

    • getRegion

      public static RegionStorage getRegion(String name)
      Recupere le TopiaContext d'une region.
      Parameters:
      name - le nom de la region a recuperer
      Returns:
      Le TopiaContext contenant la region, si la region n'existait null est retourné

    • exists

      public static boolean exists(String name)
      Verifie si la region exists en local ou sur le serveur CVS.
      Parameters:
      name - le nom de la region
      Returns:
      vrai si la region existe deja

    • create

      public static RegionStorage create(String name) throws StorageException
      Permet de creer une nouvelle region. Si le nom est deja utilisé en local ou sur le serveur alors une exception est leve. Sinon le repertoire pour accueillir la region est cree.
      Parameters:
      name - Le nom de la nouvelle region
      Returns:
      La nouvelle region
      Throws:
      StorageException - Si le nom est deja uitlisé

    • delete

      public void delete(boolean cvsDelete) throws StorageException
      Description copied from class: VersionStorage
      Permet de supprimer un fichier ou répertoire versionné ou non.
      Overrides:
      delete in class DataStorage
      Parameters:
      cvsDelete - si vrai alors le fichier sera aussi supprimé sur le vcs si elle existait. Cela prend effet immediatement (un commit est fait)
      Throws:
      StorageException - if delete operation fail

    • getRegionNames

      public static List<String> getRegionNames()
      Retourne la liste des noms de toutes les régions disponible en local.
      Returns:
      la liste des noms de toutes les régions disponible en local

    • getRegions

      public static List<RegionStorage> getRegions()
      Retourne la liste de toutes les régions disponible en local.
      Returns:
      la liste de toutes les régions disponible en local

    • getNewRegionNames

      public static List<String> getNewRegionNames()
      Retourne la liste des noms de toutes les régions disponible en local qui ne sont pas encore sur le serveur VCS.
      Returns:
      liste de noms de regions

    • getRemoteRegionNames

      public static List<String> getRemoteRegionNames()
      Retourne la liste des noms de toutes les régions disponible sur le serveur VCS.
      Returns:
      la liste des noms de toutes les régions disponible sur le serveur VCS. Si le serveur n'est pas disponible la liste retournée est vide.

    • getNewRemoteRegionNames

      public static List<String> getNewRemoteRegionNames()
      Retourne la liste des noms de toutes les régions disponible sur le serveur VCS qui ne sont pas encore en local.
      Returns:
      liste de noms de regions

    • getFisheryRegion

      public static FisheryRegion getFisheryRegion(org.nuiton.topia.TopiaContext context) throws StorageException
      Throws:
      StorageException

    • importZip

      public static RegionStorage importZip(File file) throws IOException, StorageException, RegionAlreadyExistException
      Import zipped region.
      Parameters:
      file - zipped region file
      Returns:
      region storage or null
      Throws:
      IOException - if IO problem while import zip
      RegionAlreadyExistException - if problem while restoring db
      StorageException

    • importAndRenameZip

      public static RegionStorage importAndRenameZip(File file, String newName) throws IOException, RegionAlreadyExistException, StorageException
      Import zipped region.
      Parameters:
      file - zipped region file
      newName - new name for the imported simulation
      Returns:
      region storage or null
      Throws:
      IOException - if IO problem while import zip
      RegionAlreadyExistException - if problem while restoring db
      StorageException