cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/taxon/ITaxonomicTreeDao.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.persistence.dao.taxon;
  11
  12 import java.util.List;
  13
  14 import eu.etaxonomy.cdm.model.name.Rank;
  15 import eu.etaxonomy.cdm.model.taxon.TaxonNode;
  16 import eu.etaxonomy.cdm.model.taxon.TaxonomicTree;
  17 import eu.etaxonomy.cdm.persistence.dao.common.IIdentifiableDao;
  18
  19 /**
  20  * @author a.mueller
  21  *
  22  */
  23 public interface ITaxonomicTreeDao extends IIdentifiableDao<TaxonomicTree> {
  24
  25         /**
  26          * Loads all TaxonNodes of the specified tree for a given Rank.
  27          * If a branch does not contain a TaxonNode with a TaxonName at the given
  28          * Rank the node associated with the next lower Rank is taken as root node.
  29          * If the <code>rank</code> is null the absolute root nodes will be returned.
  30          *
  31          * @param taxonomicTree
  32          * @param rank may be null
  33          * @param propertyPaths
  34          * @return
  35          */
  36         public List<TaxonNode> loadRankSpecificRootNodes(TaxonomicTree taxonomicTree, Rank rank, List<String> propertyPaths);
  37
  38 }