|
1
|
/**
|
|
2
|
* Copyright (C) 2007 EDIT
|
|
3
|
* European Distributed Institute of Taxonomy
|
|
4
|
* http://www.e-taxonomy.eu
|
|
5
|
*
|
|
6
|
* The contents of this file are subject to the Mozilla Public License Version 1.1
|
|
7
|
* See LICENSE.TXT at the top of this package for the full license terms.
|
|
8
|
*/
|
|
9
|
|
|
10
|
package eu.etaxonomy.cdm.model.reference;
|
|
11
|
|
|
12
|
import eu.etaxonomy.cdm.model.common.IIdentifiableEntity;
|
|
13
|
import eu.etaxonomy.cdm.model.common.IParsable;
|
|
14
|
import eu.etaxonomy.cdm.model.common.TimePeriod;
|
|
15
|
|
|
16
|
|
|
17
|
/**
|
|
18
|
* Interface providing methods for nomenclatural references.
|
|
19
|
*
|
|
20
|
* @author m.doering
|
|
21
|
* @version 1.0
|
|
22
|
* @created 08-Nov-2007 13:06:29
|
|
23
|
*/
|
|
24
|
public interface INomenclaturalReference extends IIdentifiableEntity, IParsable{
|
|
25
|
|
|
26
|
public final String MICRO_REFERENCE_TOKEN = "@@MicroReference";
|
|
27
|
|
|
28
|
/**
|
|
29
|
* Returns a formatted string containing the reference citation excluding
|
|
30
|
* authors but including the details as used in a {@link TaxonNameBase taxon name}.
|
|
31
|
*/
|
|
32
|
public String getNomenclaturalCitation(String microReference);
|
|
33
|
|
|
34
|
/**
|
|
35
|
* Returns a string representation for the year of publication / creation
|
|
36
|
* of a reference.
|
|
37
|
*/
|
|
38
|
public String getYear();
|
|
39
|
|
|
40
|
/**
|
|
41
|
* Returns the boolean value indicating whether the used parser
|
|
42
|
* method was able to parse the string designating the reference
|
|
43
|
* successfully (false) or not (true).
|
|
44
|
*/
|
|
45
|
public boolean getHasProblem();
|
|
46
|
|
|
47
|
public void setDatePublished(TimePeriod datePublished);
|
|
48
|
|
|
49
|
|
|
50
|
}
|