cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IFeatureTreeService.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.api.service;
  11
  12 import java.util.Collection;
  13 import java.util.List;
  14 import java.util.Map;
  15 import java.util.UUID;
  16
  17 import eu.etaxonomy.cdm.model.description.FeatureNode;
  18 import eu.etaxonomy.cdm.model.description.FeatureTree;
  19
  20 public interface IFeatureTreeService extends IIdentifiableEntityService<FeatureTree> {
  21
  22         public List<FeatureNode> getFeatureNodesAll();
  23
  24         /**
  25          * Loads a feature tree including all of its nodes (all the way down to the tips of the tree).
  26          * Because this method automatically adds feature nodes recursively, adding "root" to property paths
  27          * is supurfluous - the propertyPaths argument should be used to initialize property paths <i>in addition</i>
  28          * to the feature nodes. The nodePaths argument is applied to each node in turn, so again, adding "children"
  29          * is also supurfluous. The nodePaths argument should be used to specify additional propertys of the featureNode
  30          * to initialize (e.g. feature).
  31          *
  32          */
  33         public FeatureTree loadWithNodes(UUID uuid, List<String> propertyPaths, List<String> nodePaths);
  34
  35         public Map<UUID, FeatureNode> saveFeatureNodesAll(Collection<FeatureNode> featureNodeCollection);
  36
  37         public Map<UUID, FeatureNode> saveOrUpdateFeatureNodesAll(Collection<FeatureNode> featureNodeCollection);
  38
  39         public FeatureTree createTransientDefaultFeatureTree();
  40 }