net.sf.jabref.imports

Class ImportFormat

java.lang.Object

net.sf.jabref.imports.ImportFormat

All Implemented Interfaces:

java.lang.Comparable<ImportFormat>

Direct Known Subclasses:

BiblioscapeImporter, BibtexImporter, BibteXMLImporter, BiomailImporter, CopacImporter, CsaImporter, EndnoteImporter, FreeCiteImporter, InspecImporter, IsiImporter, JstorImporter, MedlineImporter, MsBibImporter, OvidImporter, PdfContentImporter, PdfXmpImporter, RepecNepImporter, RisImporter, ScifinderImporter, SilverPlatterImporter, SixpackImporter

public abstract class ImportFormat
extends java.lang.Object
implements java.lang.Comparable<ImportFormat>

Role of an importer for JabRef.

Importers are sorted according to following criteria

1. custom importers come first, then importers shipped with JabRef
2. then importers are sorted by name.

Constructor Summary

Constructors

Constructor and Description
ImportFormat() Constructor for custom importers.

Method Summary

Modifier and Type	Method and Description
int	compareTo(ImportFormat importer)
boolean	equals(java.lang.Object o)
java.lang.String	getCLIId() Short, one token ID to identify the format from the command line.
java.lang.String	getDescription() Description of the ImportFormat.
java.lang.String	getExtensions() Extensions that this importer can read.
abstract java.lang.String	getFormatName() Name of this import format.
boolean	getIsCustomImporter() Wether this importer is a custom importer.
int	hashCode()
abstract java.util.List<BibtexEntry>	importEntries(java.io.InputStream in, OutputPrinter status) Parse the entries in the source, and return a List of BibtexEntry objects.
abstract boolean	isRecognizedFormat(java.io.InputStream in) Check whether the source is in the correct format for this importer.
void	setIsCustomImporter(boolean isCustomImporter) Sets if this is a custom importer.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImportFormat

public ImportFormat()

Constructor for custom importers.

Method Detail

isRecognizedFormat

public abstract boolean isRecognizedFormat(java.io.InputStream in)
                                    throws java.io.IOException

Check whether the source is in the correct format for this importer.

Throws:

java.io.IOException

importEntries

public abstract java.util.List<BibtexEntry> importEntries(java.io.InputStream in,
                                                          OutputPrinter status)
                                                   throws java.io.IOException

Parse the entries in the source, and return a List of BibtexEntry objects. This method can be called in two different contexts - either when importing in a specified format, or when importing in unknown format. In the latter case, JabRef cycles through all available import formats. No error messages or feedback is displayed from individual import formats in this case. If importing in a specified format, and null or an empty list is returned, JabRef reports that no entries were found. If an IOException is thrown, JabRef displays the exception's message in unmodified form. TODO the return type should be changed to "ParseResult" as the parser could use a different encoding than the default encoding

Throws:

java.io.IOException

getFormatName

public abstract java.lang.String getFormatName()

Name of this import format.

The name must be unique.

Returns:

format name, must be unique and not null

getExtensions

public java.lang.String getExtensions()

Extensions that this importer can read.

Returns:

comma separated list of extensions or null for the default

getCLIId

public java.lang.String getCLIId()

Short, one token ID to identify the format from the command line.

Returns:

command line ID

getDescription

public java.lang.String getDescription()

Description of the ImportFormat.

Implementors of ImportFormats should override this. Ideally, it should specify

• what kind of entries from what sources and based on what specification it is able to import
• by what criteria it recognizes an import format

Returns:

description of the import format

setIsCustomImporter

public final void setIsCustomImporter(boolean isCustomImporter)

Sets if this is a custom importer.

For custom importers added dynamically to JabRef, this will be set automatically by JabRef.

Parameters:

isCustomImporter - if this is a custom importer

getIsCustomImporter

public final boolean getIsCustomImporter()

Wether this importer is a custom importer.

Custom importers will have precedence over built-in importers.

Returns:

wether this is a custom importer

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(ImportFormat importer)

Specified by:

compareTo in interface java.lang.Comparable<ImportFormat>