net.sf.jabref.imports

Class JSTORFetcher

java.lang.Object

net.sf.jabref.imports.JSTORFetcher

All Implemented Interfaces:

ImportInspectionDialog.CallBack, EntryFetcher

public class JSTORFetcher
extends java.lang.Object
implements EntryFetcher

This class fetches up to 200 citations from JStor by a given search query. It communicates with jstor via HTTP and Cookies. The activeFetcher automates the following steps:

1. Do a basic search on www.jstor.org
2. Save the first 200 hits
3. Download the saved citations as bibtex
4. Parse it with the BibtexParser
5. Import the BibtexEntrys via the ImportInspectionDialog

Author:

Juliane Doege, Tobias Langner

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	COOKIE_CITATIONS Cookie key for citations to be fetched
protected static java.lang.String	COOKIE_TICKET Cookie key for Jstor ticket (authentication)
protected static int	MAX_CITATIONS cookies can't save more than 200 citations
protected static java.lang.String	URL_BIBTEX location where to obtain the citations cookie
protected static java.lang.String	URL_TICKET location where the ticket is obtained

Constructor Summary

Constructors

Constructor and Description
JSTORFetcher()

Method Summary

Modifier and Type	Method and Description
protected java.util.Collection<BibtexEntry>	getBibtexEntries(java.lang.String ticket, java.lang.String citations) Given a ticket an a list of citations, retrieve BibtexEntries from JStor
protected java.lang.String	getCitations(java.lang.String ticket, java.lang.String query) requires a valid JStor Ticket ID
static java.lang.String	getCookie(java.lang.String name, java.net.URLConnection conn) evaluates the 'Set-Cookie'-Header of a HTTP response
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.
protected java.lang.String	openTicket()
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

MAX_CITATIONS

protected static int MAX_CITATIONS

cookies can't save more than 200 citations

COOKIE_TICKET

protected static final java.lang.String COOKIE_TICKET

Cookie key for Jstor ticket (authentication)

See Also:

Constant Field Values

URL_TICKET

protected static final java.lang.String URL_TICKET

location where the ticket is obtained

See Also:

Constant Field Values

COOKIE_CITATIONS

protected static final java.lang.String COOKIE_CITATIONS

Cookie key for citations to be fetched

See Also:

Constant Field Values

URL_BIBTEX

protected static final java.lang.String URL_BIBTEX

location where to obtain the citations cookie

See Also:

Constant Field Values

Constructor Detail

JSTORFetcher

public JSTORFetcher()

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.

getBibtexEntries

protected java.util.Collection<BibtexEntry> getBibtexEntries(java.lang.String ticket,
                                                             java.lang.String citations)
                                                      throws java.io.IOException

Given a ticket an a list of citations, retrieve BibtexEntries from JStor

Parameters:

ticket - A valid ticket as returned by openTicket()

citations - A list of citations as returned by getCitations()

Returns:

A collection of BibtexEntries parsed from the bibtex returned by JStor.

Throws:

java.io.IOException - Most probably related to a problem connecting to JStor.

openTicket

protected java.lang.String openTicket()
                               throws java.io.IOException

Returns:

a Jstor ticket ID

Throws:

java.io.IOException

getCitations

protected java.lang.String getCitations(java.lang.String ticket,
                                        java.lang.String query)
                                 throws java.io.IOException

requires a valid JStor Ticket ID

Parameters:

query - The search term to query JStor for.

ticket - JStor ticket

Returns:

cookie value of the key JSTORFetcher.COOKIE_CITATIONS. null if search is empty or ticket is invalid

Throws:

java.io.IOException

getCookie

public static java.lang.String getCookie(java.lang.String name,
                                         java.net.URLConnection conn)
                                  throws java.io.IOException

evaluates the 'Set-Cookie'-Header of a HTTP response

Parameters:

name - key of a cookie value

conn - URLConnection

Returns:

cookie value referenced by the key. null if key not found

Throws:

java.io.IOException