3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
7 * The contents of this file are subject to the Mozilla Public License Version 1.1
8 * See LICENSE.TXT at the top of this package for the full license terms.
11 package eu
.etaxonomy
.cdm
.api
.service
;
13 import java
.util
.List
;
15 import org
.hibernate
.criterion
.Criterion
;
17 import eu
.etaxonomy
.cdm
.api
.service
.config
.IIdentifiableEntityServiceConfigurator
;
18 import eu
.etaxonomy
.cdm
.api
.service
.config
.ITaxonServiceConfigurator
;
19 import eu
.etaxonomy
.cdm
.api
.service
.pager
.Pager
;
20 import eu
.etaxonomy
.cdm
.common
.monitor
.IProgressMonitor
;
21 import eu
.etaxonomy
.cdm
.model
.common
.ISourceable
;
22 import eu
.etaxonomy
.cdm
.model
.common
.IdentifiableEntity
;
23 import eu
.etaxonomy
.cdm
.model
.common
.IdentifiableSource
;
24 import eu
.etaxonomy
.cdm
.model
.common
.LSID
;
25 import eu
.etaxonomy
.cdm
.model
.common
.UuidAndTitleCache
;
26 import eu
.etaxonomy
.cdm
.model
.media
.Rights
;
27 import eu
.etaxonomy
.cdm
.persistence
.dao
.BeanInitializer
;
28 import eu
.etaxonomy
.cdm
.persistence
.query
.MatchMode
;
29 import eu
.etaxonomy
.cdm
.persistence
.query
.OrderHint
;
30 import eu
.etaxonomy
.cdm
.strategy
.cache
.common
.IIdentifiableEntityCacheStrategy
;
31 import eu
.etaxonomy
.cdm
.strategy
.match
.IMatchStrategy
;
32 import eu
.etaxonomy
.cdm
.strategy
.match
.IMatchable
;
33 import eu
.etaxonomy
.cdm
.strategy
.merge
.IMergable
;
34 import eu
.etaxonomy
.cdm
.strategy
.merge
.IMergeStrategy
;
36 public interface IIdentifiableEntityService
<T
extends IdentifiableEntity
> extends IAnnotatableService
<T
> {
39 * (Re-)generate the title caches for all objects of this concrete IdentifiableEntity class.
40 * Uses default values.
41 * @see #updateTitleCache(Class, Integer, IIdentifiableEntityCacheStrategy, IProgressMonitor)
43 public void updateTitleCache();
46 * (Re-)generate the title caches for all objects of this concrete IdentifiableEntity class
48 * @param clazz class of objects to be updated
49 * @param stepSize number of objects loaded per step. If <code>null</code> use default.
50 * @param cacheStrategy cachestrategy used for title cache. If <code>null</code> use default.
51 * @param monitor progress monitor. If <code>null</code> use default.
53 public void updateTitleCache(Class
<?
extends T
> clazz
, Integer stepSize
, IIdentifiableEntityCacheStrategy
<T
> cacheStrategy
, IProgressMonitor monitor
);
56 * Finds an object with a given LSID. If the object does not currently exist in the current view, then
57 * the most recent prior version of the object will be returned, or null if an object with this identifier
61 * @return an object of type T or null of the object has never existed
63 public T
find(LSID lsid
);
66 * Replaces all *ToMany and *ToOne references to an object (x) with another object of the same type (y)
68 * Ignores ManyToAny and OneToAny relationships as these are typically involved with bidirectional
69 * parent-child relations
73 * @return the replacing object (y)
75 public T
replace(T x
, T y
);
78 * Return a Pager of sources belonging to this object
80 * @param t The identifiable entity
81 * @param pageSize The maximum number of sources returned (can be null for all sources)
82 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
83 * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
84 * @return a Pager of OriginalSource entities
86 public Pager
<IdentifiableSource
> getSources(T t
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
89 * Return a Pager of rights belonging to this object
91 * @param t The identifiable entity
92 * @param pageSize The maximum number of rights returned (can be null for all rights)
93 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
94 * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
95 * @return a Pager of Rights entities
97 public Pager
<Rights
> getRights(T t
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
99 public ISourceable
getSourcedObjectByIdInSource(Class clazz
, String idInSource
, String idNamespace
);
102 * Return a list of all uuids mapped to titleCache in the convenient <code>UuidAndTitleCache</code> object.
103 * Retrieving this list is considered to be significantly faster than initializing the fully fledged buiseness
104 * objects. To be used in cases where you want to present large amount of data and provide details after
105 * a selection has been made.
107 * @return a list of <code>UuidAndTitleCache</code> instances
109 public List
<UuidAndTitleCache
<T
>> getUuidAndTitleCache();
112 * Return a Pager of objects matching the given query string, optionally filtered by class, optionally with a particular MatchMode
114 * @param clazz filter by class - can be null to include all instances of type T
115 * @param queryString the query string to filter by
116 * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
117 * @param criteria additional criteria to filter by
118 * @param pageSize The maximum number of objects returned (can be null for all objects)
119 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
120 * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
122 * Supports path like <code>orderHints.propertyNames</code> which
123 * include *-to-one properties like createdBy.username or
124 * authorTeam.persistentTitleCache
125 * @return a paged list of instances of type T matching the queryString
127 public Pager
<T
> findByTitle(Class
<?
extends T
> clazz
, String queryString
,MatchMode matchmode
, List
<Criterion
> criteria
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
131 * Return a Pager of objects matching the given query string, optionally filtered by class,
132 * optionally with a particular MatchMode
134 * @return a paged list of instances of type T matching the queryString
136 public Pager
<T
> findByTitle(IIdentifiableEntityServiceConfigurator
<T
> configurator
);
140 * Return an Integer of how many objects matching the given query string, optionally filtered by class, optionally with a particular MatchMode
142 * @param clazz filter by class - can be null to include all instances of type T
143 * @param queryString the query string to filter by
144 * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
145 * @param criteria additional criteria to filter by
149 public Integer
countByTitle(Class
<?
extends T
> clazz
, String queryString
,MatchMode matchmode
, List
<Criterion
> criteria
);
152 * Return an Integer of how many objects matching the given query string, optionally filtered by class, optionally with a particular MatchMode
154 * @param configurator an {@link IIdentifiableEntityServiceConfigurator} object
158 public Integer
countByTitle(IIdentifiableEntityServiceConfigurator
<T
> configurator
);
162 * Return a List of objects matching the given query string, optionally filtered by class, optionally with a particular MatchMode
164 * @param clazz filter by class - can be null to include all instances of type T
165 * @param queryString the query string to filter by
166 * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
167 * @param criteria additional criteria to filter by
168 * @param pageSize The maximum number of objects returned (can be null for all objects)
169 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
170 * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
172 * Supports path like <code>orderHints.propertyNames</code> which
173 * include *-to-one properties like createdBy.username or
174 * authorTeam.persistentTitleCache
175 * @return a list of instances of type T matching the queryString
177 public List
<T
> listByTitle(Class
<?
extends T
> clazz
, String queryString
,MatchMode matchmode
, List
<Criterion
> criteria
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
180 * Return a List of objects matching the given query string, optionally filtered by class, optionally with a particular MatchMode
182 * @param clazz filter by class - can be null to include all instances of type T
183 * @param queryString the query string to filter by
184 * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
185 * @param criteria additional criteria to filter by
186 * @param pageSize The maximum number of objects returned (can be null for all objects)
187 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
188 * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
190 * Supports path like <code>orderHints.propertyNames</code> which
191 * include *-to-one properties like createdBy.username or
192 * authorTeam.persistentTitleCache
193 * @return a list of instances of type T matching the queryString
195 public List
<T
> listByReferenceTitle(Class
<?
extends T
> clazz
, String queryString
,MatchMode matchmode
, List
<Criterion
> criteria
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
198 * Returns a Paged List of IdentifiableEntity instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
200 * @param clazz filter the results by class (or pass null to return all IdentifiableEntity instances)
202 * @param pageSize The maximum number of identifiable entities returned (can be null for all matching identifiable entities)
203 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
205 * Supports path like <code>orderHints.propertyNames</code> which
206 * include *-to-one properties like createdBy.username or
207 * authorTeam.persistentTitleCache
208 * @param propertyPaths properties to be initialized
209 * @return a Pager IdentifiableEntity instances
210 * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
212 public Pager
<T
> search(Class
<?
extends T
> clazz
, String queryString
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
216 * This method tries to deduplicate all objects of a certain class by first trying to find matchabel objects and
217 * merging them in a second step. For performance reasons implementing classes must not guarantee that ALL
218 * matching object pairs are found but only a subset. But it must guarantee that only matching objects are merged.
219 *<BR> Matching is defined by the given matching strategy or if no matching strategy is given the default matching
221 *<BR>Clazz must implement {@link IMatchable} and {@link IMergable} otherwise no deduplication is performed.
222 *<BR>The current implementation in IdentifiableServiceBase tries to match and merge all objects with an identical non
225 * @param matchStrategy
226 * @param mergeStrategy
227 * @return the number of merges performed during deduplication
229 public int deduplicate(Class
<?
extends T
> clazz
, IMatchStrategy matchStrategy
, IMergeStrategy mergeStrategy
);
233 * Return a Pager of objects with distinct titleCache strings filtered by the given query string, optionally filtered by class, optionally with a particular MatchMode
242 public Pager
<T
> findTitleCache(Class
<?
extends T
> clazz
, String queryString
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, MatchMode matchMode
);