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
.Collection
;
14 import java
.util
.List
;
17 import java
.util
.UUID
;
19 import eu
.etaxonomy
.cdm
.api
.service
.pager
.Pager
;
20 import eu
.etaxonomy
.cdm
.api
.utility
.DescriptionUtility
;
21 import eu
.etaxonomy
.cdm
.model
.common
.Annotation
;
22 import eu
.etaxonomy
.cdm
.model
.common
.DefinedTerm
;
23 import eu
.etaxonomy
.cdm
.model
.common
.Language
;
24 import eu
.etaxonomy
.cdm
.model
.common
.Marker
;
25 import eu
.etaxonomy
.cdm
.model
.common
.MarkerType
;
26 import eu
.etaxonomy
.cdm
.model
.common
.TermVocabulary
;
27 import eu
.etaxonomy
.cdm
.model
.description
.DescriptionBase
;
28 import eu
.etaxonomy
.cdm
.model
.description
.DescriptionElementBase
;
29 import eu
.etaxonomy
.cdm
.model
.description
.Distribution
;
30 import eu
.etaxonomy
.cdm
.model
.description
.Feature
;
31 import eu
.etaxonomy
.cdm
.model
.description
.FeatureTree
;
32 import eu
.etaxonomy
.cdm
.model
.description
.PresenceAbsenceTerm
;
33 import eu
.etaxonomy
.cdm
.model
.description
.TaxonDescription
;
34 import eu
.etaxonomy
.cdm
.model
.description
.TaxonNameDescription
;
35 import eu
.etaxonomy
.cdm
.model
.location
.NamedArea
;
36 import eu
.etaxonomy
.cdm
.model
.location
.NamedAreaLevel
;
37 import eu
.etaxonomy
.cdm
.model
.media
.Media
;
38 import eu
.etaxonomy
.cdm
.model
.name
.TaxonNameBase
;
39 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
40 import eu
.etaxonomy
.cdm
.persistence
.dao
.initializer
.IBeanInitializer
;
41 import eu
.etaxonomy
.cdm
.persistence
.query
.OrderHint
;
43 public interface IDescriptionService
extends IIdentifiableEntityService
<DescriptionBase
> {
48 * @deprecated use TermService#getVocabulary(VocabularyType) instead
51 public TermVocabulary
<Feature
> getDefaultFeatureVocabulary();
54 * @deprecated use TermService#getVocabulary(VocabularyType) instead
57 public TermVocabulary
<Feature
> getFeatureVocabulary(UUID uuid
);
60 * Gets a DescriptionElementBase instance matching the supplied uuid
62 * @param uuid the uuid of the DescriptionElement of interest
63 * @return a DescriptionElement, or null if the DescriptionElement does not exist
65 public DescriptionElementBase
getDescriptionElementByUuid(UUID uuid
);
68 * Loads and existing DescriptionElementBase instance matching the supplied uuid,
69 * and recursively initializes all bean properties given in the
70 * <code>propertyPaths</code> parameter.
72 * For detailed description and examples <b>please refer to:</b>
73 * {@link IBeanInitializer#initialize(Object, List)}
75 * @param uuid the uuid of the DescriptionElement of interest
76 * @return a DescriptionElement, or null if the DescriptionElement does not exist
78 public DescriptionElementBase
loadDescriptionElement(UUID uuid
,List
<String
> propertyPaths
);
81 * Persists a <code>DescriptionElementBase</code>
82 * @param descriptionElement
85 public UUID
saveDescriptionElement(DescriptionElementBase descriptionElement
);
88 * Persists a collection of <code>DescriptionElementBase</code>
89 * @param descriptionElements
92 public Map
<UUID
, DescriptionElementBase
> saveDescriptionElement(Collection
<DescriptionElementBase
> descriptionElements
);
95 * Delete an existing description element
97 * @param descriptionElement the description element to be deleted
98 * @return the unique identifier of the deleted entity
100 public UUID
deleteDescriptionElement(DescriptionElementBase descriptionElement
);
103 * List the descriptions of type <T>, filtered using the following parameters
105 * @param type The type of description returned (Taxon, TaxonName, or Specimen)
106 * @param hasMedia Restrict the description to those that do (true) or don't (false) contain <i>elements</i> that have one or more media (can be null)
107 * @param hasText Restrict the description to those that do (true) or don't (false) contain TextData <i>elements</i> that have some textual content (can be null)
108 * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
109 * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
110 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
111 * @param orderHints may be null
112 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
113 * @return a Pager containing DescriptionBase instances
115 public Pager
<DescriptionBase
> page(Class
<?
extends DescriptionBase
> type
, Boolean hasMedia
, Boolean hasText
, Set
<Feature
> feature
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
118 * Count the descriptions of type <TYPE>, filtered using the following parameters
120 * @param type The type of description returned (Taxon, TaxonName, or Specimen)
121 * @param hasMedia Restrict the description to those that do (true) or don't (false) contain <i>elements</i> that have one or more media (can be null)
122 * @param hasText Restrict the description to those that do (true) or don't (false) contain TextData <i>elements</i> that have some textual content (can be null)
123 * @param feature Restrict the description to those <i>elements</i> which are scoped by one of the Features passed (can be null or empty)
124 * @return a count of DescriptionBase instances
126 public int count(Class
<?
extends DescriptionBase
> type
, Boolean hasImages
, Boolean hasText
, Set
<Feature
> feature
);
129 * Returns description elements of type <TYPE>, belonging to a given
130 * description, optionally filtered by one or more features
133 * The description which these description elements belong to
134 * (can be null to count all description elements)
135 * @param descriptionType
136 * A filter DescriptionElements which belong to of a specific
137 * class of Descriptions
139 * Restrict the results to those description elements which are
140 * scoped by one of the Features passed (can be null or empty)
142 * A filter for DescriptionElements of a specific class
144 * The maximum number of description elements returned (can be
145 * null for all description elements)
147 * The offset (in pageSize chunks) from the start of the result
149 * @param propertyPaths
150 * Properties to initialize in the returned entities, following
151 * the syntax described in
152 * {@link IBeanInitializer#initialize(Object, List)}
153 * @return a Pager containing DescriptionElementBase instances
156 * {@link #pageDescriptionElements(DescriptionBase, Set, Class, Integer, Integer, List)}
160 public Pager
<DescriptionElementBase
> getDescriptionElements(DescriptionBase description
,Set
<Feature
> features
, Class
<?
extends DescriptionElementBase
> type
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
164 * Returns description elements of type <TYPE>, belonging to a given
165 * description, optionally filtered by one or more features
168 * The description which these description elements belong to
169 * (can be null to count all description elements)
170 * @param descriptionType
171 * A filter DescriptionElements which belong to of a specific
172 * class of Descriptions
174 * Restrict the results to those description elements which are
175 * scoped by one of the Features passed (can be null or empty)
177 * A filter for DescriptionElements of a specific class
179 * The maximum number of description elements returned (can be
180 * null for all description elements)
182 * The offset (in pageSize chunks) from the start of the result
184 * @param propertyPaths
185 * Properties to initialize in the returned entities, following
186 * the syntax described in
187 * {@link IBeanInitializer#initialize(Object, List)}
189 * @return a Pager containing DescriptionElementBase instances
191 public Pager
<DescriptionElementBase
> pageDescriptionElements(DescriptionBase description
, Class
<?
extends DescriptionBase
> descriptionType
, Set
<Feature
> features
, Class
<?
extends DescriptionElementBase
> type
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
194 * Returns description elements of type <TYPE>, belonging to a given
195 * description, optionally filtered by one or more features
198 * The description which these description elements belong to
199 * (can be null to count all description elements)
201 * Restrict the results to those description elements which are
202 * scoped by one of the Features passed (can be null or empty)
204 * A filter for DescriptionElements of a specific class
206 * The maximum number of description elements returned (can be
207 * null for all description elements)
209 * The offset (in pageSize chunks) from the start of the result
211 * @param propertyPaths
212 * Properties to initialize in the returned entities, following
213 * the syntax described in
214 * {@link IBeanInitializer#initialize(Object, List)}
215 * @return a List of DescriptionElementBase instances
216 * @deprecated use {@link #listDescriptionElements(DescriptionBase, Class, Set, Class, Integer, Integer, List)} instead
219 public List
<DescriptionElementBase
> listDescriptionElements(DescriptionBase description
,Set
<Feature
> features
, Class
<?
extends DescriptionElementBase
> type
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
222 * Returns description elements of type <TYPE>, belonging to a given
223 * description, optionally filtered by one or more features
226 * The description which these description elements belong to
227 * (can be null to count all description elements)
229 * Restrict the results to those description elements which are
230 * scoped by one of the Features passed (can be null or empty)
232 * A filter DescriptionElements of a for specific class
234 * The maximum number of description elements returned (can be
235 * null for all description elements)
237 * The offset (in pageSize chunks) from the start of the result
239 * @param propertyPaths
240 * Properties to initialize in the returned entities, following
241 * the syntax described in
242 * {@link IBeanInitializer#initialize(Object, List)}
243 * @return a List of DescriptionElementBase instances
245 public List
<DescriptionElementBase
> listDescriptionElements(DescriptionBase description
, Class
<?
extends DescriptionBase
> descriptionType
, Set
<Feature
> features
, Class
<?
extends DescriptionElementBase
> type
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
248 * Return a Pager containing Annotation entities belonging to the DescriptionElementBase instance supplied, optionally filtered by MarkerType
249 * @param annotatedObj The object that "owns" the annotations returned
250 * @param status Only return annotations which are marked with a Marker of this type (can be null to return all annotations)
251 * @param pageSize The maximum number of terms returned (can be null for all annotations)
252 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
253 * @param orderHints may be null
254 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
255 * @return a Pager of Annotation entities
257 public Pager
<Annotation
> getDescriptionElementAnnotations(DescriptionElementBase annotatedObj
, MarkerType status
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
261 * Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method
263 * @param taxon The taxon which the description refers to (can be null for all TaxonDescription instances)
264 * @param scopes Restrict the results to those descriptions which are scoped by one of the Scope instances passed (can be null or empty)
265 * @param geographicalScope Restrict the results to those descriptions which have a geographical scope that overlaps with the NamedArea instances passed (can be null or empty)
266 * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
267 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
268 * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link IBeanInitializer#initialize(Object, List)}
269 * @return a Pager containing TaxonDescription instances
271 * @see #pageMarkedTaxonDescriptions(Taxon, Set, Set, Set, Integer, Integer, List)
273 public Pager
<TaxonDescription
> pageTaxonDescriptions(Taxon taxon
, Set
<DefinedTerm
> scopes
, Set
<NamedArea
> geographicalScope
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
276 * Returns a List of TaxonDescription instances, optionally filtered by parameters passed to this method
278 * @param taxon The taxon which the description refers to (can be null for all TaxonDescription instances)
279 * @param scopes Restrict the results to those descriptions which are scoped by one of the Scope instances passed (can be null or empty)
280 * @param geographicalScope Restrict the results to those descriptions which have a geographical scope that overlaps with the NamedArea instances passed (can be null or empty)
281 * @param markerType Restrict the results to those descriptions which are marked as true by one of the given marker types (can be null or empty)
282 * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
283 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
284 * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link IBeanInitializer#initialize(Object, List)}
285 * @return a Pager containing TaxonDescription instances
287 public Pager
<TaxonDescription
> pageTaxonDescriptions(Taxon taxon
, Set
<DefinedTerm
> scopes
, Set
<NamedArea
> geographicalScope
, Set
<MarkerType
> markerTypes
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
290 * @see {@link #pageTaxonDescriptions(Taxon, Set, Set, Integer, Integer, List)}
294 * @param geographicalScope
297 * @param propertyPaths
300 public List
<TaxonDescription
> listTaxonDescriptions(Taxon taxon
, Set
<DefinedTerm
> scopes
, Set
<NamedArea
> geographicalScope
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
305 * @see {@link #pageMarkedTaxonDescriptions(Taxon, Set, Set, Set, Integer, Integer, List)}
309 * @param geographicalScope
312 * @param propertyPaths
315 public List
<TaxonDescription
> listTaxonDescriptions(Taxon taxon
, Set
<DefinedTerm
> scopes
, Set
<NamedArea
> geographicalScope
, Set
<MarkerType
> markerTypes
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
318 * Returns all {@link Media} attached to a taxon via TaxonDescription.elements.media.
319 * @param taxonUuid the taxons uuid, if null media for all taxa are returned
320 * @param limitToGalleries if true only media in TaxonDescriptions with imageGallery flag=true are returned
321 * @param markerTypes only media for TaxonDescriptions with marker of type markerType and marker.flag=true are returned, one matching marker type is sufficient
324 * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link IBeanInitializer#initialize(Object, List)}
327 public List
<Media
> listTaxonDescriptionMedia(UUID taxonUuid
, boolean limitToGalleries
, Set
<MarkerType
> markerTypes
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
330 * Returns count for all {@link Media} attached to a taxon via TaxonDescription.elements.media.
331 * @param taxonUuid the taxons uuid, if null media for all taxa are returned
332 * @param limitToGalleries if true only media in TaxonDescriptions with imageGallery flag=true are returned
333 * @param markerTypes only media for TaxonDescriptions with marker of type markerType and marker.flag=true are returned, one matching marker type is sufficient
336 public int countTaxonDescriptionMedia(UUID taxonUuid
, boolean limitToGalleries
, Set
<MarkerType
> markerTypes
);
341 * Returns a List of TaxonNameDescription instances, optionally filtered by the name which they refer to
343 * @param name Restrict the results to those descriptions that refer to a specific name (can be null for all TaxonNameDescription instances)
344 * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
345 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
346 * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link IBeanInitializer#initialize(Object, List)}
347 * @return a Pager containing TaxonNameBase instances
349 * FIXME candidate for harmonization - rename to pageTaxonNameDescriptions
351 public Pager
<TaxonNameDescription
> getTaxonNameDescriptions(TaxonNameBase name
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
355 * Returns a List of distinct TaxonDescription instances which have Distribution elements that refer to one of the NamedArea instances passed (optionally
356 * filtered by a type of PresenceAbsenceTerm e.g. PRESENT / ABSENT / NATIVE / CULTIVATED etc)
358 * @param namedAreas The set of NamedArea instances
359 * @param presence Restrict the descriptions to those which have Distribution elements are of this status (can be null)
360 * @param pageSize The maximum number of descriptions returned (can be null for all descriptions)
361 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
362 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
363 * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link IBeanInitializer#initialize(Object, List)}
364 * @return a Pager containing TaxonDescription instances
366 public Pager
<TaxonDescription
> searchDescriptionByDistribution(Set
<NamedArea
> namedAreas
, PresenceAbsenceTerm presence
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
369 * Returns a Paged List of DescriptionElementBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
371 * @param clazz filter the results by class (or pass null to return all DescriptionElementBase instances)
373 * @param pageSize The maximum number of descriptionElements returned (can be null for all matching descriptionElements)
374 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
376 * Supports path like <code>orderHints.propertyNames</code> which
377 * include *-to-one properties like createdBy.username or
378 * authorTeam.persistentTitleCache
379 * @param propertyPaths properties to be initialized
380 * @return a Pager DescriptionElementBase instances
381 * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
383 public Pager
<DescriptionElementBase
> searchElements(Class
<?
extends DescriptionElementBase
> clazz
, String queryString
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);
386 * Returns a List of Media that are associated with a given description element
388 * @param descriptionElement the description element associated with these media
389 * @param pageSize The maximum number of media returned (can be null for all related media)
390 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
391 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
392 * @return a Pager containing media instances
394 * FIXME candidate for harmonization - rename to pageMedia
396 public Pager
<Media
> getMedia(DescriptionElementBase descriptionElement
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
399 * Provides access to all DescriptionElements associated with the given Taxon
400 * via a TaxonDescrition.
403 * The Taxon to return Description elements for
405 * Restrict the results to those description elements which are
406 * scoped by one of the Features passed (can be null or empty)
408 * A filter for DescriptionElements of a specific class
410 * The maximum number of description elements returned (can be
411 * null for all description elements)
413 * The offset (in pageSize chunks) from the start of the result
415 * @param propertyPaths
416 * Properties to initialize in the returned entities, following
417 * the syntax described in
418 * {@link IBeanInitializer#initialize(Object, List)}
419 * @return a List containing all matching DescriptionElementBase instances
421 * @deprecated use {@link #listDescriptionElementsForTaxon(Taxon, Set, Class, Integer, Integer, List)} instead
424 public <T
extends DescriptionElementBase
> List
<T
> getDescriptionElementsForTaxon(Taxon taxon
, Set
<Feature
> features
, Class
<T
> type
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
427 * Provides access to all DescriptionElements associated with the given Taxon
428 * via a TaxonDescrition.
431 * The Taxon to return Description elements for
433 * Restrict the results to those description elements which are
434 * scoped by one of the Features passed (can be null or empty)
436 * A filter for DescriptionElements of a specific class
438 * The maximum number of description elements returned (can be
439 * null for all description elements)
441 * The offset (in pageSize chunks) from the start of the result
443 * @param propertyPaths
444 * Properties to initialize in the returned entities, following
445 * the syntax described in
446 * {@link IBeanInitializer#initialize(Object, List)}
447 * @return a List containing all matching DescriptionElementBase instances
450 public <T
extends DescriptionElementBase
> List
<T
> listDescriptionElementsForTaxon(Taxon taxon
, Set
<Feature
> features
, Class
<T
> type
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
453 * Provides access to all DescriptionElements associated with the given Taxon
454 * via a TaxonDescrition.
457 * The Taxon to return Description elements for
459 * Restrict the results to those description elements which are
460 * scoped by one of the Features passed (can be null or empty)
462 * A filter for DescriptionElements of a specific class
464 * The maximum number of description elements returned
466 * The offset (in pageSize chunks) from the start of the result
468 * @param propertyPaths
469 * Properties to initialize in the returned entities, following
470 * the syntax described in
471 * {@link IBeanInitializer#initialize(Object, List)}
472 * @return a Pager for all matching DescriptionElementBase instances
475 public <T
extends DescriptionElementBase
> Pager
<T
> pageDescriptionElementsForTaxon(Taxon taxon
, Set
<Feature
> features
, Class
<T
> type
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
479 * @param taxonDescriptions
480 * @param subAreaPreference
481 * enables the <b>Sub area preference rule</b> if set to true,
482 * see {@link DescriptionUtility#filterDistributions(Collection,
485 * @param statusOrderPreference
486 * enables the <b>Status order preference rule</b> if set to
488 * DescriptionUtility#filterDistributions(Collection, boolean,
490 * @param hideMarkedAreas
491 * distributions where the area has a {@link Marker} with one of
492 * the specified {@link MarkerType}s will be skipped, see
493 * {@link DescriptionUtility#filterDistributions(Collection, boolean, boolean, Set)}
495 * A Set NamedArea levels to omit - optional
496 * @param propertyPaths
497 * the initialization strategy
500 * @deprecated use {@link IEditGeoService#composeDistributionInfoFor()} instead
503 public DistributionTree
getOrderedDistributions(
504 Set
<TaxonDescription
> taxonDescriptions
,
505 boolean subAreaPreference
,
506 boolean statusOrderPreference
,
507 Set
<MarkerType
> hideMarkedAreas
,
508 Set
<NamedAreaLevel
> omitLevels
, List
<String
> propertyPaths
);
511 * Generate a string representation of the structured <code>description</code> supplied in natural language
512 * The <code>featureTree</code> will be used to structure the NaturalLanguageDescription.
513 * This method does not require a initialization strategy so there is no <code>propertyPaths</code> parameter.
516 * @param preferredLanguages
520 public String
generateNaturalLanguageDescription(FeatureTree featureTree
,TaxonDescription description
, List
<Language
> preferredLanguages
, String separator
);
523 * Preliminary method to test whether a description contains structured data.
524 * @deprecated The means of determining this fact may change soon, so this method is
525 annotated as being deprecated.
530 public boolean hasStructuredData(DescriptionBase
<?
> description
);
533 * Add the collection of {@link DescriptionElementBase description elements} to the <code>targetDescription</code>.
534 * Remove the description elements from the description they are currently associated with.
536 * @param descriptionElements
537 * @param targetDescription
538 * @param isPaste if true, the elements are only copied (cloned) and not removed from the
541 public void moveDescriptionElementsToDescription(Collection
<DescriptionElementBase
> descriptionElements
, DescriptionBase targetDescription
, boolean isPaste
);
544 * Pager method to get all {@link NamedAreas} instances which are currently used
545 * by {@link Distribution} elements.
548 * The maximum number of description elements returned
550 * The offset (in pageSize chunks) from the start of the result
552 * @param propertyPaths
553 * Properties to initialize in the returned entities, following
554 * the syntax described in
555 * {@link IBeanInitializer#initialize(Object, List)}
556 * @return a Pager for all NamedAreas instances which are currently in use.
559 public Pager
<NamedArea
> pageNamedAreasInUse(Integer pageSize
,
560 Integer pageNumber
, List
<String
> propertyPaths
);