cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/common/IOriginalSourceDao.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.common;
  11
  12 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
  13 import eu.etaxonomy.cdm.model.common.OriginalSourceBase;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.Set;
  17
  18 import eu.etaxonomy.cdm.model.common.ISourceable;
  19 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
  20 import eu.etaxonomy.cdm.model.common.OriginalSourceBase;
  21
  22
  23 public interface IOriginalSourceDao extends ICdmEntityDao<OriginalSourceBase>{
  24
  25
  26         /**
  27          * Returns a map of identifiable entities of class <code>clazz</code> which have an original source of
  28          * with namespace <code>idNamespace</code> and with an idInSource in <code>idInSourceList</code> <BR>
  29          * The key of the map is the idInSource. If there are multiple objects that have the same id an arbitrary one is chosen.
  30          * @param clazz
  31          * @param idInSourceList
  32          * @param idNamespace
  33          * @return
  34          */
  35         public Map<String, ISourceable> findOriginalSourcesByIdInSource(Class clazz, Set<String> idInSourceSet, String idNamespace);
  36
  37
  38         /**
  39          * Returns a list of identifiable entities according to their class, idInSource and idNamespace
  40          * @param clazz
  41          * @param idInSource
  42          * @param idNamespace
  43          * @return
  44          */
  45         public List<IdentifiableEntity> findOriginalSourceByIdInSource(Class clazz, String idInSource, String idNamespace);
  46
  47         /**
  48          * Returns the first OriginalSource with according idInSource and idNamespace
  49          * @param idInSource
  50          * @param idNamespace
  51          * @return
  52          */
  53         public List<OriginalSourceBase> findOriginalSourceByIdInSource(String idInSource, String idNamespace);
  54
  55
  56 }