net.sf.jabref.imports

Interface EntryFetcher

All Superinterfaces:

ImportInspectionDialog.CallBack

All Known Subinterfaces:

PreviewEntryFetcher

All Known Implementing Classes:

ACMPortalFetcher, ADSFetcher, CiteSeerXFetcher, DBLPFetcher, DiVAtoBibTeXFetcher, DOItoBibTeXFetcher, GoogleScholarFetcher, IEEEXploreFetcher, INSPIREFetcher, ISBNtoBibTeXFetcher, JSTORFetcher, JSTORFetcher2, MedlineFetcher, OAI2Fetcher, ScienceDirectFetcher, SPIRESFetcher

public interface EntryFetcher
extends ImportInspectionDialog.CallBack

Implement this interface to add another activeFetcher (something that grabs records from the Web for JabRef). Have a look at the existing implemenations OAI2Fetcher, IEEEXploreFetcher, MedlineFetcher, JStorFetcher and CiteSeerEntryFetcher. Note: You also need to implement the method stopFetching from ImportInspectionDialog.Callback A Fetcher should not execute any GUI Operations, because it might be run in headless mode, but rather use the OutputPrinter for talking to the user.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getHelpPage() Get the name of the help page for this activeFetcher.
java.net.URL	getIcon() Get the appropriate icon URL for this activeFetcher.
java.lang.String	getKeyName() Get the name of the key binding for this activeFetcher, if any.
javax.swing.JPanel	getOptionsPanel() If this activeFetcher requires additional options, a panel for setting up these should be returned in a JPanel by this method.
java.lang.String	getTitle() The title for this activeFetcher, displayed in the menu and in the side pane.
boolean	processQuery(java.lang.String query, ImportInspector inspector, OutputPrinter status) Handle a query entered by the user.

Methods inherited from interface net.sf.jabref.gui.ImportInspectionDialog.CallBack

stopFetching

Method Detail

processQuery

boolean processQuery(java.lang.String query,
                     ImportInspector inspector,
                     OutputPrinter status)

Handle a query entered by the user. The method is expected to block the caller until all entries have been reported to the inspector.

Parameters:

query - The query text.

inspector - The dialog to add imported entries to.

status - An OutputPrinter passed to the activeFetcher for reporting about the status of the fetching.

Returns:

True if the query was completed successfully, false if an error occurred.

getTitle

java.lang.String getTitle()

The title for this activeFetcher, displayed in the menu and in the side pane.

Returns:

The title

getKeyName

java.lang.String getKeyName()

Get the name of the key binding for this activeFetcher, if any.

Returns:

The name of the key binding or null, if no keybinding should be created.

getIcon

java.net.URL getIcon()

Get the appropriate icon URL for this activeFetcher.

Returns:

The icon URL

getHelpPage

java.lang.String getHelpPage()

Get the name of the help page for this activeFetcher. If given, a question mark is displayed in the side pane which leads to the help page.

Returns:

The name of the help file or null if this activeFetcher does not have any help.

getOptionsPanel

javax.swing.JPanel getOptionsPanel()

If this activeFetcher requires additional options, a panel for setting up these should be returned in a JPanel by this method. This JPanel will be added to the side pane component automatically.

Returns:

Options panel for this activeFetcher or null if this activeFetcher does not have any options.