net.sf.jabref.journals

Class JournalAbbreviations

java.lang.Object

net.sf.jabref.journals.JournalAbbreviations

public class JournalAbbreviations
extends java.lang.Object

Created by IntelliJ IDEA. User: alver Date: Sep 16, 2005 Time: 10:49:08 PM To browseOld this template use File | Settings | File Templates.

Constructor Summary

Constructors

Constructor and Description
JournalAbbreviations()
JournalAbbreviations(java.io.File file)
JournalAbbreviations(java.lang.String resource)

Method Summary

Modifier and Type	Method and Description
boolean	abbreviate(BibtexDatabase database, BibtexEntry entry, java.lang.String fieldName, javax.swing.undo.CompoundEdit ce, boolean withDots) Abbreviate the journal name of the given entry.
java.lang.String	dotsToNodots(java.lang.String name)
java.util.Iterator<java.lang.String>	fullNameIterator() Get an iterator for the known journals in alphabetical order.
java.lang.String	getAbbreviatedName(java.lang.String journalName, boolean withDots) Attempts to get the abbreviated name of the journal given.
java.lang.String	getFullName(java.lang.String journalName) Attempts to get the full name of the abbreviation given.
java.util.Map<java.lang.String,java.lang.String>	getJournals()
static javax.swing.JComponent	getNameSwitcher(EntryEditor entryEditor, FieldEditor editor, javax.swing.undo.UndoManager undoManager) Create a control panel for the entry editor's journal field, to toggle abbreviated/full journal name
javax.swing.table.TableModel	getTableModel()
boolean	isAbbreviatedName(java.lang.String journalName)
boolean	isKnownName(java.lang.String journalName)
void	readJournalList(java.io.File file)
void	readJournalList(java.io.Reader in) Read the given file, which should contain a list of journal names and their abbreviations.
void	readJournalList(java.lang.String resourceFileName)
boolean	unabbreviate(BibtexDatabase database, BibtexEntry entry, java.lang.String fieldName, javax.swing.undo.CompoundEdit ce) Unabbreviate the journal name of the given entry.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JournalAbbreviations

public JournalAbbreviations()

JournalAbbreviations

public JournalAbbreviations(java.lang.String resource)

JournalAbbreviations

public JournalAbbreviations(java.io.File file)
                     throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

Method Detail

fullNameIterator

public java.util.Iterator<java.lang.String> fullNameIterator()

Get an iterator for the known journals in alphabetical order.

Returns:

Iterator for journal full names

isKnownName

public boolean isKnownName(java.lang.String journalName)

isAbbreviatedName

public boolean isAbbreviatedName(java.lang.String journalName)

dotsToNodots

public java.lang.String dotsToNodots(java.lang.String name)

getAbbreviatedName

public java.lang.String getAbbreviatedName(java.lang.String journalName,
                                           boolean withDots)

Attempts to get the abbreviated name of the journal given. Returns null if no abbreviated name is known.

Parameters:

journalName - The journal name to abbreviate.

withDots - True if the abbreviation should have dots. if only the first character should be.

Returns:

The abbreviated name, or null if it couldn't be found.

getFullName

public java.lang.String getFullName(java.lang.String journalName)

Attempts to get the full name of the abbreviation given. Returns null if no full name is known.

Parameters:

journalName - The abbreviation to resolve.

Returns:

The full name, or null if it couldn't be found.

readJournalList

public void readJournalList(java.lang.String resourceFileName)

readJournalList

public void readJournalList(java.io.File file)
                     throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

readJournalList

public void readJournalList(java.io.Reader in)
                     throws java.io.FileNotFoundException

Read the given file, which should contain a list of journal names and their abbreviations. Each line should be formatted as: "Full Journal Name=Abbr. Journal Name"

Parameters:

in -

Throws:

java.io.FileNotFoundException

abbreviate

public boolean abbreviate(BibtexDatabase database,
                          BibtexEntry entry,
                          java.lang.String fieldName,
                          javax.swing.undo.CompoundEdit ce,
                          boolean withDots)

Abbreviate the journal name of the given entry.

Parameters:

database - The database the entry belongs to, or null if no database.

entry - The entry to be treated.

fieldName - The field name (e.g. "journal")

ce - If the entry is changed, add an edit to this compound.

withDots - True if the abbreviations should have dots.

Returns:

true if the entry was changed, false otherwise.

unabbreviate

public boolean unabbreviate(BibtexDatabase database,
                            BibtexEntry entry,
                            java.lang.String fieldName,
                            javax.swing.undo.CompoundEdit ce)

Unabbreviate the journal name of the given entry.

Parameters:

entry - The entry to be treated.

fieldName - The field name (e.g. "journal")

ce - If the entry is changed, add an edit to this compound.

Returns:

true if the entry was changed, false otherwise.

getJournals

public java.util.Map<java.lang.String,java.lang.String> getJournals()

getNameSwitcher

public static javax.swing.JComponent getNameSwitcher(EntryEditor entryEditor,
                                                     FieldEditor editor,
                                                     javax.swing.undo.UndoManager undoManager)

Create a control panel for the entry editor's journal field, to toggle abbreviated/full journal name

Parameters:

editor - The FieldEditor for the journal field.

Returns:

The control panel for the entry editor.

getTableModel

public javax.swing.table.TableModel getTableModel()