Top Description Fields Constructors Methods
de.undercouch.citeproc.bibtex

public Class BibTeXConverter

extends Object
Class Inheritance
Imports
de.undercouch.citeproc.csl.CSLDate, .CSLItemData, .CSLItemDataBuilder, .CSLType, org.jbibtex.BibTeXDatabase, .BibTeXEntry, .BibTeXParser, .BibTeXString, .Key, .LaTeXObject, .LaTeXParser, .LaTeXPrinter, .ParseException, .TokenMgrException, .Value, java.io.InputStream, .InputStreamReader, .Reader, .StringReader, java.nio.charset.StandardCharsets, java.util.HashMap, .LinkedHashMap, .List, .Map

Converts BibTeX items to CSL citation items

The class maps BibTeX attributes to CSL attributes. The mapping is based on the one used in Docear as presented by Joeran Beel.

Docear is released under the GPLv2 but its code may also be reused in projects licensed under Apache License 2.0 (see http://www.docear.org/software/licence/, last visited 2013-09-06). The mapping here is released under the Apache License 2.0 by permission of Joaran Beel, Docear.

Authors
Joaran Beel, Michel Kraemer

Field Summary

Modifier and TypeField and Description
private static final String
FIELD_ABSTRACT

private static final String
FIELD_ACCESSED

private static final String
FIELD_ADDRESS

private static final String
FIELD_ANNOTE

private static final String
FIELD_AUTHOR

private static final String
FIELD_BOOKTITLE

private static final String
FIELD_CHAPTER

private static final String
FIELD_DATE

private static final String
FIELD_DOI

private static final String
FIELD_EDITION

private static final String
FIELD_EDITOR

private static final String
FIELD_INSTITUTION

private static final String
FIELD_ISBN

private static final String
FIELD_ISSN

private static final String
FIELD_ISSUE

private static final String
FIELD_JOURNAL

private static final String
FIELD_JOURNALTITLE

private static final String
FIELD_KEYWORDS

private static final String
FIELD_LANGUAGE

private static final String
FIELD_LOCATION

private static final String
FIELD_MONTH

private static final String
FIELD_NOTE

private static final String
FIELD_NUMBER

private static final String
FIELD_ORGANIZATION

private static final String
FIELD_PAGES

private static final String
FIELD_PUBLISHER

private static final String
FIELD_REVISION

private static final String
FIELD_SCHOOL

private static final String
FIELD_SERIES

private static final String
FIELD_STATUS

private static final String
FIELD_TITLE

private static final String
FIELD_TYPE

private static final String
FIELD_URL

private static final String
FIELD_URLDATE

private static final String
FIELD_VOLUME

private static final String
FIELD_YEAR

private final LaTeXParser
latexParser

private final LaTeXPrinter
latexPrinter

private static final String
TYPE_ARTICLE

private static final String
TYPE_BOOK

private static final String
TYPE_BOOKLET

private static final String
TYPE_CONFERENCE

private static final String
TYPE_ELECTRONIC

private static final String
TYPE_INBOOK

private static final String
TYPE_INCOLLECTION

private static final String
TYPE_INPROCEEDINGS

private static final String
TYPE_MANUAL

private static final String
TYPE_MASTERSTHESIS

private static final String
TYPE_ONLINE

private static final String
TYPE_PATENT

private static final String
TYPE_PERIODICAL

private static final String
TYPE_PHDTHESIS

private static final String
TYPE_PROCEEDINGS

private static final String
TYPE_STANDARD

private static final String
TYPE_TECHREPORT

private static final String
TYPE_UNPUBLISHED

private static final String
TYPE_WWW

Constructor Summary

AccessConstructor and Description
public
BibTeXConverter()

Default constructor

Method Summary

Modifier and TypeMethod and Description
public BibTeXDatabase

Returns:

the BibTeX database
loadDatabase(InputStream
the input stream to read from
is)

Loads a BibTeX database from a stream.

public Map<String, CSLItemData>

Returns:

a map consisting of citation keys and citation items
toItemData(BibTeXDatabase
the database
db)

Converts the given database to a map of CSL citation items

public CSLItemData

Returns:

the citation item
toItemData(BibTeXEntry
the BibTeX entry to convert
e)

Converts a BibTeX entry to a citation item

public CSLType

Returns:

the converted type (never null, falls back to CSLType#ARTICLE)
toType(Key
the type to convert
type)

Converts a BibTeX type to a CSL type

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

FIELD_ABSTRACTback to summary
private static final String FIELD_ABSTRACT
FIELD_ACCESSEDback to summary
private static final String FIELD_ACCESSED
FIELD_ADDRESSback to summary
private static final String FIELD_ADDRESS
FIELD_ANNOTEback to summary
private static final String FIELD_ANNOTE
FIELD_AUTHORback to summary
private static final String FIELD_AUTHOR
FIELD_BOOKTITLEback to summary
private static final String FIELD_BOOKTITLE
FIELD_CHAPTERback to summary
private static final String FIELD_CHAPTER
FIELD_DATEback to summary
private static final String FIELD_DATE
FIELD_DOIback to summary
private static final String FIELD_DOI
FIELD_EDITIONback to summary
private static final String FIELD_EDITION
FIELD_EDITORback to summary
private static final String FIELD_EDITOR
FIELD_INSTITUTIONback to summary
private static final String FIELD_INSTITUTION
FIELD_ISBNback to summary
private static final String FIELD_ISBN
FIELD_ISSNback to summary
private static final String FIELD_ISSN
FIELD_ISSUEback to summary
private static final String FIELD_ISSUE
FIELD_JOURNALback to summary
private static final String FIELD_JOURNAL
FIELD_JOURNALTITLEback to summary
private static final String FIELD_JOURNALTITLE
FIELD_KEYWORDSback to summary
private static final String FIELD_KEYWORDS
FIELD_LANGUAGEback to summary
private static final String FIELD_LANGUAGE
FIELD_LOCATIONback to summary
private static final String FIELD_LOCATION
FIELD_MONTHback to summary
private static final String FIELD_MONTH
FIELD_NOTEback to summary
private static final String FIELD_NOTE
FIELD_NUMBERback to summary
private static final String FIELD_NUMBER
FIELD_ORGANIZATIONback to summary
private static final String FIELD_ORGANIZATION
FIELD_PAGESback to summary
private static final String FIELD_PAGES
FIELD_PUBLISHERback to summary
private static final String FIELD_PUBLISHER
FIELD_REVISIONback to summary
private static final String FIELD_REVISION
FIELD_SCHOOLback to summary
private static final String FIELD_SCHOOL
FIELD_SERIESback to summary
private static final String FIELD_SERIES
FIELD_STATUSback to summary
private static final String FIELD_STATUS
FIELD_TITLEback to summary
private static final String FIELD_TITLE
FIELD_TYPEback to summary
private static final String FIELD_TYPE
FIELD_URLback to summary
private static final String FIELD_URL
FIELD_URLDATEback to summary
private static final String FIELD_URLDATE
FIELD_VOLUMEback to summary
private static final String FIELD_VOLUME
FIELD_YEARback to summary
private static final String FIELD_YEAR
latexParserback to summary
private final LaTeXParser latexParser
latexPrinterback to summary
private final LaTeXPrinter latexPrinter
TYPE_ARTICLEback to summary
private static final String TYPE_ARTICLE
TYPE_BOOKback to summary
private static final String TYPE_BOOK
TYPE_BOOKLETback to summary
private static final String TYPE_BOOKLET
TYPE_CONFERENCEback to summary
private static final String TYPE_CONFERENCE
TYPE_ELECTRONICback to summary
private static final String TYPE_ELECTRONIC
TYPE_INBOOKback to summary
private static final String TYPE_INBOOK
TYPE_INCOLLECTIONback to summary
private static final String TYPE_INCOLLECTION
TYPE_INPROCEEDINGSback to summary
private static final String TYPE_INPROCEEDINGS
TYPE_MANUALback to summary
private static final String TYPE_MANUAL
TYPE_MASTERSTHESISback to summary
private static final String TYPE_MASTERSTHESIS
TYPE_ONLINEback to summary
private static final String TYPE_ONLINE
TYPE_PATENTback to summary
private static final String TYPE_PATENT
TYPE_PERIODICALback to summary
private static final String TYPE_PERIODICAL
TYPE_PHDTHESISback to summary
private static final String TYPE_PHDTHESIS
TYPE_PROCEEDINGSback to summary
private static final String TYPE_PROCEEDINGS
TYPE_STANDARDback to summary
private static final String TYPE_STANDARD
TYPE_TECHREPORTback to summary
private static final String TYPE_TECHREPORT
TYPE_UNPUBLISHEDback to summary
private static final String TYPE_UNPUBLISHED
TYPE_WWWback to summary
private static final String TYPE_WWW

Constructor Detail

BibTeXConverterback to summary
public BibTeXConverter()

Default constructor

Method Detail

loadDatabaseback to summary
public BibTeXDatabase loadDatabase(InputStream is) throws ParseException

Loads a BibTeX database from a stream.

This method does not close the given stream. The caller is responsible for closing it.

Parameters
is:InputStream

the input stream to read from

Returns:BibTeXDatabase

the BibTeX database

Exceptions
ParseException:
if the database is invalid
toItemDataback to summary
public Map<String, CSLItemData> toItemData(BibTeXDatabase db)

Converts the given database to a map of CSL citation items

Parameters
db:BibTeXDatabase

the database

Returns:Map<String, CSLItemData>

a map consisting of citation keys and citation items

toItemDataback to summary
public CSLItemData toItemData(BibTeXEntry e)

Converts a BibTeX entry to a citation item

Parameters
e:BibTeXEntry

the BibTeX entry to convert

Returns:CSLItemData

the citation item

toTypeback to summary
public CSLType toType(Key type)

Converts a BibTeX type to a CSL type

Parameters
type:Key

the type to convert

Returns:CSLType

the converted type (never null, falls back to CSLType#ARTICLE)