cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/init/ITermInitializer.java

   1 /**
   2 * Copyright (C) 2009 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.cdm.model.common.init;
  11
  12
  13 /**
  14  *  Terms, vocabularies, and representations loaded during termloading by class TermLoader added
  15  *  by the user maybe stored and accessed through this interface.
  16  *  Care must be taken as TermLoader indirectly calls getTermByUuid(uuid) for the default
  17  *  language uuid during the loading process. So make sure that initialize() and getTermByUuid(uuid)
  18  *  are not implemeted in an endless recursion!
  19  *
  20  * @author a.mueller
  21  *
  22  */
  23 public interface ITermInitializer {
  24
  25         /** Initializes the IVocabularStore by making sure that all basic terms that are
  26          * loaded by the TermLoader are available afterwards.
  27          * ATTENTION: Be aware that TermLoader indirectly calls getTermByUuid(uuid)
  28          * for the default language. So make sure that before loading the Terms by the
  29          * TermLoader getTermByUuid() returns a valid Object without going to endless recursion.
  30          * @return true if terms where successfully loaded
  31          */
  32         public void initialize();
  33
  34 }