net.sf.jabref.imports

Class JSTORFetcher2

java.lang.Object

net.sf.jabref.imports.JSTORFetcher2

All Implemented Interfaces:

ImportInspectionDialog.CallBack, EntryFetcher

public class JSTORFetcher2
extends java.lang.Object
implements EntryFetcher

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CANCELLED
protected static java.util.regex.Pattern	idPattern
protected static java.lang.String	JSTOR_URL
protected static int	MAX_PAGES_TO_LOAD
protected static int	MAX_REFS
protected static java.util.regex.Pattern	nextPagePattern
protected boolean	noAccessFound
protected static java.lang.String	noAccessIndicator
protected static java.util.regex.Pattern	numberofhits
protected static int	REFS_PER_PAGE
protected static java.lang.String	SEARCH_URL
protected static java.lang.String	SEARCH_URL_END
protected static java.lang.String	SINGLE_CIT_ENC
protected boolean	stopFetching

Constructor Summary

Constructors

Constructor and Description
JSTORFetcher2()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<java.lang.String>	getCitations(java.lang.String query, ImportInspector dialog, OutputPrinter status)
protected java.lang.String	getCitationsFromUrl(java.lang.String urlQuery, java.util.List<java.lang.String> ids, int count, java.lang.String[] numberOfRefs, ImportInspector dialog, OutputPrinter status)
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.
protected BibtexEntry	getSingleCitation(java.lang.String cit)
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 status) 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

Field Detail

CANCELLED

protected static final java.lang.String CANCELLED

See Also:

Constant Field Values

MAX_PAGES_TO_LOAD

protected static int MAX_PAGES_TO_LOAD

MAX_REFS

protected static int MAX_REFS

REFS_PER_PAGE

protected static int REFS_PER_PAGE

JSTOR_URL

protected static final java.lang.String JSTOR_URL

See Also:

Constant Field Values

SEARCH_URL

protected static final java.lang.String SEARCH_URL

See Also:

Constant Field Values

SEARCH_URL_END

protected static final java.lang.String SEARCH_URL_END

See Also:

Constant Field Values

SINGLE_CIT_ENC

protected static final java.lang.String SINGLE_CIT_ENC

See Also:

Constant Field Values

idPattern

protected static final java.util.regex.Pattern idPattern

numberofhits

protected static final java.util.regex.Pattern numberofhits

nextPagePattern

protected static final java.util.regex.Pattern nextPagePattern

noAccessIndicator

protected static final java.lang.String noAccessIndicator

See Also:

Constant Field Values

stopFetching

protected boolean stopFetching

noAccessFound

protected boolean noAccessFound

Constructor Detail

JSTORFetcher2

public JSTORFetcher2()

Method Detail

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

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 status)

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.

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.

getCitations

protected java.util.List<java.lang.String> getCitations(java.lang.String query,
                                                        ImportInspector dialog,
                                                        OutputPrinter status)
                                                 throws java.io.IOException

Parameters:

query - The search term to query JStor for.

Returns:

a list of IDs

Throws:

java.io.IOException

getCitationsFromUrl

protected java.lang.String getCitationsFromUrl(java.lang.String urlQuery,
                                               java.util.List<java.lang.String> ids,
                                               int count,
                                               java.lang.String[] numberOfRefs,
                                               ImportInspector dialog,
                                               OutputPrinter status)
                                        throws java.io.IOException

Throws:

java.io.IOException

getSingleCitation

protected BibtexEntry getSingleCitation(java.lang.String cit)