eu.etaxonomy.cdm.persistence.dao.name
Interface ITaxonNameDao

All Superinterfaces:

IAnnotatableDao<TaxonNameBase>, ICdmEntityDao<TaxonNameBase>, IIdentifiableDao<TaxonNameBase>, ISearchableDao<TaxonNameBase>, ITitledDao<TaxonNameBase>, IVersionableDao<TaxonNameBase>

All Known Implementing Classes:

TaxonNameDaoHibernateImpl

public interface ITaxonNameDao
extends IIdentifiableDao<TaxonNameBase>

Author:

a.mueller

Method Summary

Integer	countByName(Class<? extends TaxonNameBase> clazz, String queryString, MatchMode matchmode, List<org.hibernate.criterion.Criterion> criteria)
Integer	countByName(String queryString, MatchMode matchmode, List<org.hibernate.criterion.Criterion> criteria)
int	countHybridNames(NonViralName name, HybridRelationshipType type) Return a count of hybrids related to this name, optionally filtered by hybrid relationship type
int	countNameRelationships(TaxonNameBase name, RelationshipBase.Direction direction, NameRelationshipType type) Return a count of names related to or from this name, optionally filtered by relationship type.
int	countNames(String queryString) Returns a count of TaxonNameBase instances which nameCache matches the String queryString
int	countNames(String queryString, MatchMode matchMode, List<org.hibernate.criterion.Criterion> criteria) Returns a count of TaxonNameBase instances that match the properties passed
int	countNames(String uninomial, String infraGenericEpithet, String specificEpithet, String infraspecificEpithet, Rank rank) Returns a count of TaxonNameBase instances that match the properties passed
int	countTypeDesignations(TaxonNameBase name, SpecimenTypeDesignationStatus status) Return a count of types related to this name, optionally filtered by type designation status
List<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)
List<? extends TaxonNameBase<?,?>>	findByName(String queryString, MatchMode matchmode, Integer pageSize, Integer pageNumber, List<org.hibernate.criterion.Criterion> criteria, List<String> propertyPaths)
List<? extends TaxonNameBase<?,?>>	findByTitle(String queryString, MatchMode matchmode, Integer pageSize, Integer pageNumber, List<org.hibernate.criterion.Criterion> criteria, List<String> propertyPaths)
TaxonNameBase<?,?>	findByUuid(UUID uuid, List<org.hibernate.criterion.Criterion> criteria, List<String> propertyPaths) Returns a taxon name corresponding to the given uuid
ZoologicalName	findZoologicalNameByUUID(UUID uuid)
List<RelationshipBase>	getAllRelationships(Integer limit, Integer start)
List<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
List<NameRelationship>	getNameRelationships(TaxonNameBase name, RelationshipBase.Direction direction, NameRelationshipType type, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) Return a List of relationships related to or from this name, optionally filtered by relationship type.
<T extends TypeDesignationBase> List<T>	getTypeDesignations(TaxonNameBase name, Class<T> type, TypeDesignationStatusBase status, Integer pageSize, Integer pageNumber, List<String> propertyPaths) Return a List of types related to this name, optionally filtered by type designation status
List<TypeDesignationBase>	getTypeDesignations(TaxonNameBase name, TypeDesignationStatusBase status, Integer pageSize, Integer pageNumber, List<String> propertyPaths) Deprecated. use getTypeDesignations(TaxonNameBase, Class, TypeDesignationStatusBase, Integer, Integer, List) instead
List<UuidAndTitleCache>	getUuidAndTitleCacheOfNames()
List<ZoologicalName>	getZoologicalNames(Integer limit, Integer start)
List<TaxonNameBase<?,?>>	searchNames(String queryString, Integer pageSize, Integer pageNumber) Returns a List of TaxonNameBase instances which nameCache matches the query string
List<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.persistence.dao.common.IIdentifiableDao

countByReferenceTitle, countByTitle, countRights, countSources, countTitleCache, find, findByReferenceTitle, findByTitle, findOriginalSourceByIdInSource, findTitleCache, getRights, getSources, getUuidAndTitleCache

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.IAnnotatableDao

countAnnotations, countMarkers, countMarkers, getAnnotations, getMarkers, groupMarkers

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.IVersionableDao

countAuditEvents, countAuditEvents, getAuditEvents, getAuditEvents, getNextAuditEvent, getPreviousAuditEvent

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.ICdmEntityDao

clear, count, count, count, delete, exists, findById, findByUuid, flush, getSession, getType, group, list, list, list, list, list, list, list, listByIds, load, load, load, lock, merge, refresh, refresh, replace, rows, save, saveAll, saveOrUpdate, saveOrUpdateAll, update

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.ITitledDao

countByTitle, countByTitle, countByTitle, findByTitle, findByTitle, findByTitle, findByTitleAndClass

Methods inherited from interface eu.etaxonomy.cdm.persistence.dao.common.ISearchableDao

count, optimizeIndex, purgeIndex, rebuildIndex, search, suggestQuery

Method Detail

countNameRelationships

int countNameRelationships(TaxonNameBase name,
                           RelationshipBase.Direction direction,
                           NameRelationshipType type)

Return a count of names related to or from this name, optionally filtered by relationship type. The direction of the relationships taken in to account is depending on the direction parameter.

Parameters:

name - the name

direction - specifies the direction of the relationship

type - the relationship type (or null to return all relationships)

Returns:

a count of NameRelationship instances

getNameRelationships

List<NameRelationship> getNameRelationships(TaxonNameBase name,
                                            RelationshipBase.Direction direction,
                                            NameRelationshipType type,
                                            Integer pageSize,
                                            Integer pageNumber,
                                            List<OrderHint> orderHints,
                                            List<String> propertyPaths)

Return a List of relationships related to or from this name, optionally filtered by relationship type. The direction of the relationships taken in to account is depending on the direction parameter. If both name and direction is null all name relationships will be returned.

Parameters:

name - the name

direction - specifies the direction of the relationship, may be null to return all relationships

type - 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) of the result set (0 - based)

orderHints - may be null

propertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)

Returns:

a List of NameRelationship instances

countHybridNames

int countHybridNames(NonViralName name,
                     HybridRelationshipType type)

Return a count of hybrids related to this name, optionally filtered by hybrid relationship type

Parameters:

name - the name

type - the hybrid relationship type (or null to return all hybrid)

Returns:

a count of HybridRelationship instances

getHybridNames

List<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

Parameters:

name - the name

type - 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)

Returns:

a List of HybridRelationship instances

countTypeDesignations

int countTypeDesignations(TaxonNameBase name,
                          SpecimenTypeDesignationStatus status)

Return a count of types related to this name, optionally filtered by type designation status

Parameters:

name - the name

status - the type designation status (or null to return all types)

Returns:

a count of TypeDesignationBase instances

getTypeDesignations

<T extends TypeDesignationBase> List<T> getTypeDesignations(TaxonNameBase name,
                                                            Class<T> type,
                                                            TypeDesignationStatusBase status,
                                                            Integer pageSize,
                                                            Integer pageNumber,
                                                            List<String> propertyPaths)

Return a List of types related to this name, optionally filtered by type designation status

Parameters:

name - the name

type - limit the result set to a specific subtype of TypeDesignationBase, may be null

status - 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)

propertyPaths -

Returns:

a List of TypeDesignationBase instances

getTypeDesignations

@Deprecated
List<TypeDesignationBase> getTypeDesignations(TaxonNameBase name,
                                                         TypeDesignationStatusBase status,
                                                         Integer pageSize,
                                                         Integer pageNumber,
                                                         List<String> propertyPaths)

Deprecated. use getTypeDesignations(TaxonNameBase, Class, TypeDesignationStatusBase, Integer, Integer, List) instead

Return a List of types related to this name, optionally filtered by type designation status

Parameters:

name - the name

status - 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)

propertyPaths -

Returns:

a List of TypeDesignationBase instances

searchNames

List<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

Parameters:

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)

propertyPaths -

orderHints -

Returns:

a List of TaxonNameBase instances

countNames

int countNames(String uninomial,
               String infraGenericEpithet,
               String specificEpithet,
               String infraspecificEpithet,
               Rank rank)

Returns a count of TaxonNameBase instances that match the properties passed

Parameters:

uninomial -

infraGenericEpithet -

specificEpithet -

infraspecificEpithet -

rank -

Returns:

a count of TaxonNameBase instances

countNames

int countNames(String queryString,
               MatchMode matchMode,
               List<org.hibernate.criterion.Criterion> criteria)

Returns a count of TaxonNameBase instances that match the properties passed

Parameters:

queryString -

matchMode -

criteria -

searchNames

List<TaxonNameBase<?,?>> searchNames(String queryString,
                                     Integer pageSize,
                                     Integer pageNumber)

Returns a List of TaxonNameBase instances which nameCache matches the query string

Parameters:

queryString -

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)

Returns:

a List of TaxonNameBase instances

countNames

int countNames(String queryString)

Returns a count of TaxonNameBase instances which nameCache matches the String queryString

Parameters:

queryString -

Returns:

a count of TaxonNameBase instances

findByName

List<? extends TaxonNameBase<?,?>> findByName(String queryString,
                                              MatchMode matchmode,
                                              Integer pageSize,
                                              Integer pageNumber,
                                              List<org.hibernate.criterion.Criterion> criteria,
                                              List<String> propertyPaths)

Parameters:

queryString -

matchmode -

pageSize -

pageNumber -

criteria -

propertyPaths - TODO

Returns:

findByTitle

List<? extends TaxonNameBase<?,?>> findByTitle(String queryString,
                                               MatchMode matchmode,
                                               Integer pageSize,
                                               Integer pageNumber,
                                               List<org.hibernate.criterion.Criterion> criteria,
                                               List<String> propertyPaths)

Parameters:

queryString -

matchmode -

pageSize -

pageNumber -

criteria -

propertyPaths - TODO

Returns:

findByUuid

TaxonNameBase<?,?> findByUuid(UUID uuid,
                              List<org.hibernate.criterion.Criterion> criteria,
                              List<String> propertyPaths)

Returns a taxon name corresponding to the given uuid

Parameters:

uuid - The uuid of the taxon name requested

criteria - Custom criteria to be added to the default list of applied criteria.

propertyPaths -

Returns:

countByName

Integer countByName(String queryString,
                    MatchMode matchmode,
                    List<org.hibernate.criterion.Criterion> criteria)

Parameters:

queryString -

matchmode -

criteria -

Returns:

getAllRelationships

List<RelationshipBase> getAllRelationships(Integer limit,
                                           Integer start)

getUuidAndTitleCacheOfNames

List<UuidAndTitleCache> getUuidAndTitleCacheOfNames()

findByName

List<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)

Parameters:

clazz -

queryString -

matchmode -

pageSize -

pageNumber -

criteria -

orderHints -

propertyPaths - TODO

Returns:

countByName

Integer countByName(Class<? extends TaxonNameBase> clazz,
                    String queryString,
                    MatchMode matchmode,
                    List<org.hibernate.criterion.Criterion> criteria)

Parameters:

clazz -

queryString -

matchmode -

criteria -

Returns:

getZoologicalNames

List<ZoologicalName> getZoologicalNames(Integer limit,
                                        Integer start)

findZoologicalNameByUUID

ZoologicalName findZoologicalNameByUUID(UUID uuid)