Project

General

Profile

« Previous | Next » 

Revision 9dc896c9

Added by Andreas Müller almost 7 years ago

fix #6368 rename table and class TaxonNameBase

View differences:

cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/INameService.java
37 37
import eu.etaxonomy.cdm.model.name.NomenclaturalStatus;
38 38
import eu.etaxonomy.cdm.model.name.Rank;
39 39
import eu.etaxonomy.cdm.model.name.SpecimenTypeDesignationStatus;
40
import eu.etaxonomy.cdm.model.name.TaxonNameBase;
40
import eu.etaxonomy.cdm.model.name.TaxonName;
41 41
import eu.etaxonomy.cdm.model.name.TypeDesignationBase;
42 42
import eu.etaxonomy.cdm.persistence.dao.initializer.IBeanInitializer;
43 43
import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
......
46 46
import eu.etaxonomy.cdm.strategy.cache.TaggedText;
47 47
import eu.etaxonomy.cdm.strategy.parser.NonViralNameParserImpl;
48 48

  
49
public interface INameService extends IIdentifiableEntityService<TaxonNameBase> {
49
public interface INameService extends IIdentifiableEntityService<TaxonName> {
50 50

  
51 51
	/**
52 52
	 * Deletes a name. Depening on the configurator state links to the name will either be
......
68 68
	 * @param name
69 69
	 * @return
70 70
	 */
71
	public DeleteResult deleteTypeDesignation(TaxonNameBase name, TypeDesignationBase typeDesignation);
71
	public DeleteResult deleteTypeDesignation(TaxonName name, TypeDesignationBase typeDesignation);
72 72

  
73 73
	/**
74 74
	 * Removes the given type designation from the given taxon name and deletes it from
......
120 120
	 * @param name
121 121
	 * @return
122 122
	 */
123
	public List<TaxonNameBase> getNamesByNameCache(String nameCache);
123
	public List<TaxonName> getNamesByNameCache(String nameCache);
124 124

  
125 125
	/**
126 126
	 * Returns all NonViralNames with a title cache that matches the given string
......
131 131
	 * @param propertyPaths
132 132
	 * @return
133 133
	 */
134
	public List<TaxonNameBase> findNamesByTitleCache(String titleCache, MatchMode matchMode, List<String> propertyPaths);
134
	public List<TaxonName> findNamesByTitleCache(String titleCache, MatchMode matchMode, List<String> propertyPaths);
135 135

  
136 136
	/**
137 137
	 * Returns all NonViralNames with a name cache that matches the given string
......
142 142
	 * @param propertyPaths
143 143
	 * @return
144 144
	 */
145
	public List<TaxonNameBase> findNamesByNameCache(String nameCache, MatchMode matchMode, List<String> propertyPaths);
145
	public List<TaxonName> findNamesByNameCache(String nameCache, MatchMode matchMode, List<String> propertyPaths);
146 146

  
147 147
	/**
148 148
	 * @param name
......
167 167
	 * @throws IOException
168 168
	 * @throws ParseException
169 169
	 */
170
	public List<SearchResult<TaxonNameBase>> findByNameFuzzySearch(
170
	public List<SearchResult<TaxonName>> findByNameFuzzySearch(
171 171
            String name,
172 172
            float accuracy,
173 173
            List<Language> languages,
......
278 278
	 *            {@link IBeanInitializer#initialize(Object, List)}
279 279
	 * @return a Pager of NameRelationship instances
280 280
	 */
281
	public List<NameRelationship> listNameRelationships(TaxonNameBase name,  NameRelationship.Direction direction, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
281
	public List<NameRelationship> listNameRelationships(TaxonName name,  NameRelationship.Direction direction, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
282 282

  
283 283
	/**
284 284
	 * Return a List of name relationships in which this name is related to another name, optionally filtered
......
293 293
	 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
294 294
	 * @return a Pager of NameRelationship instances
295 295
	 */
296
	public Pager<NameRelationship> pageNameRelationships(TaxonNameBase name,  NameRelationship.Direction direction, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
296
	public Pager<NameRelationship> pageNameRelationships(TaxonName name,  NameRelationship.Direction direction, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
297 297

  
298 298
	/**
299 299
	 * Return a List of relationships in which this name is related to another name, optionally filtered
......
306 306
	 * @param orderHints may be null
307 307
	 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
308 308
	 * @return a Pager of NameRelationship instances
309
	 * @deprecated use {@link #listNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
309
	 * @deprecated use {@link #listNameRelationships(TaxonName, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
310 310
	 */
311 311
	@Deprecated
312
	public List<NameRelationship> listFromNameRelationships(TaxonNameBase name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
312
	public List<NameRelationship> listFromNameRelationships(TaxonName name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
313 313

  
314 314
	/**
315 315
	 * Return a List of relationships in which this name is related to another name, optionally filtered
......
322 322
	 * @param orderHints may be null
323 323
	 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
324 324
	 * @return a Pager of NameRelationship instances
325
	 * @deprecated use {@link #pageNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
325
	 * @deprecated use {@link #pageNameRelationships(TaxonName, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
326 326
	 */
327 327
	@Deprecated
328
	public Pager<NameRelationship> pageFromNameRelationships(TaxonNameBase name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
328
	public Pager<NameRelationship> pageFromNameRelationships(TaxonName name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
329 329

  
330 330
	/**
331 331
	 * Return a List of relationships in which another name is related to this name, optionally filtered
......
338 338
	 * @param orderHints may be null
339 339
	 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
340 340
	 * @return a Pager of NameRelationship instances
341
	 * @deprecated use {@link #listNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
341
	 * @deprecated use {@link #listNameRelationships(TaxonName, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
342 342
	 */
343 343
	@Deprecated
344
	public List<NameRelationship> listToNameRelationships(TaxonNameBase name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
344
	public List<NameRelationship> listToNameRelationships(TaxonName name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
345 345

  
346 346
	/**
347 347
	 * Return a List of relationships in which another name is related to this name, optionally filtered
......
354 354
	 * @param orderHints may be null
355 355
	 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
356 356
	 * @return a Pager of NameRelationship instances
357
	 * @deprecated use {@link #pageNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
357
	 * @deprecated use {@link #pageNameRelationships(TaxonName, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List)} instead
358 358
	 */
359 359
	@Deprecated
360
	public Pager<NameRelationship> pageToNameRelationships(TaxonNameBase name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
360
	public Pager<NameRelationship> pageToNameRelationships(TaxonName name,  NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
361 361

  
362 362

  
363 363
	/**
......
384 384
	 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
385 385
	 * @return a Pager of TypeDesignationBase instances
386 386
	 */
387
	public Pager<TypeDesignationBase> getTypeDesignations(TaxonNameBase name,
387
	public Pager<TypeDesignationBase> getTypeDesignations(TaxonName name,
388 388
			SpecimenTypeDesignationStatus status, Integer pageSize, Integer pageNumber);
389 389

  
390
	public Pager<TypeDesignationBase> getTypeDesignations(TaxonNameBase name,
390
	public Pager<TypeDesignationBase> getTypeDesignations(TaxonName name,
391 391
			SpecimenTypeDesignationStatus status, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
392 392

  
393 393

  
394 394
	/**
395
	 * Returns a List of TaxonNameBase instances that match the properties passed
395
	 * Returns a List of TaxonName instances that match the properties passed
396 396
	 *
397 397
	 * @param uninomial
398 398
	 * @param infraGenericEpithet
......
403 403
	 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
404 404
	 * @param orderHints may be null
405 405
	 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
406
	 * @return a Pager of TaxonNameBase instances
406
	 * @return a Pager of TaxonName instances
407 407
	 */
408
	public Pager<TaxonNameBase> searchNames(String uninomial, String infraGenericEpithet, String specificEpithet, String infraspecificEpithet, Rank rank, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
408
	public Pager<TaxonName> searchNames(String uninomial, String infraGenericEpithet, String specificEpithet, String infraspecificEpithet, Rank rank, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
409 409

  
410 410
	/**
411
	 * Returns a Paged List of TaxonNameBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
411
	 * Returns a Paged List of TaxonName instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
412 412
	 *
413
	 * @param clazz filter the results by class (or pass null to return all TaxonNameBase instances)
413
	 * @param clazz filter the results by class (or pass null to return all TaxonName instances)
414 414
	 * @param queryString
415 415
	 * @param pageSize The maximum number of names returned (can be null for all matching names)
416 416
	 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
......
419 419
	 *            include *-to-one properties like createdBy.username or
420 420
	 *            authorTeam.persistentTitleCache
421 421
	 * @param propertyPaths properties to be initialized
422
	 * @return a Pager TaxonNameBase instances
422
	 * @return a Pager TaxonName instances
423 423
	 * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
424 424
	 */
425 425
	@Override
426
    public Pager<TaxonNameBase> search(Class<? extends TaxonNameBase> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
426
    public Pager<TaxonName> search(Class<? extends TaxonName> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
427 427

  
428 428
	/**
429 429
	 * Returns a map that holds uuid, titleCache pairs of all names in the current database
......
449 449
	 *            authorTeam.persistentTitleCache
450 450
	 * @return a paged list of instances of type T matching the queryString
451 451
	 */
452
    public Pager<TaxonNameBase> findByName(Class<? extends TaxonNameBase> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
452
    public Pager<TaxonName> findByName(Class<? extends TaxonName> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
453 453

  
454 454
    /**
455 455
     * Returns a homotypical group with the given UUID or null if not homotypical group exists with that UUID

Also available in: Unified diff