eu.etaxonomy.cdm.api.service
Interface IPolytomousKeyService

All Superinterfaces:

IAnnotatableService<PolytomousKey>, IIdentifiableEntityService<PolytomousKey>, IService<PolytomousKey>, IVersionableService<PolytomousKey>

All Known Implementing Classes:

PolytomousKeyServiceImpl

public interface IPolytomousKeyService
extends IIdentifiableEntityService<PolytomousKey>

Method Summary

Pager<PolytomousKey>	findByTaxonomicScope(TaxonBase taxon, Integer pageSize, Integer pageNumber, List<String> propertyPaths, List<String> nodePaths)
PolytomousKey	loadWithNodes(UUID uuid, List<String> propertyPaths, List<String> nodePaths) Loads a polytomous key including all of its nodes (all the way down to the tips of the tree).

Methods inherited from interface eu.etaxonomy.cdm.api.service.IIdentifiableEntityService

countByTitle, countByTitle, deduplicate, find, findByTitle, findByTitle, findTitleCache, getRights, getSourcedObjectByIdInSource, getSources, getUuidAndTitleCache, listByReferenceTitle, listByTitle, replace, search, 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

loadWithNodes

PolytomousKey loadWithNodes(UUID uuid,
                            List<String> propertyPaths,
                            List<String> nodePaths)

Loads a polytomous key including all of its nodes (all the way down to the tips of the tree). Because this method automatically adds key nodes recursively, adding "root" to property paths is superfluous - the propertyPaths argument should be used to initialize property paths in addition to the key nodes. The nodePaths argument is applied to each node in turn, so again, adding "children" is also superfluous. The nodePaths argument should be used to specify additional properties of the key node to initialize.

findByTaxonomicScope

Pager<PolytomousKey> findByTaxonomicScope(TaxonBase taxon,
                                          Integer pageSize,
                                          Integer pageNumber,
                                          List<String> propertyPaths,
                                          List<String> nodePaths)