cdmlibrary/src/main/java/eu/etaxonomy/cdm/model/reference/BibtexReference.java

   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 etaxonomy.cdm.model.reference;
  11
  12
  13 import org.apache.log4j.Logger;
  14
  15 /**
  16  * @author m.doering
  17  * @version 1.0
  18  * @created 02-Nov-2007 18:14:36
  19  */
  20 public class BibtexReference extends ReferenceBase implements INomenclaturalReference {
  21         static Logger logger = Logger.getLogger(BibtexReference.class);
  22
  23         //The name(s) of the author(s) (in the case of more than one author, separated by and)
  24         @Description("The name(s) of the author(s) (in the case of more than one author, separated by and)")
  25         private String author;
  26         //The journal or magazine the work was published in
  27
  28         @Description("The journal or magazine the work was published in
  29         ")
  30         private String journal;
  31         //The title of the book, if only part of it is being cited
  32         @Description("The title of the book, if only part of it is being cited")
  33         private String booktitle;
  34         //The chapter number
  35         @Description("The chapter number")
  36         private String chapter;
  37         //The title of the work
  38
  39         @Description("The title of the work
  40         ")
  41         private String title;
  42         //The series of books the book was published in (e.g. "The Hardy Boys")
  43
  44         @Description("The series of books the book was published in (e.g. "The Hardy Boys")
  45         ")
  46         private String series;
  47         //The edition of a book, long form (such as "first" or "second")
  48         @Description("The edition of a book, long form (such as "first" or "second")")
  49         private String edition;
  50         //The volume of a journal or multi-volume book
  51
  52         @Description("The volume of a journal or multi-volume book
  53         ")
  54         private String volume;
  55         //The "number" of a journal, magazine, or tech-report, if applicable. (Most publications have a "volume", but no "number"
  56         //field.)
  57         //
  58
  59         @Description("The "number" of a journal, magazine, or tech-report, if applicable. (Most publications have a "volume", but no "number" field.)
  60
  61         ")
  62         private String number;
  63         //Page numbers, separated either by commas or double-hyphens
  64
  65         @Description("Page numbers, separated either by commas or double-hyphens
  66         ")
  67         private String pages;
  68         //An annotation for annotated bibliography styles (not typical)
  69         @Description("An annotation for annotated bibliography styles (not typical)")
  70         private String annote;
  71         //The name(s) of the editor(s)
  72
  73         @Description("The name(s) of the editor(s)
  74         ")
  75         private String editor;
  76         //The institution that was involved in the publishing, but not necessarily the publisher
  77
  78         @Description("The institution that was involved in the publishing, but not necessarily the publisher
  79         ")
  80         private String institution;
  81         //The school where the thesis was written
  82         @Description("The school where the thesis was written ")
  83         private String school;
  84         //The conference sponsor
  85
  86         @Description("The conference sponsor
  87         ")
  88         private String organization;
  89         //The publisher's name
  90         //
  91
  92         @Description("The publisher's name
  93
  94         ")
  95         private String publisher;
  96         //Publisher's address (usually just the city, but can be the full address for lesser-known publishers)
  97         @Description("Publisher's address (usually just the city, but can be the full address for lesser-known publishers)")
  98         private String address;
  99         //How it was published, if the publishing method is nonstandard
 100
 101         @Description("How it was published, if the publishing method is nonstandard
 102         ")
 103         private String howpublished;
 104         //The type of tech-report, for example, "Research Note"
 105         //
 106
 107         @Description("The type of tech-report, for example, "Research Note"
 108
 109         ")
 110         private String type;
 111         //The month of publication (or, if unpublished, the month of creation)
 112         //
 113
 114         @Description("The month of publication (or, if unpublished, the month of creation)
 115
 116         ")
 117         private String month;
 118         //The year of publication (or, if unpublished, the year of creation)
 119
 120         @Description("The year of publication (or, if unpublished, the year of creation)
 121         ")
 122         private String year;
 123         //A specification of an electronic publication, often a preprint or a technical report
 124
 125         @Description("A specification of an electronic publication, often a preprint or a technical report
 126         ")
 127         private String eprint;
 128         //Miscellaneous extra information
 129         //
 130
 131         @Description("Miscellaneous extra information
 132
 133         ")
 134         private String note;
 135         private BibtexReference crossref;
 136
 137         public BibtexReference getCrossref(){
 138                 return crossref;
 139         }
 140
 141         /**
 142          *
 143          * @param newVal
 144          */
 145         public void setCrossref(BibtexReference newVal){
 146                 crossref = newVal;
 147         }
 148
 149         public String getAuthor(){
 150                 return author;
 151         }
 152
 153         /**
 154          *
 155          * @param newVal
 156          */
 157         public void setAuthor(String newVal){
 158                 author = newVal;
 159         }
 160
 161         public String getJournal(){
 162                 return journal;
 163         }
 164
 165         /**
 166          *
 167          * @param newVal
 168          */
 169         public void setJournal(String newVal){
 170                 journal = newVal;
 171         }
 172
 173         public String getBooktitle(){
 174                 return booktitle;
 175         }
 176
 177         /**
 178          *
 179          * @param newVal
 180          */
 181         public void setBooktitle(String newVal){
 182                 booktitle = newVal;
 183         }
 184
 185         public String getChapter(){
 186                 return chapter;
 187         }
 188
 189         /**
 190          *
 191          * @param newVal
 192          */
 193         public void setChapter(String newVal){
 194                 chapter = newVal;
 195         }
 196
 197         public String getTitle(){
 198                 return title;
 199         }
 200
 201         /**
 202          *
 203          * @param newVal
 204          */
 205         public void setTitle(String newVal){
 206                 title = newVal;
 207         }
 208
 209         public String getSeries(){
 210                 return series;
 211         }
 212
 213         /**
 214          *
 215          * @param newVal
 216          */
 217         public void setSeries(String newVal){
 218                 series = newVal;
 219         }
 220
 221         public String getEdition(){
 222                 return edition;
 223         }
 224
 225         /**
 226          *
 227          * @param newVal
 228          */
 229         public void setEdition(String newVal){
 230                 edition = newVal;
 231         }
 232
 233         public String getVolume(){
 234                 return volume;
 235         }
 236
 237         /**
 238          *
 239          * @param newVal
 240          */
 241         public void setVolume(String newVal){
 242                 volume = newVal;
 243         }
 244
 245         public String getNumber(){
 246                 return number;
 247         }
 248
 249         /**
 250          *
 251          * @param newVal
 252          */
 253         public void setNumber(String newVal){
 254                 number = newVal;
 255         }
 256
 257         public String getPages(){
 258                 return pages;
 259         }
 260
 261         /**
 262          *
 263          * @param newVal
 264          */
 265         public void setPages(String newVal){
 266                 pages = newVal;
 267         }
 268
 269         public String getAnnote(){
 270                 return annote;
 271         }
 272
 273         /**
 274          *
 275          * @param newVal
 276          */
 277         public void setAnnote(String newVal){
 278                 annote = newVal;
 279         }
 280
 281         public String getEditor(){
 282                 return editor;
 283         }
 284
 285         /**
 286          *
 287          * @param newVal
 288          */
 289         public void setEditor(String newVal){
 290                 editor = newVal;
 291         }
 292
 293         public String getInstitution(){
 294                 return institution;
 295         }
 296
 297         /**
 298          *
 299          * @param newVal
 300          */
 301         public void setInstitution(String newVal){
 302                 institution = newVal;
 303         }
 304
 305         public String getSchool(){
 306                 return school;
 307         }
 308
 309         /**
 310          *
 311          * @param newVal
 312          */
 313         public void setSchool(String newVal){
 314                 school = newVal;
 315         }
 316
 317         public String getOrganization(){
 318                 return organization;
 319         }
 320
 321         /**
 322          *
 323          * @param newVal
 324          */
 325         public void setOrganization(String newVal){
 326                 organization = newVal;
 327         }
 328
 329         public String getPublisher(){
 330                 return publisher;
 331         }
 332
 333         /**
 334          *
 335          * @param newVal
 336          */
 337         public void setPublisher(String newVal){
 338                 publisher = newVal;
 339         }
 340
 341         public String getAddress(){
 342                 return address;
 343         }
 344
 345         /**
 346          *
 347          * @param newVal
 348          */
 349         public void setAddress(String newVal){
 350                 address = newVal;
 351         }
 352
 353         public String getHowpublished(){
 354                 return howpublished;
 355         }
 356
 357         /**
 358          *
 359          * @param newVal
 360          */
 361         public void setHowpublished(String newVal){
 362                 howpublished = newVal;
 363         }
 364
 365         public String getType(){
 366                 return type;
 367         }
 368
 369         /**
 370          *
 371          * @param newVal
 372          */
 373         public void setType(String newVal){
 374                 type = newVal;
 375         }
 376
 377         public String getMonth(){
 378                 return month;
 379         }
 380
 381         /**
 382          *
 383          * @param newVal
 384          */
 385         public void setMonth(String newVal){
 386                 month = newVal;
 387         }
 388
 389         public String getYear(){
 390                 return year;
 391         }
 392
 393         /**
 394          *
 395          * @param newVal
 396          */
 397         public void setYear(String newVal){
 398                 year = newVal;
 399         }
 400
 401         public String getEprint(){
 402                 return eprint;
 403         }
 404
 405         /**
 406          *
 407          * @param newVal
 408          */
 409         public void setEprint(String newVal){
 410                 eprint = newVal;
 411         }
 412
 413         public String getNote(){
 414                 return note;
 415         }
 416
 417         /**
 418          *
 419          * @param newVal
 420          */
 421         public void setNote(String newVal){
 422                 note = newVal;
 423         }
 424
 425         /**
 426          * returns a formatted string containing the entire reference citation including
 427          * authors
 428          */
 429         @Transient
 430         public String getCitation(){
 431                 return "";
 432         }
 433
 434         /**
 435          * returns a formatted string containing the reference citation excluding authors
 436          * as used in a taxon name
 437          */
 438         @Transient
 439         public String getNomenclaturalCitation(){
 440                 return "";
 441         }
 442
 443         @Transient
 444         public int getYear(){
 445                 return 0;
 446         }
 447
 448         @Transient
 449         public String getYear(){
 450                 return "";
 451         }
 452
 453 }