moving UuidAndTitleCache from model to persistence. #4799
[cdmlib.git] / cdmlib-services / src / main / java / eu / etaxonomy / cdm / api / service / INameService.java
index fb84bc3148b84cfe9b53eeea6c5604d45ed32e91..2bd7f350f7810725c4e79a6efb6adc5a3803826b 100644 (file)
@@ -27,24 +27,21 @@ import eu.etaxonomy.cdm.api.service.search.DocumentSearchResult;
 import eu.etaxonomy.cdm.api.service.search.SearchResult;\r
 import eu.etaxonomy.cdm.model.common.CdmBase;\r
 import eu.etaxonomy.cdm.model.common.Language;\r
-import eu.etaxonomy.cdm.model.common.OrderedTermVocabulary;\r
 import eu.etaxonomy.cdm.model.common.ReferencedEntityBase;\r
 import eu.etaxonomy.cdm.model.common.RelationshipBase;\r
-import eu.etaxonomy.cdm.model.common.TermVocabulary;\r
-import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;\r
 import eu.etaxonomy.cdm.model.name.HomotypicalGroup;\r
 import eu.etaxonomy.cdm.model.name.HybridRelationship;\r
 import eu.etaxonomy.cdm.model.name.HybridRelationshipType;\r
 import eu.etaxonomy.cdm.model.name.NameRelationship;\r
 import eu.etaxonomy.cdm.model.name.NameRelationshipType;\r
 import eu.etaxonomy.cdm.model.name.NomenclaturalStatus;\r
-import eu.etaxonomy.cdm.model.name.NomenclaturalStatusType;\r
 import eu.etaxonomy.cdm.model.name.NonViralName;\r
 import eu.etaxonomy.cdm.model.name.Rank;\r
 import eu.etaxonomy.cdm.model.name.SpecimenTypeDesignationStatus;\r
 import eu.etaxonomy.cdm.model.name.TaxonNameBase;\r
 import eu.etaxonomy.cdm.model.name.TypeDesignationBase;\r
 import eu.etaxonomy.cdm.persistence.dao.initializer.IBeanInitializer;\r
+import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;\r
 import eu.etaxonomy.cdm.persistence.query.MatchMode;\r
 import eu.etaxonomy.cdm.persistence.query.OrderHint;\r
 import eu.etaxonomy.cdm.strategy.cache.TaggedText;\r
@@ -58,7 +55,7 @@ public interface INameService extends IIdentifiableEntityService<TaxonNameBase>
         * If name is <code>null</code> this method has no effect.\r
         * @param name\r
         * @param config\r
-        * \r
+        *\r
         */\r
        public DeleteResult delete(TaxonNameBase name, NameDeletionConfigurator config);\r
 \r
@@ -157,18 +154,18 @@ public interface INameService extends IIdentifiableEntityService<TaxonNameBase>
         * @return\r
         */\r
        public List getNamesByName(String name, CdmBase sessionObject);\r
-       \r
+\r
        /**\r
         * Fuzzy matching for the taxon name elements. The input name is first atomised using the {@link NonViralNameParserImpl}\r
         * into its separate parts (genusOrUninomial,infraGenericEpithet,specificEpithet,infraGenericEpithet,authorshipCache).\r
         * Each field is then matched separately with the same accuracy parameter.\r
-        *  \r
+        *\r
         * @param name taxon name to fuzzy match\r
         * @param accuracy value > 0.0 and < 1.0 which determines the accuracy of the result.\r
         * @param languages list of languages to consider when matching (currently not used)\r
         * @param highlightFragments\r
-        * @param propertyPaths \r
-        * @param maxNoOfResults \r
+        * @param propertyPaths\r
+        * @param maxNoOfResults\r
         * @return\r
         * @throws CorruptIndexException\r
         * @throws IOException\r
@@ -178,22 +175,22 @@ public interface INameService extends IIdentifiableEntityService<TaxonNameBase>
             String name,\r
             float accuracy,\r
             List<Language> languages,\r
-            boolean highlightFragments, \r
+            boolean highlightFragments,\r
             List<String> propertyPaths,\r
             int maxNoOfResults) throws CorruptIndexException, IOException, ParseException;\r
-       \r
+\r
        /**\r
-        * Fuzzy matching for the taxon name elements using only the lucene index. \r
-        * \r
+        * Fuzzy matching for the taxon name elements using only the lucene index.\r
+        *\r
         * The input name is first atomised using the {@link NonViralNameParserImpl}\r
         * into its separate parts (genusOrUninomial,infraGenericEpithet,specificEpithet,infraGenericEpithet,authorshipCache).\r
         * Each field is then matched separately with the same accuracy parameter.\r
-        *  \r
+        *\r
         * @param name taxon name to fuzzy match\r
         * @param accuracy value > 0.0 and < 1.0 which determines the accuracy of the result.\r
         * @param languages list of languages to consider when matching (currently not used)\r
         * @param highlightFragments\r
-        * @param maxNoOfResults \r
+        * @param maxNoOfResults\r
         * @return\r
         * @throws CorruptIndexException\r
         * @throws IOException\r
@@ -203,18 +200,18 @@ public interface INameService extends IIdentifiableEntityService<TaxonNameBase>
             String name,\r
             float accuracy,\r
             List<Language> languages,\r
-            boolean highlightFragments, \r
+            boolean highlightFragments,\r
             int maxNoOfResults) throws CorruptIndexException, IOException, ParseException;\r
-    \r
+\r
        /**\r
-        * Fuzzy matching against the name cache using only the lucene index. \r
-        * \r
-        *  \r
+        * Fuzzy matching against the name cache using only the lucene index.\r
+        *\r
+        *\r
         * @param name taxon name to fuzzy match\r
         * @param accuracy value > 0.0 and < 1.0 which determines the accuracy of the result.\r
         * @param languages list of languages to consider when matching (currently not used)\r
         * @param highlightFragments\r
-        * @param maxNoOfResults \r
+        * @param maxNoOfResults\r
         * @return\r
         * @throws CorruptIndexException\r
         * @throws IOException\r
@@ -224,32 +221,32 @@ public interface INameService extends IIdentifiableEntityService<TaxonNameBase>
             String name,\r
             float accuracy,\r
             List<Language> languages,\r
-            boolean highlightFragments, \r
+            boolean highlightFragments,\r
             int maxNoOfResults) throws CorruptIndexException, IOException, ParseException;\r
-    \r
+\r
        /**\r
         * Exact matching for the taxon name elements using only the lucene index.\r
-        * \r
+        *\r
         * The input name is first atomised using the {@link NonViralNameParserImpl}\r
         * into its separate parts (genusOrUninomial,infraGenericEpithet,specificEpithet,infraGenericEpithet,authorshipCache).\r
         * Each field is then matched separately with the same accuracy parameter.\r
-        *  \r
+        *\r
         * @param name taxon name to fuzzy match\r
         * @param wildcard boolean flag to indicate whether a wildcard '*' should be added at the end of the query\r
         * @param languages list of languages to consider when matching (currently not used)\r
         * @param highlightFragments\r
-        * @param maxNoOfResults \r
+        * @param maxNoOfResults\r
         * @return\r
         * @throws CorruptIndexException\r
         * @throws IOException\r
         * @throws ParseException\r
         */\r
-    \r
+\r
     public List<DocumentSearchResult> findByNameExactSearch(\r
-            String name,      \r
+            String name,\r
             boolean wildcard,\r
             List<Language> languages,\r
-            boolean highlightFragments, \r
+            boolean highlightFragments,\r
             int maxNoOfResults) throws CorruptIndexException, IOException, ParseException;\r
 \r
        // TODO: Remove getNamesByName() methods. Use findNamesByTitle() instead.\r