001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.citation.annotation;
031
032/**
033 * Standard BibTeX types.
034 * 
035 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
036 */
037public enum ReferenceType {
038        /**
039         * An article from a journal or magazine.
040         */
041        Article,
042        
043        /**
044         * A book with an explicit publisher. 
045         */
046        Book,
047        
048        /**
049         * A work that is printed and bound, but without a named publisher or sponsoring institution.
050         */
051        Booklet,
052        
053        /**
054         * A part of a book, usually untitled. May be a chapter (or section or whatever) and/or a range of pages.
055         */
056        Inbook,
057        
058        /**
059         * A part of a book having its own title. 
060         */
061        Incollection,
062        
063        /**
064         * An article in a conference proceedings. 
065         */
066        Inproceedings,
067        
068        /**
069         * Technical documentation.
070         */
071        Manual,
072        
073        /**
074         * A Master's thesis.
075         */
076        Mastersthesis,
077        
078        /**
079         * For use when nothing else fits.
080         */
081        Misc,
082        
083        /**
084         * A Ph.D. thesis. 
085         */
086        Phdthesis,
087        
088        /**
089         * The proceedings of a conference.
090         */
091        Proceedings,
092        
093        /**
094         * A report published by a school or other institution, usually numbered within a series.
095         */
096        Techreport,
097        
098        /**
099         * A document having an author and title, but not formally published.
100         */
101        Unpublished
102        ;
103        
104        /**
105         * Get a {@link ReferenceType} from a string. 
106         * @param v the string
107         * @return the {@link ReferenceType}
108         */
109        public static ReferenceType getReferenceType(String v) {
110                for (ReferenceType rt : ReferenceType.values()) {
111                        if (rt.name().equalsIgnoreCase(v)) return rt;
112                }
113                return Misc;
114        }
115}