net.sf.jabref.imports

Class INSPIREFetcher

java.lang.Object

net.sf.jabref.imports.INSPIREFetcher

All Implemented Interfaces:

ImportInspectionDialog.CallBack, EntryFetcher

public class INSPIREFetcher
extends java.lang.Object
implements EntryFetcher

This class allows to access the Slac INSPIRE database. It is just a port of the original SPIRES Fetcher. It can either be a GeneralFetcher to pose requests to the database or fetch individual entries.

Version:

$Id$

Author:

Fedor Bezrukov, Sheer El-Showk

Constructor Summary

Constructors

Constructor and Description
INSPIREFetcher()

Method Summary

Modifier and Type	Method and Description
void	cancelled()
java.lang.String	constructUrl(java.lang.String key) Construct the query URL NOTE: we truncate at 1000 returned entries but its likely INSPIRE returns fewer anyway.
void	done(int entriesImported)
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 dialog, OutputPrinter frame) Handle a query entered by the user.
void	stopFetching() This method is called by the dialog when the user has cancelled or signalled a stop.

Methods inherited from class java.lang.Object

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

Constructor Detail

INSPIREFetcher

public INSPIREFetcher()

Method Detail

constructUrl

public java.lang.String constructUrl(java.lang.String key)

Construct the query URL NOTE: we truncate at 1000 returned entries but its likely INSPIRE returns fewer anyway. This shouldn't be a problem since users should probably do more specific searches.

Parameters:

key - The key of the OAI2 entry that the url should poitn to.

Returns:

a String denoting the query URL

getHelpPage

public java.lang.String getHelpPage()

Description copied from interface: EntryFetcher

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.

Specified by:

getHelpPage in interface EntryFetcher

Returns:

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

getIcon

public java.net.URL getIcon()

Description copied from interface: EntryFetcher

Get the appropriate icon URL for this activeFetcher.

Specified by:

getIcon in interface EntryFetcher

Returns:

The icon URL

getKeyName

public java.lang.String getKeyName()

Description copied from interface: EntryFetcher

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

Specified by:

getKeyName in interface EntryFetcher

Returns:

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

getOptionsPanel

public javax.swing.JPanel getOptionsPanel()

Description copied from interface: EntryFetcher

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.

Specified by:

getOptionsPanel in interface EntryFetcher

Returns:

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

getTitle

public java.lang.String getTitle()

Description copied from interface: EntryFetcher

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

Specified by:

getTitle in interface EntryFetcher

Returns:

The title

cancelled

public void cancelled()

done

public void done(int entriesImported)

stopFetching

public void stopFetching()

Description copied from interface: ImportInspectionDialog.CallBack

This method is called by the dialog when the user has cancelled or signalled a stop. It is expected that any long-running fetch operations will stop after this method is called.

Specified by:

stopFetching in interface ImportInspectionDialog.CallBack

processQuery

public boolean processQuery(java.lang.String query,
                            ImportInspector dialog,
                            OutputPrinter frame)

Description copied from interface: EntryFetcher

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

Specified by:

processQuery in interface EntryFetcher

Parameters:

query - The query text.

dialog - The dialog to add imported entries to.

frame - 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.