Revision 94d72025
Added by Andreas Müller almost 6 years ago
| cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/name/ITaxonNameBase.java | ||
|---|---|---|
| 17 | 17 |
import eu.etaxonomy.cdm.model.common.IParsable; |
| 18 | 18 |
import eu.etaxonomy.cdm.model.common.IRelated; |
| 19 | 19 |
import eu.etaxonomy.cdm.model.common.IdentifiableEntity; |
| 20 |
import eu.etaxonomy.cdm.model.description.DescriptionElementSource; |
|
| 20 | 21 |
import eu.etaxonomy.cdm.model.description.TaxonNameDescription; |
| 21 | 22 |
import eu.etaxonomy.cdm.model.occurrence.DerivedUnit; |
| 22 |
import eu.etaxonomy.cdm.model.reference.INomenclaturalReference; |
|
| 23 | 23 |
import eu.etaxonomy.cdm.model.reference.Reference; |
| 24 | 24 |
import eu.etaxonomy.cdm.model.taxon.Synonym; |
| 25 | 25 |
import eu.etaxonomy.cdm.model.taxon.Taxon; |
| ... | ... | |
| 335 | 335 |
public void setRank(Rank rank); |
| 336 | 336 |
|
| 337 | 337 |
/** |
| 338 |
* Returns the {@link eu.etaxonomy.cdm.model.reference.INomenclaturalReference nomenclatural reference} of <i>this</i> taxon name.
|
|
| 338 |
* Returns the {@link eu.etaxonomy.cdm.model.reference.Reference nomenclatural reference} of <i>this</i> taxon name.
|
|
| 339 | 339 |
* The nomenclatural reference is here meant to be the one publication |
| 340 | 340 |
* <i>this</i> taxon name was originally published in while fulfilling the formal |
| 341 | 341 |
* requirements as specified by the corresponding {@link NomenclaturalCode nomenclatural code}.
|
| 342 | 342 |
* |
| 343 |
* @see eu.etaxonomy.cdm.model.reference.INomenclaturalReference |
|
| 344 | 343 |
* @see eu.etaxonomy.cdm.model.reference.Reference |
| 344 |
* @see #getNomenclaturalSource() |
|
| 345 | 345 |
*/ |
| 346 |
public INomenclaturalReference getNomenclaturalReference();
|
|
| 346 |
public Reference getNomenclaturalReference(); |
|
| 347 | 347 |
|
| 348 | 348 |
/** |
| 349 | 349 |
* Assigns a {@link eu.etaxonomy.cdm.model.reference.INomenclaturalReference nomenclatural reference} to <i>this</i> taxon name.
|
| 350 | 350 |
* The corresponding {@link eu.etaxonomy.cdm.model.reference.Reference.isNomenclaturallyRelevant nomenclaturally relevant flag} will be set to true
|
| 351 | 351 |
* as it is obviously used for nomenclatural purposes. |
| 352 | 352 |
* |
| 353 |
* @throws IllegalArgumentException if parameter <code>nomenclaturalReference</code> is not assignable from {@link INomenclaturalReference}
|
|
| 354 | 353 |
* @see #getNomenclaturalReference() |
| 355 | 354 |
*/ |
| 356 |
public void setNomenclaturalReference(INomenclaturalReference nomenclaturalReference); |
|
| 357 |
|
|
| 358 |
/** |
|
| 359 |
* Returns the appended phrase string assigned to <i>this</i> taxon name. |
|
| 360 |
* The appended phrase is a non-atomised addition to a name. It is |
|
| 361 |
* not ruled by a nomenclatural code. |
|
| 362 |
*/ |
|
| 363 |
public String getAppendedPhrase(); |
|
| 364 |
|
|
| 365 |
/** |
|
| 366 |
* @see #getAppendedPhrase() |
|
| 367 |
*/ |
|
| 368 |
public void setAppendedPhrase(String appendedPhrase); |
|
| 355 |
public void setNomenclaturalReference(Reference nomenclaturalReference); |
|
| 369 | 356 |
|
| 370 | 357 |
/** |
| 371 | 358 |
* Returns the details string of the {@link #getNomenclaturalReference() nomenclatural reference} assigned
|
| ... | ... | |
| 374 | 361 |
* (implicitly) pages but can also be figures or tables or any other |
| 375 | 362 |
* element of a publication. A nomenclatural micro reference (details) |
| 376 | 363 |
* requires the existence of a nomenclatural reference. |
| 364 |
* |
|
| 365 |
* @see #getNomenclaturalReference() |
|
| 366 |
* @see #getNomenclaturalSource() |
|
| 377 | 367 |
*/ |
| 378 |
//Details of the nomenclatural reference (protologue). |
|
| 379 | 368 |
public String getNomenclaturalMicroReference(); |
| 380 | 369 |
|
| 381 | 370 |
/** |
| ... | ... | |
| 383 | 372 |
*/ |
| 384 | 373 |
public void setNomenclaturalMicroReference(String nomenclaturalMicroReference); |
| 385 | 374 |
|
| 375 |
/** |
|
| 376 |
* Sets the nomenclatural source which is a combination of the nomenclatural reference |
|
| 377 |
* and the detail information (exact page, table, figure, ...) where to find this name |
|
| 378 |
* for the first time. |
|
| 379 |
* |
|
| 380 |
* @see #getNomenclaturalReference() |
|
| 381 |
* @see #getNomenclaturalMicroReference() |
|
| 382 |
*/ |
|
| 383 |
public DescriptionElementSource getNomenclaturalSource(); |
|
| 384 |
|
|
| 385 |
/** |
|
| 386 |
* Sets the nomenclatural source |
|
| 387 |
* @param nomenclaturalSource |
|
| 388 |
*/ |
|
| 389 |
public void setNomenclaturalSource(DescriptionElementSource nomenclaturalSource); |
|
| 390 |
|
|
| 391 |
|
|
| 392 |
/** |
|
| 393 |
* Returns the appended phrase string assigned to <i>this</i> taxon name. |
|
| 394 |
* The appended phrase is a non-atomised addition to a name. It is |
|
| 395 |
* not ruled by a nomenclatural code. |
|
| 396 |
*/ |
|
| 397 |
public String getAppendedPhrase(); |
|
| 398 |
|
|
| 399 |
/** |
|
| 400 |
* @see #getAppendedPhrase() |
|
| 401 |
*/ |
|
| 402 |
public void setAppendedPhrase(String appendedPhrase); |
|
| 403 |
|
|
| 404 |
|
|
| 386 | 405 |
/** |
| 387 | 406 |
* @param warnings |
| 388 | 407 |
*/ |
Also available in: Unified diff
ref #6581 first incomplete version for making nomenclatural reference an orginal source