|
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
|
|
|
13
|
import javax.persistence.Entity;
|
|
14
|
|
|
15
|
import org.apache.log4j.Logger;
|
|
16
|
|
|
17
|
import eu.etaxonomy.cdm.model.common.DefinedTermBase;
|
|
18
|
import eu.etaxonomy.cdm.model.taxon.SynonymRelationship;
|
|
19
|
|
|
20
|
/**
|
|
21
|
* The class representing types (categories) of {@link BibtexReference BibTeX references}
|
|
22
|
* (like "article" or "book").
|
|
23
|
* <P>
|
|
24
|
* A standard set of BibTeX entry type instances
|
|
25
|
* (see "http://en.wikipedia.org/wiki/BibTeX") will be automatically created
|
|
26
|
* as the project starts. But this class allows to extend this standard set
|
|
27
|
* by creating new instances of additional BibTeX entry types if needed.
|
|
28
|
*
|
|
29
|
* @author m.doering
|
|
30
|
* @version 1.0
|
|
31
|
* @created 08-Nov-2007 13:06:12
|
|
32
|
*/
|
|
33
|
@Entity
|
|
34
|
public class BibtexEntryType extends DefinedTermBase {
|
|
35
|
private static final Logger logger = Logger.getLogger(BibtexEntryType.class);
|
|
36
|
|
|
37
|
|
|
38
|
// ************* CONSTRUCTORS *************/
|
|
39
|
/**
|
|
40
|
* Class constructor: creates a new empty BibTeX entry type instance.
|
|
41
|
*
|
|
42
|
* @see #BibtexEntryType(String, String, String)
|
|
43
|
*/
|
|
44
|
protected BibtexEntryType() {
|
|
45
|
super();
|
|
46
|
}
|
|
47
|
|
|
48
|
/**
|
|
49
|
* Class constructor: creates an additional BibTeX entry type instance with
|
|
50
|
* a description (in the {@link common.Language#DEFAULT() default language}), a label and a label abbreviation.
|
|
51
|
*
|
|
52
|
* @param term the string (in the default language) describing the
|
|
53
|
* new BibTeX entry type to be created
|
|
54
|
* @param label the string identifying the new BibTeX entry
|
|
55
|
* type to be created
|
|
56
|
* @param labelAbbrev the string identifying (in abbreviated form) the
|
|
57
|
* new BibTeX entry type to be created
|
|
58
|
* @see #BibtexEntryType()
|
|
59
|
*/
|
|
60
|
protected BibtexEntryType(String term, String label, String labelAbbrev) {
|
|
61
|
super(term, label, labelAbbrev);
|
|
62
|
}
|
|
63
|
|
|
64
|
//********* METHODS **************************************/
|
|
65
|
|
|
66
|
/**
|
|
67
|
* Creates a new empty BibTeX entry type instance.
|
|
68
|
*
|
|
69
|
* @see #NewInstance(String, String, String)
|
|
70
|
*/
|
|
71
|
public static BibtexEntryType NewInstance(){
|
|
72
|
return new BibtexEntryType();
|
|
73
|
}
|
|
74
|
|
|
75
|
|
|
76
|
/**
|
|
77
|
* Creates an additional BibTeX entry type instance with
|
|
78
|
* a description (in the {@link common.Language#DEFAULT() default language}), a label and a label abbreviation.
|
|
79
|
*
|
|
80
|
* @param term the string (in the default language) describing the
|
|
81
|
* new BibTeX entry type to be created
|
|
82
|
* @param label the string identifying the new BibTeX entry
|
|
83
|
* type to be created
|
|
84
|
* @param labelAbbrev the string identifying (in abbreviated form) the
|
|
85
|
* new BibTeX entry type to be created
|
|
86
|
* @see #NewInstance()
|
|
87
|
*/
|
|
88
|
public static BibtexEntryType NewInstance(String term, String label, String labelAbbrev){
|
|
89
|
return new BibtexEntryType(term, label, labelAbbrev);
|
|
90
|
}
|
|
91
|
|
|
92
|
/**
|
|
93
|
* Returns the BibTeX entry "article": an article from a journal or
|
|
94
|
* magazine. Required attributes in {@link BibtexReference BibTeX reference} are:
|
|
95
|
* author, title, journal and year. Optional attributes are: volume, number,
|
|
96
|
* pages, month and note.<BR>
|
|
97
|
* This BibTeX entry type corresponds to the {@link Article Article} subclass of
|
|
98
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
99
|
*/
|
|
100
|
public static final BibtexEntryType ARTICLE(){
|
|
101
|
return null;
|
|
102
|
}
|
|
103
|
|
|
104
|
/**
|
|
105
|
* Returns the BibTeX entry "book" (with an explicit publisher). Required
|
|
106
|
* attributes in {@link BibtexReference BibTeX reference} are: author/editor, title,
|
|
107
|
* publisher and year. Optional attributes are: volume, series, address,
|
|
108
|
* edition, month and note.<BR>
|
|
109
|
* This BibTeX entry type corresponds to the {@link Book Book} subclass of
|
|
110
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
111
|
*/
|
|
112
|
public static final BibtexEntryType BOOK(){
|
|
113
|
return null;
|
|
114
|
}
|
|
115
|
|
|
116
|
/**
|
|
117
|
* Returns the BibTeX entry "booklet": a work that is printed and bound, but
|
|
118
|
* without a named publisher or sponsoring institution.
|
|
119
|
* Required attribute in {@link BibtexReference BibTeX reference} is: title. Optional
|
|
120
|
* attributes are: author, howpublished, address, month, year and note.<BR>
|
|
121
|
* This BibTeX entry type corresponds to the {@link Book Book} subclass of
|
|
122
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
123
|
*/
|
|
124
|
public static final BibtexEntryType BOOKLET(){
|
|
125
|
return null;
|
|
126
|
}
|
|
127
|
|
|
128
|
/**
|
|
129
|
* Returns the BibTeX entry "inbook": a part of a book, which may be a
|
|
130
|
* chapter (or section or whatever) and/or a range of pages. Required
|
|
131
|
* attributes in {@link BibtexReference BibTeX reference} are: author/editor, title,
|
|
132
|
* chapter/pages, publisher and year. Optional attributes are: volume,
|
|
133
|
* series, address, edition, month and note.<BR>
|
|
134
|
* This BibTeX entry type corresponds to the {@link BookSection BookSection} subclass of
|
|
135
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
136
|
*/
|
|
137
|
public static final BibtexEntryType INBOOK(){
|
|
138
|
return null;
|
|
139
|
}
|
|
140
|
|
|
141
|
/**
|
|
142
|
* Returns the BibTeX entry "incollection": a part of a book having its own
|
|
143
|
* title. Required attributes in {@link BibtexReference BibTeX reference} are: author, title,
|
|
144
|
* booktitle and year. Optional attributes are: editor, pages, organization,
|
|
145
|
* publisher, address, month and note.<BR>
|
|
146
|
* This BibTeX entry type corresponds to the {@link BookSection BookSection} subclass of
|
|
147
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
148
|
*/
|
|
149
|
public static final BibtexEntryType INCOLLECTION(){
|
|
150
|
return null;
|
|
151
|
}
|
|
152
|
|
|
153
|
/**
|
|
154
|
* Returns the BibTeX entry "proceedings" of a conference. Required
|
|
155
|
* attributes in {@link BibtexReference BibTeX reference} are: title and year. Optional
|
|
156
|
* attributes are: editor, publisher, organization, address, month and note.<BR>
|
|
157
|
* This BibTeX entry type corresponds to the {@link Proceedings Proceedings} subclass of
|
|
158
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
159
|
*/
|
|
160
|
public static final BibtexEntryType PROCEEDINGS(){
|
|
161
|
return null;
|
|
162
|
}
|
|
163
|
|
|
164
|
/**
|
|
165
|
* Returns the BibTeX entry "inproceedings": an article in a conference
|
|
166
|
* proceedings. Required attributes in {@link BibtexReference BibTeX reference} are:
|
|
167
|
* author, title, booktitle and year. Optional attributes are: editor,
|
|
168
|
* pages, organization, publisher, address, month and note.<BR>
|
|
169
|
* This BibTeX entry type corresponds to the {@link InProceedings InProceedings} subclass of
|
|
170
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
171
|
*
|
|
172
|
* @see #CONFERENCE()
|
|
173
|
*/
|
|
174
|
public static final BibtexEntryType INPROCEEDINGS(){
|
|
175
|
return null;
|
|
176
|
}
|
|
177
|
|
|
178
|
/**
|
|
179
|
* Returns the BibTeX entry "conference": the same meaning as
|
|
180
|
* "inproceedings". This type was introduced in BibTex format only for
|
|
181
|
* compatibility with previous bibliographical standards.<BR>
|
|
182
|
* This BibTeX entry type corresponds to the {@link InProceedings InProceedings} subclass of
|
|
183
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
184
|
*
|
|
185
|
* @see #INPROCEEDINGS()
|
|
186
|
*/
|
|
187
|
public static final BibtexEntryType CONFERENCE(){
|
|
188
|
return null;
|
|
189
|
}
|
|
190
|
|
|
191
|
/**
|
|
192
|
* Returns the BibTeX entry "manual" (a technical documentation). Required
|
|
193
|
* attribute in {@link BibtexReference BibTeX reference} is: title. Optional attributes are:
|
|
194
|
* author, organization, address, edition, month, year and note.<BR>
|
|
195
|
* This BibTeX entry type corresponds to the {@link Generic Generic} subclass of
|
|
196
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
197
|
*/
|
|
198
|
public static final BibtexEntryType MANUAL(){
|
|
199
|
return null;
|
|
200
|
}
|
|
201
|
|
|
202
|
/**
|
|
203
|
* Returns the BibTeX entry "masterthesis" (a master's thesis). Required
|
|
204
|
* attributes in {@link BibtexReference BibTeX reference} are: author, title, school and year.
|
|
205
|
* Optional attributes are: address, month and note.<BR>
|
|
206
|
* This BibTeX entry type corresponds to the {@link Thesis Thesis} subclass of
|
|
207
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
208
|
*/
|
|
209
|
public static final BibtexEntryType MASTERTHESIS(){
|
|
210
|
return null;
|
|
211
|
}
|
|
212
|
|
|
213
|
/**
|
|
214
|
* Returns the BibTeX entry "phdthesis" (a Ph.D. thesis). Required
|
|
215
|
* attributes in {@link BibtexReference BibTeX reference} are: author, title, school and year.
|
|
216
|
* Optional attributes are: address, month and note.<BR>
|
|
217
|
* This BibTeX entry type corresponds to the {@link Thesis Thesis} subclass of
|
|
218
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
219
|
*/
|
|
220
|
public static final BibtexEntryType PHDTHESIS(){
|
|
221
|
return null;
|
|
222
|
}
|
|
223
|
|
|
224
|
/**
|
|
225
|
* Returns the BibTeX entry "techreport": a report published by a school or
|
|
226
|
* other institution, usually numbered within a series. Required attributes
|
|
227
|
* in {@link BibtexReference BibTeX reference} are: author, title, institution and year.
|
|
228
|
* Optional attributes are: type, number, address, month and note.<BR>
|
|
229
|
* This BibTeX entry type corresponds to the {@link Report Report} subclass of
|
|
230
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
231
|
*/
|
|
232
|
public static final BibtexEntryType TECHREPORT(){
|
|
233
|
return null;
|
|
234
|
}
|
|
235
|
|
|
236
|
/**
|
|
237
|
* Returns the BibTeX entry "unpublished": a document having an author and
|
|
238
|
* title, but not formally published. Required attributes in
|
|
239
|
* {@link BibtexReference BibTeX reference} are: author, title and note. Optional attributes are:
|
|
240
|
* month and year.<BR>
|
|
241
|
* This BibTeX entry type corresponds to the {@link Generic Generic} subclass of
|
|
242
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
243
|
*/
|
|
244
|
public static final BibtexEntryType UNPUBLISHED(){
|
|
245
|
return null;
|
|
246
|
}
|
|
247
|
|
|
248
|
/**
|
|
249
|
* Returns the BibTeX entry "misc" used when nothing else fits. There are no
|
|
250
|
* required attributes in {@link BibtexReference BibTeX reference}. Optional attributes are:
|
|
251
|
* author, title, howpublished, month, year and note.<BR>
|
|
252
|
* This BibTeX entry type corresponds to the {@link Generic Generic} subclass of
|
|
253
|
* {@link StrictReferenceBase StrictReferenceBase}.
|
|
254
|
*/
|
|
255
|
public static final BibtexEntryType MISC(){
|
|
256
|
return null;
|
|
257
|
}
|
|
258
|
|
|
259
|
}
|