net.sf.jabref.imports

Class ACMPortalFetcher

java.lang.Object

net.sf.jabref.imports.ACMPortalFetcher

All Implemented Interfaces:

ImportInspectionDialog.CallBack, EntryFetcher, PreviewEntryFetcher

public class ACMPortalFetcher
extends java.lang.Object
implements PreviewEntryFetcher

Constructor Summary

Constructors

Constructor and Description
ACMPortalFetcher()

Method Summary

Modifier and Type	Method and Description
void	cancelled()
void	done(int entriesImported)
void	getEntries(java.util.Map<java.lang.String,java.lang.Boolean> selection, ImportInspector inspector)
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.
int	getPreferredPreviewHeight() The preferred table row height for the previews.
java.lang.String	getResults(java.net.URL source) Download the URL and return contents as a String.
java.lang.String	getResultsFromFile(java.io.File f) Read results from a file instead of an URL.
java.lang.String	getTitle() The title for this activeFetcher, displayed in the menu and in the side pane.
int	getWarningLimit() The number of entries a user can select for download without getting a warning message.
boolean	processQuery(java.lang.String query, ImportInspector dialog, OutputPrinter status) Handle a query entered by the user.
boolean	processQueryGetPreview(java.lang.String query, FetcherPreviewDialog preview, OutputPrinter status)
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

ACMPortalFetcher

public ACMPortalFetcher()

Method Detail

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.

processQueryGetPreview

public boolean processQueryGetPreview(java.lang.String query,
                                      FetcherPreviewDialog preview,
                                      OutputPrinter status)

Specified by:

processQueryGetPreview in interface PreviewEntryFetcher

getEntries

public void getEntries(java.util.Map<java.lang.String,java.lang.Boolean> selection,
                       ImportInspector inspector)

Specified by:

getEntries in interface PreviewEntryFetcher

getWarningLimit

public int getWarningLimit()

Description copied from interface: PreviewEntryFetcher

The number of entries a user can select for download without getting a warning message.

Specified by:

getWarningLimit in interface PreviewEntryFetcher

Returns:

the warning limit

getPreferredPreviewHeight

public int getPreferredPreviewHeight()

Description copied from interface: PreviewEntryFetcher

The preferred table row height for the previews.

Specified by:

getPreferredPreviewHeight in interface PreviewEntryFetcher

Returns:

the preferred height

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.

getResults

public java.lang.String getResults(java.net.URL source)
                            throws java.io.IOException

Download the URL and return contents as a String.

Parameters:

source -

Returns:

Throws:

java.io.IOException

getResultsFromFile

public java.lang.String getResultsFromFile(java.io.File f)
                                    throws java.io.IOException

Read results from a file instead of an URL. Just for faster debugging.

Parameters:

f -

Returns:

Throws:

java.io.IOException

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

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

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.

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.

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