| 38 |
38 |
import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
|
| 39 |
39 |
import eu.etaxonomy.cdm.persistence.query.OrderHint;
|
| 40 |
40 |
|
| 41 |
|
|
| 42 |
41 |
/**
|
| 43 |
42 |
* @author n.hoffmann
|
| 44 |
43 |
* @since Apr 9, 2010
|
| ... | ... | |
| 69 |
68 |
|
| 70 |
69 |
/**
|
| 71 |
70 |
* Retrieves a list of {@link UuidAndTitleCache} objects that have a matchin titleCache
|
|
71 |
*
|
| 72 |
72 |
* @param limit the maximum results
|
| 73 |
73 |
* @param pattern the titleCache that is searched for
|
| 74 |
74 |
* @param classificationUuid if specified only nodes of this classification are retrieved
|
| ... | ... | |
| 119 |
119 |
/**
|
| 120 |
120 |
* Changes the taxon associated with the given taxon node into a synonym of the new accepted taxon node.
|
| 121 |
121 |
* All data associated with the former taxon are moved to the newly accepted taxon.
|
| 122 |
|
*
|
| 123 |
|
* @param oldTaxonNode
|
| 124 |
|
* @param newAcceptedTaxonNode
|
| 125 |
|
* @param synonymType
|
| 126 |
|
* @param citation
|
| 127 |
|
* @param citationMicroReference
|
| 128 |
|
* @param setNameInSource
|
| 129 |
|
* @return
|
| 130 |
|
*
|
| 131 |
122 |
*/
|
| 132 |
123 |
public DeleteResult makeTaxonNodeASynonymOfAnotherTaxonNode(TaxonNode oldTaxonNode, TaxonNode newAcceptedTaxonNode, SynonymType synonymType, Reference citation, String citationMicroReference, boolean setNameInSource) ;
|
| 133 |
124 |
|
| 134 |
125 |
/**
|
| 135 |
126 |
* Changes the taxa associated with the given taxon nodes into synonyms of the new accepted taxon node.
|
| 136 |
127 |
* All data associated with the former taxa are moved to the newly accepted taxon.
|
| 137 |
|
*
|
| 138 |
|
* @param oldTaxonNodes
|
| 139 |
|
* @param newAcceptedTaxonNode
|
| 140 |
|
* @param synonymType
|
| 141 |
|
* @param citation
|
| 142 |
|
* @param citationMicroReference
|
| 143 |
|
* @param setNameInSource
|
| 144 |
|
* @return
|
| 145 |
|
*
|
| 146 |
128 |
*/
|
| 147 |
|
UpdateResult makeTaxonNodeSynonymsOfAnotherTaxonNode(Set<UUID> oldTaxonNodeUuids, UUID newAcceptedTaxonNodeUUIDs,
|
|
129 |
public UpdateResult makeTaxonNodeSynonymsOfAnotherTaxonNode(Set<UUID> oldTaxonNodeUuids, UUID newAcceptedTaxonNodeUUIDs,
|
| 148 |
130 |
SynonymType synonymType, Reference citation, String citationMicroReference, boolean setNameInSource);
|
| 149 |
131 |
|
| 150 |
|
|
| 151 |
132 |
public UpdateResult makeTaxonNodeASynonymOfAnotherTaxonNode(UUID oldTaxonNodeUuid,
|
| 152 |
133 |
UUID newAcceptedTaxonNodeUUID,
|
| 153 |
134 |
SynonymType synonymType,
|
| ... | ... | |
| 155 |
136 |
String citationMicroReference,
|
| 156 |
137 |
boolean setNameInSource) ;
|
| 157 |
138 |
|
| 158 |
|
|
| 159 |
|
/**
|
| 160 |
|
* @param nodeUuids
|
| 161 |
|
* @param config
|
| 162 |
|
* @return
|
| 163 |
|
*/
|
| 164 |
139 |
public DeleteResult deleteTaxonNodes(Collection<UUID> nodeUuids, TaxonDeletionConfigurator config);
|
| 165 |
140 |
|
| 166 |
141 |
/**
|
| 167 |
142 |
* deletes the given taxon node the configurator defines whether the children will be deleted too or not
|
| 168 |
|
*
|
| 169 |
|
* @param node
|
| 170 |
|
* @param conf
|
| 171 |
|
* @return
|
| 172 |
|
*
|
| 173 |
143 |
*/
|
| 174 |
144 |
public DeleteResult deleteTaxonNode(TaxonNode node, TaxonDeletionConfigurator config);
|
|
145 |
|
| 175 |
146 |
/**
|
| 176 |
147 |
* Returns a List of all TaxonNodes of a given Classification.
|
| 177 |
148 |
*
|
| ... | ... | |
| 194 |
165 |
* Counts all TaxonNodes for a given Classification
|
| 195 |
166 |
*
|
| 196 |
167 |
* @param classification - according to the given classification the TaxonNodes are filtered.
|
| 197 |
|
* @return
|
|
168 |
* @return the count result
|
| 198 |
169 |
*/
|
| 199 |
170 |
public int countAllNodesForClassification(Classification classification);
|
| 200 |
171 |
|
| 201 |
|
|
| 202 |
|
/**
|
| 203 |
|
* @param taxonNodeUuid
|
| 204 |
|
* @param newParentTaxonNodeUuid
|
| 205 |
|
* @return
|
| 206 |
|
*/
|
| 207 |
172 |
public UpdateResult moveTaxonNode(UUID taxonNodeUuid, UUID newParentTaxonNodeUuid, int movingType);
|
| 208 |
173 |
|
| 209 |
|
|
| 210 |
|
|
| 211 |
|
|
| 212 |
|
|
| 213 |
|
/**
|
| 214 |
|
* @param taxonNode
|
| 215 |
|
* @param newParent
|
| 216 |
|
* @param parent
|
| 217 |
|
* @return
|
| 218 |
|
*/
|
| 219 |
|
UpdateResult moveTaxonNode(TaxonNode taxonNode, TaxonNode newParent, int movingType);
|
|
174 |
public UpdateResult moveTaxonNode(TaxonNode taxonNode, TaxonNode newParent, int movingType);
|
| 220 |
175 |
|
| 221 |
176 |
/**
|
| 222 |
177 |
* deletes the given taxon nodes
|
| 223 |
|
*
|
| 224 |
|
* @param nodes
|
| 225 |
|
* @param config
|
| 226 |
|
* @return
|
| 227 |
|
*
|
| 228 |
178 |
*/
|
| 229 |
179 |
public DeleteResult deleteTaxonNodes(List<TaxonNode> list, TaxonDeletionConfigurator config);
|
| 230 |
180 |
|
| ... | ... | |
| 242 |
192 |
public Pager<TaxonNodeAgentRelation> pageTaxonNodeAgentRelations(UUID taxonUuid, UUID classificationUuid,
|
| 243 |
193 |
UUID agentUuid, UUID rankUuid, UUID relTypeUuid, Integer pageSize, Integer pageIndex, List<String> propertyPaths);
|
| 244 |
194 |
|
| 245 |
|
/**
|
| 246 |
|
* @param parentNodeUuid
|
| 247 |
|
* @param newTaxon
|
| 248 |
|
* @param ref
|
| 249 |
|
* @param microref
|
| 250 |
|
* @return
|
| 251 |
|
*/
|
| 252 |
|
public UpdateResult createNewTaxonNode(UUID parentNodeUuid, Taxon newTaxon, Reference ref, String microref);
|
|
195 |
public UpdateResult createNewTaxonNode(UUID parentNodeUuid, Taxon newTaxon, Reference ref, String microref);
|
| 253 |
196 |
|
| 254 |
|
/**
|
| 255 |
|
* @param taxonNodeUUID
|
| 256 |
|
* @param agentUUID
|
| 257 |
|
* @param relationshipType
|
| 258 |
|
* @return
|
| 259 |
|
*/
|
| 260 |
197 |
public UpdateResult addTaxonNodeAgentRelation(UUID taxonNodeUUID, UUID agentUUID, DefinedTerm relationshipType);
|
| 261 |
198 |
|
| 262 |
199 |
/**
|
| ... | ... | |
| 273 |
210 |
* Depending on the configuration, also synonym secundum will be set.
|
| 274 |
211 |
* See {@link SetSecundumForSubtreeConfigurator} for further configuration
|
| 275 |
212 |
* options.
|
| 276 |
|
* @param b
|
| 277 |
|
* @param configurator
|
| 278 |
213 |
* @return UpdateResult
|
| 279 |
214 |
*/
|
| 280 |
215 |
public UpdateResult setSecundumForSubtree(SecundumForSubtreeConfigurator config);
|
| ... | ... | |
| 282 |
217 |
|
| 283 |
218 |
/**
|
| 284 |
219 |
* Sets the publish flag for all taxa and/or synonyms of the subtree.
|
| 285 |
|
* @param configurator
|
| 286 |
|
* @return
|
| 287 |
220 |
*/
|
| 288 |
221 |
public UpdateResult setPublishForSubtree(PublishForSubtreeConfigurator configurator);
|
| 289 |
222 |
|
| 290 |
|
|
| 291 |
223 |
/**
|
| 292 |
224 |
* Returns a list of taxon node {@link UUID uuids} according to the given filter.
|
| 293 |
|
* @param filter
|
| 294 |
|
* @return
|
| 295 |
225 |
*/
|
| 296 |
226 |
public long count(TaxonNodeFilter filter);
|
| 297 |
227 |
|
| 298 |
228 |
/**
|
| 299 |
229 |
* Returns a list of taxon node {@link UUID uuids} according to the given filter.
|
| 300 |
|
* @param filter
|
| 301 |
|
* @return
|
| 302 |
230 |
*/
|
| 303 |
231 |
public List<UUID> uuidList(TaxonNodeFilter filter);
|
| 304 |
232 |
|
| 305 |
233 |
/**
|
| 306 |
234 |
* Returns a list of taxon node IDs according to the given filter.
|
| 307 |
|
* @param filter
|
| 308 |
|
* @return
|
| 309 |
235 |
*/
|
| 310 |
236 |
public List<Integer> idList(TaxonNodeFilter filter);
|
| 311 |
237 |
|
| 312 |
|
// /**
|
| 313 |
|
// * @param configurator
|
| 314 |
|
// * @return
|
| 315 |
|
// */
|
| 316 |
|
// UUID monitSetSecundum(SecundumForSubtreeConfigurator configurator);
|
|
238 |
public List<TaxonNodeDto> listChildNodesAsTaxonNodeDto(UuidAndTitleCache<TaxonNode> parent);
|
| 317 |
239 |
|
|
240 |
public List<TaxonNodeDto> listChildNodesAsTaxonNodeDto(ITaxonTreeNode parent);
|
| 318 |
241 |
|
| 319 |
|
/**
|
| 320 |
|
* @param parent
|
| 321 |
|
* @return
|
| 322 |
|
*/
|
| 323 |
|
List<TaxonNodeDto> listChildNodesAsTaxonNodeDto(UuidAndTitleCache<TaxonNode> parent);
|
| 324 |
|
|
| 325 |
|
/**
|
| 326 |
|
* @param parent
|
| 327 |
|
* @return
|
| 328 |
|
*/
|
| 329 |
|
List<TaxonNodeDto> listChildNodesAsTaxonNodeDto(ITaxonTreeNode parent);
|
| 330 |
|
|
| 331 |
|
/**
|
| 332 |
|
* @param taxonNodeUuids
|
| 333 |
|
* @param newParentNodeUuid
|
| 334 |
|
* @param movingType
|
| 335 |
|
* @param monitor
|
| 336 |
|
* @return
|
| 337 |
|
*/
|
| 338 |
|
UpdateResult moveTaxonNodes(Set<UUID> taxonNodeUuids, UUID newParentNodeUuid, int movingType,
|
|
242 |
public UpdateResult moveTaxonNodes(Set<UUID> taxonNodeUuids, UUID newParentNodeUuid, int movingType,
|
| 339 |
243 |
IProgressMonitor monitor);
|
| 340 |
244 |
|
| 341 |
245 |
/**
|
| ... | ... | |
| 349 |
253 |
*/
|
| 350 |
254 |
public TaxonNodeDto findCommonParentDto(Collection<TaxonNodeDto> nodes);
|
| 351 |
255 |
|
| 352 |
|
/**
|
| 353 |
|
* @param taxonNodeUuid
|
| 354 |
|
* @return
|
| 355 |
|
*/
|
| 356 |
|
TaxonNodeDto dto(UUID taxonNodeUuid);
|
|
256 |
public TaxonNodeDto dto(UUID taxonNodeUuid);
|
| 357 |
257 |
|
| 358 |
|
/**
|
| 359 |
|
* @param parentNodeUuid
|
| 360 |
|
* @param areas
|
| 361 |
|
* @param authentication
|
| 362 |
|
* @return
|
| 363 |
|
*/
|
| 364 |
|
List<TaxonDistributionDTO> getTaxonDistributionDTOForSubtree(UUID parentNodeUuid, List<String> propertyPaths, Authentication authentication);
|
|
258 |
public List<TaxonDistributionDTO> getTaxonDistributionDTOForSubtree(UUID parentNodeUuid, List<String> propertyPaths, Authentication authentication);
|
| 365 |
259 |
|
| 366 |
|
/**
|
| 367 |
|
* @param parentNodeUuid
|
| 368 |
|
* @param areas
|
| 369 |
|
* @return
|
| 370 |
|
*/
|
| 371 |
|
List<TaxonDistributionDTO> getTaxonDistributionDTOForSubtree(UUID parentNodeUuid, List<String> propertyPaths);
|
|
260 |
public List<TaxonDistributionDTO> getTaxonDistributionDTOForSubtree(UUID parentNodeUuid, List<String> propertyPaths);
|
| 372 |
261 |
|
| 373 |
|
/**
|
| 374 |
|
* @param parentNodeUuid
|
| 375 |
|
* @param newTaxonNode
|
| 376 |
|
* @return
|
| 377 |
|
*/
|
| 378 |
|
UpdateResult saveNewTaxonNode(TaxonNode newTaxonNode);
|
|
262 |
public UpdateResult saveNewTaxonNode(TaxonNode newTaxonNode);
|
| 379 |
263 |
|
| 380 |
|
/**
|
| 381 |
|
* @param clazz
|
| 382 |
|
* @param restrictions
|
| 383 |
|
* @param pageSize
|
| 384 |
|
* @param pageIndex
|
| 385 |
|
* @param orderHints
|
| 386 |
|
* @param propertyPaths
|
| 387 |
|
* @param includeUnpublished
|
| 388 |
|
* @return
|
| 389 |
|
*/
|
| 390 |
264 |
public <S extends TaxonNode> Pager<S> page(Class<S> clazz, List<Restriction<?>> restrictions, Integer pageSize, Integer pageIndex,
|
| 391 |
265 |
List<OrderHint> orderHints, List<String> propertyPaths, boolean includeUnpublished);
|
| 392 |
|
|
| 393 |
|
/**
|
| 394 |
|
* @param classification
|
| 395 |
|
* @param rank
|
| 396 |
|
* @return
|
| 397 |
|
*/
|
| 398 |
|
public TaxonNodeDto taxonNodeDtoParentRank(Classification classification, Rank rank, TaxonName name);
|
| 399 |
|
|
| 400 |
|
|
| 401 |
|
|
| 402 |
266 |
|
|
267 |
public TaxonNodeDto taxonNodeDtoParentRank(Classification classification, Rank rank, TaxonName name);
|
| 403 |
268 |
}
|
cleanup