Project

General

Profile

Download (2.42 KB) Statistics
| Branch: | Tag: | Revision:
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.strategy.cache;
11

    
12

    
13

    
14
/**
15
 * Tags for atomised taxon name strings and atomised reference citation strings.
16
 * Used by {@link TaggedText}.
17
 *
18
 * @author a.kohlbecker
19
 * @version 1.0
20
 * @created 13.12.2007 12:04:15
21
 *
22
 */
23
public enum TagEnum {
24

    
25
	/**
26
	 *  A taxon name including genus name, epithet etc.
27
	 */
28
	name,
29
	/**
30
	 *  A name rank abbreviation, e.g. subsp.
31
	 */
32
	rank,
33
	/**
34
	 * Non-atomised addition to a taxon name or a taxon not ruled by a nomenclatural code
35
	 */
36
	appendedPhrase,
37
	/**
38
	 * The authors of a reference, also used in taxon names
39
	 */
40
	authors,
41
	/**
42
	 * a reference
43
	 */
44
	reference,
45
	/**
46
     * a secundum reference (for TaxonBase)
47
     */
48
    secReference,
49
	/**
50
	 * Volume, page number etc. of a reference
51
	 */
52
	microreference,
53
	/**
54
	 * Publication year of a reference
55
	 */
56
	year,
57
	/**
58
	 *  A full taxon name including all name information and nomenclatural
59
	 *  reference information
60
	 */
61
	fullName,
62
	/**
63
	 *  The nomenclatural status of a name
64
	 */
65
	nomStatus,
66
	/**
67
	 *  A separator to separate two tags () .
68
	 *  A separator should include all needed whitespaces. So adding of whitespace
69
	 *  is not needed if a separator is given.
70
	 */
71
	separator,
72
	/**
73
     *  A separator that needs to be added to the previous text if and only if
74
     *  the previous tag is used (not filtered) and if it is not the last tag
75
     *  in the list.
76
     *  A post-separator should include all needed whitespaces. So adding of whitespace
77
     *  is not needed if a post-separator is given.
78
     */
79
    postSeparator,
80
	/**
81
	 *  The hybrid sign.
82
	 */
83
	hybridSign,
84

    
85
	;
86

    
87

    
88
	public boolean isName(){
89
		return this == name;
90
	}
91
	public boolean isRank(){
92
		return this == rank;
93
	}
94
	public boolean isAuthors(){
95
		return this == authors;
96
	}
97
	public boolean isAppendedPhrase(){
98
		return this == appendedPhrase;
99
	}
100
	public boolean isReference(){
101
		return this == reference;
102
	}
103
	public boolean isYear(){
104
		return this == year;
105
	}
106
	public boolean isFullName(){
107
		return this == fullName;
108
	}
109

    
110
	public boolean isNomStatus(){
111
		return this == nomStatus;
112
	}
113
	public boolean isSeparator(){
114
		return this == separator || this == postSeparator;
115
	}
116
	public boolean isHybridSign(){
117
		return this == hybridSign;
118
	}
119

    
120
}
(2-2/4)