|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface INameService
| Method Summary | |
|---|---|
UUID |
delete(TaxonNameBase name,
NameDeletionConfigurator config)
Deletes a name. |
void |
deleteTypeDesignation(TaxonNameBase name,
TypeDesignationBase typeDesignation)
Removes the given type designation from the given taxon name and deletes it from the database if it is not connected to any other name. |
Pager<TaxonNameBase> |
findByName(Class<? extends TaxonNameBase> clazz,
String queryString,
MatchMode matchmode,
List<org.hibernate.criterion.Criterion> criteria,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Return a Pager of names matching the given query string, optionally filtered by class, optionally with a particular MatchMode |
List<SearchResult<TaxonNameBase>> |
findByNameFuzzySearch(String name,
float accuracy,
List<Language> languages,
boolean highlightFragments,
List<String> propertyPaths,
int maxNoOfResults)
Fuzzy matching for the taxon name elements. |
HomotypicalGroup |
findHomotypicalGroup(UUID uuid)
Returns a homotypical group with the given UUID or null if not homotypical group exists with that UUID |
NonViralName |
findNameByUuid(UUID uuid,
List<String> propertyPaths)
Returns the NonViralName with the given UUID using the given match mode and initialization strategy |
List<NonViralName> |
findNamesByNameCache(String nameCache,
MatchMode matchMode,
List<String> propertyPaths)
Returns all NonViralNames with a name cache that matches the given string using the given match mode and initialization strategy |
List |
findNamesByTitle(String title)
|
List |
findNamesByTitle(String title,
CdmBase sessionObject)
|
List<NonViralName> |
findNamesByTitleCache(String titleCache,
MatchMode matchMode,
List<String> propertyPaths)
Returns all NonViralNames with a title cache that matches the given string using the given match mode and initialization strategy |
List<HomotypicalGroup> |
getAllHomotypicalGroups(int limit,
int start)
|
List<NomenclaturalStatus> |
getAllNomenclaturalStatus(int limit,
int start)
Returns all nomenclatural status. |
List<RelationshipBase> |
getAllRelationships(int limit,
int start)
Deprecated. |
List<TypeDesignationBase> |
getAllTypeDesignations(int limit,
int start)
Returns all type designations. |
Pager<HybridRelationship> |
getHybridNames(NonViralName name,
HybridRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Return a List of hybrids related to this name, optionally filtered by hybrid relationship type |
TermVocabulary<NameRelationshipType> |
getNameRelationshipTypeVocabulary()
Deprecated. use VocabularyService#getVocabulary(VocabularyEnum) instead |
List<TaxonNameBase> |
getNamesByName(String name)
|
List |
getNamesByName(String name,
CdmBase sessionObject)
|
List<NonViralName> |
getNamesByNameCache(String nameCache)
Returns all NonViralNames with a name cache that matches the given string |
OrderedTermVocabulary<Rank> |
getRankVocabulary()
Deprecated. use VocabularyService#getVocabulary(VocabularyEnum) instead, this is not possible since VocabularyService#getVocabulary(VocabularyEnum) is not returning a OrderedTermVocabulary !!! see also http://dev.e-taxonomy.eu/trac/ticket/3327 |
TermVocabulary<SpecimenTypeDesignationStatus> |
getSpecimenTypeDesignationStatusVocabulary()
Deprecated. use VocabularyService#getVocabulary(VocabularyEnum) instead |
OrderedTermVocabulary<SpecimenTypeDesignationStatus> |
getSpecimenTypeDesignationVocabulary()
Deprecated. use VocabularyService#getVocabulary(VocabularyEnum) instead |
TermVocabulary<NomenclaturalStatusType> |
getStatusTypeVocabulary()
Deprecated. use VocabularyService#getVocabulary(VocabularyEnum) instead |
List<TaggedText> |
getTaggedName(UUID uuid)
|
Pager<TypeDesignationBase> |
getTypeDesignations(TaxonNameBase name,
SpecimenTypeDesignationStatus status,
Integer pageSize,
Integer pageNumber)
Return a List of types related to this name, optionally filtered by type designation status |
Pager<TypeDesignationBase> |
getTypeDesignations(TaxonNameBase name,
SpecimenTypeDesignationStatus status,
Integer pageSize,
Integer pageNumber,
List<String> propertyPaths)
|
List<UuidAndTitleCache> |
getUuidAndTitleCacheOfNames()
Returns a map that holds uuid, titleCache pairs of all names in the current database |
List<NameRelationship> |
listFromNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Deprecated. use listNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead |
List<NameRelationship> |
listNameRelationships(TaxonNameBase name,
RelationshipBase.Direction direction,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Return a List of name relationships in which this name is related to another name, optionally filtered by relationship type |
List<NameRelationship> |
listToNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Deprecated. use listNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead |
Pager<NameRelationship> |
pageFromNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Deprecated. use pageNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead |
Pager<NameRelationship> |
pageNameRelationships(TaxonNameBase name,
RelationshipBase.Direction direction,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Return a List of name relationships in which this name is related to another name, optionally filtered by relationship type |
Pager<NameRelationship> |
pageToNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Deprecated. use pageNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead |
Map<UUID,HomotypicalGroup> |
saveAllHomotypicalGroups(Collection<HomotypicalGroup> homotypicalGroups)
Saves the given homotypical groups. |
Map<UUID,ReferencedEntityBase> |
saveReferencedEntitiesAll(Collection<ReferencedEntityBase> referencedEntityCollection)
|
Map<UUID,TypeDesignationBase> |
saveTypeDesignationAll(Collection<TypeDesignationBase> typeDesignationCollection)
Saves the given type designations. |
Pager<TaxonNameBase> |
search(Class<? extends TaxonNameBase> clazz,
String queryString,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Returns a Paged List of TaxonNameBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser) |
Pager<TaxonNameBase> |
searchNames(String uninomial,
String infraGenericEpithet,
String specificEpithet,
String infraspecificEpithet,
Rank rank,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
Returns a List of TaxonNameBase instances that match the properties passed |
| Methods inherited from interface eu.etaxonomy.cdm.api.service.IIdentifiableEntityService |
|---|
countByTitle, countByTitle, deduplicate, find, findByTitle, findByTitle, findTitleCache, getRights, getSourcedObjectByIdInSource, getSources, getUuidAndTitleCache, listByReferenceTitle, listByTitle, replace, updateTitleCache, updateTitleCache |
| Methods inherited from interface eu.etaxonomy.cdm.api.service.IAnnotatableService |
|---|
countMarkers, getAnnotations, getMarkers, groupMarkers |
| Methods inherited from interface eu.etaxonomy.cdm.api.service.IVersionableService |
|---|
getNextAuditEvent, getPreviousAuditEvent, pageAuditEvents, pageAuditEvents |
| Methods inherited from interface eu.etaxonomy.cdm.api.service.IService |
|---|
clear, count, delete, exists, find, find, find, findById, getSession, group, list, list, load, load, lock, merge, page, refresh, refresh, rows, save, save, saveOrUpdate, saveOrUpdate, update |
| Method Detail |
|---|
UUID delete(TaxonNameBase name,
NameDeletionConfigurator config)
throws ReferencedObjectUndeletableException
null this method has no effect.
name - config -
ReferencedObjectUndeletableException
void deleteTypeDesignation(TaxonNameBase name,
TypeDesignationBase typeDesignation)
typeDesignation is null all type designations are deleted
from the given taxon name. If name is null all names are removed from
the given type designation. If both are null nothing happens.
typeDesignation - name - Map<UUID,TypeDesignationBase> saveTypeDesignationAll(Collection<TypeDesignationBase> typeDesignationCollection)
typeDesignationCollection -
Map<UUID,ReferencedEntityBase> saveReferencedEntitiesAll(Collection<ReferencedEntityBase> referencedEntityCollection)
Map<UUID,HomotypicalGroup> saveAllHomotypicalGroups(Collection<HomotypicalGroup> homotypicalGroups)
homotypicalGroups -
List<NomenclaturalStatus> getAllNomenclaturalStatus(int limit,
int start)
limit - start -
List<TypeDesignationBase> getAllTypeDesignations(int limit,
int start)
limit - start -
List<TaxonNameBase> getNamesByName(String name)
name -
List<NonViralName> getNamesByNameCache(String nameCache)
name -
List<NonViralName> findNamesByTitleCache(String titleCache,
MatchMode matchMode,
List<String> propertyPaths)
name - matchMode - propertyPaths -
List<NonViralName> findNamesByNameCache(String nameCache,
MatchMode matchMode,
List<String> propertyPaths)
name - matchMode - propertyPaths -
NonViralName findNameByUuid(UUID uuid,
List<String> propertyPaths)
uuid - propertyPaths -
List getNamesByName(String name,
CdmBase sessionObject)
name - sessionObject - An object that is attached to the session before executing the query
List<SearchResult<TaxonNameBase>> findByNameFuzzySearch(String name,
float accuracy,
List<Language> languages,
boolean highlightFragments,
List<String> propertyPaths,
int maxNoOfResults)
throws org.apache.lucene.index.CorruptIndexException,
IOException,
org.apache.lucene.queryParser.ParseException
NonViralNameParserImpl
into its separate parts (genusOrUninomial,infraGenericEpithet,specificEpithet,infraGenericEpithet,authorshipCache).
Each field is then matched separately with the same accuracy parameter.
name - taxon name to fuzzy matchaccuracy - value > 0.0 and < 1.0 which determines the accuracy of the result.languages - list of languages to consider when matching (currently not used)highlightFragments - propertyPaths - maxNoOfResults -
org.apache.lucene.index.CorruptIndexException
IOException
org.apache.lucene.queryParser.ParseExceptionList findNamesByTitle(String title)
List findNamesByTitle(String title,
CdmBase sessionObject)
List<HomotypicalGroup> getAllHomotypicalGroups(int limit,
int start)
@Deprecated
List<RelationshipBase> getAllRelationships(int limit,
int start)
@Deprecated OrderedTermVocabulary<Rank> getRankVocabulary()
@Deprecated TermVocabulary<NomenclaturalStatusType> getStatusTypeVocabulary()
@Deprecated TermVocabulary<SpecimenTypeDesignationStatus> getSpecimenTypeDesignationStatusVocabulary()
@Deprecated OrderedTermVocabulary<SpecimenTypeDesignationStatus> getSpecimenTypeDesignationVocabulary()
@Deprecated TermVocabulary<NameRelationshipType> getNameRelationshipTypeVocabulary()
List<NameRelationship> listNameRelationships(TaxonNameBase name,
RelationshipBase.Direction direction,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
name - the name on either the "from side" or on the
"to side" of the relationship, depending on the
direction of the relationship.direction - the direction of the NameRelationship, may be null to return all relationshipstype - the relationship type (or null to return all relationships)pageSize - The maximum number of relationships returned (can be null for
all relationships)pageNumber - The offset (in pageSize chunks) from the start of the result
set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see
IBeanInitializer.initialize(Object, List)
Pager<NameRelationship> pageNameRelationships(TaxonNameBase name,
RelationshipBase.Direction direction,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
name - the name on the "from side" of the relationshipdirection - the direction of the NameRelationshiptype - the relationship type (or null to return all relationships)pageSize - The maximum number of relationships returned (can be null for all relationships)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)
@Deprecated
List<NameRelationship> listFromNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
listNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead
name - the name on the "from side" of the relationshiptype - the relationship type (or null to return all relationships)pageSize - The maximum number of relationships returned (can be null for all relationships)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)
@Deprecated
Pager<NameRelationship> pageFromNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
pageNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead
name - the name on the "from side" of the relationshiptype - the relationship type (or null to return all relationships)pageSize - The maximum number of relationships returned (can be null for all relationships)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)
@Deprecated
List<NameRelationship> listToNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
listNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead
name - the name on the "to side" of the relationshiptype - the relationship type (or null to return all relationships)pageSize - The maximum number of relationships returned (can be null for all relationships)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)
@Deprecated
Pager<NameRelationship> pageToNameRelationships(TaxonNameBase name,
NameRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
pageNameRelationships(TaxonNameBase, eu.etaxonomy.cdm.model.common.RelationshipBase.Direction, NameRelationshipType, Integer, Integer, List, List) instead
name - the name on the "to side" of the relationshiptype - the relationship type (or null to return all relationships)pageSize - The maximum number of relationships returned (can be null for all relationships)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)
Pager<HybridRelationship> getHybridNames(NonViralName name,
HybridRelationshipType type,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
name - the nametype - the hybrid relationship type (or null to return all hybrids)pageSize - The maximum number of hybrid relationships returned (can be null for all relationships)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)
Pager<TypeDesignationBase> getTypeDesignations(TaxonNameBase name,
SpecimenTypeDesignationStatus status,
Integer pageSize,
Integer pageNumber)
name - the namestatus - the type designation status (or null to return all types)pageSize - The maximum number of types returned (can be null for all types)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)
Pager<TypeDesignationBase> getTypeDesignations(TaxonNameBase name,
SpecimenTypeDesignationStatus status,
Integer pageSize,
Integer pageNumber,
List<String> propertyPaths)
Pager<TaxonNameBase> searchNames(String uninomial,
String infraGenericEpithet,
String specificEpithet,
String infraspecificEpithet,
Rank rank,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
uninomial - infraGenericEpithet - specificEpithet - infraspecificEpithet - rank - pageSize - The maximum number of names returned (can be null for all names)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - may be nullpropertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)
Pager<TaxonNameBase> search(Class<? extends TaxonNameBase> clazz,
String queryString,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
search in interface IIdentifiableEntityService<TaxonNameBase>clazz - filter the results by class (or pass null to return all TaxonNameBase instances)queryString - pageSize - The maximum number of names returned (can be null for all matching names)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)orderHints - Supports path like orderHints.propertyNames which
include *-to-one properties like createdBy.username or
authorTeam.persistentTitleCachepropertyPaths - properties to be initialized
List<UuidAndTitleCache> getUuidAndTitleCacheOfNames()
Map containing uuid and titleCache of names
Pager<TaxonNameBase> findByName(Class<? extends TaxonNameBase> clazz,
String queryString,
MatchMode matchmode,
List<org.hibernate.criterion.Criterion> criteria,
Integer pageSize,
Integer pageNumber,
List<OrderHint> orderHints,
List<String> propertyPaths)
clazz - filter by class - can be null to include all instances of type TqueryString - the query string to filter bymatchmode - use a particular type of matching (can be null - defaults to exact matching)criteria - additional criteria to filter bypageSize - The maximum number of objects returned (can be null for all objects)pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)propertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)orderHints - Supports path like orderHints.propertyNames which
include *-to-one properties like createdBy.username or
authorTeam.persistentTitleCache
HomotypicalGroup findHomotypicalGroup(UUID uuid)
uuid - the uuid of the homotypical group
List<TaggedText> getTaggedName(UUID uuid)
uuid -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||