cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/ILocationService.java

   1 /**
   2 * Copyright (C) 2007 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.api.service;
  11
  12 import java.util.List;
  13
  14 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
  15 import eu.etaxonomy.cdm.model.common.OrderedTermVocabulary;
  16 import eu.etaxonomy.cdm.model.common.TermVocabulary;
  17 import eu.etaxonomy.cdm.model.description.PresenceAbsenceTerm;
  18 import eu.etaxonomy.cdm.model.location.NamedArea;
  19 import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
  20 import eu.etaxonomy.cdm.model.location.NamedAreaType;
  21
  22 /**
  23  * @author n.hoffman
  24  * @since 08.04.2009
  25  * @version 1.0
  26  */
  27 public interface ILocationService extends IService<DefinedTermBase> {
  28
  29
  30         public static enum NamedAreaVocabularyType{
  31                 TDWG_AREA, COUNTRY, WATERBODY, CONTINENT
  32         }
  33
  34     /**
  35      * Returns a list of NamedArea Types "TDWG Areas", "ISO Country Codes"
  36      *
  37      * @return
  38      */
  39     public List<NamedAreaVocabularyType> getNamedAreaVocabularyTypes();
  40
  41     /**
  42      *  - these would be top-level areas for nested area vocabularies, e.g. North America and Europe, but NOT USA, Germany - alternatively:
  43      *
  44      * @param vocabularyType
  45      * @return
  46      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  47      */
  48     public OrderedTermVocabulary<NamedArea> getNamedAreaVocabulary(NamedAreaVocabularyType vocabularyType);
  49
  50     /**
  51      *
  52      * @return
  53      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  54      */
  55     public TermVocabulary<NamedAreaType> getNamedAreaTypeVocabulary();
  56
  57     /**
  58      * @return
  59      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  60      */
  61     public OrderedTermVocabulary<NamedAreaLevel> getNamedAreaLevelVocabulary();
  62
  63     /**
  64      *
  65      * @return
  66      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  67      */
  68     public OrderedTermVocabulary<PresenceAbsenceTerm> getPresenceAbsenceTermVocabulary();
  69
  70     /**
  71      *
  72      */
  73     public List<NamedArea> getTopLevelNamedAreasByVocabularyType(NamedAreaVocabularyType vocabularyType);
  74 }