thredds.ui.catalog

Class CatalogFactoryCancellable

java.lang.Object

thredds.catalog.InvCatalogFactory

thredds.ui.catalog.CatalogFactoryCancellable

public class CatalogFactoryCancellable
extends InvCatalogFactory

A subclass of InvCatalogFactory that allows the reading of a catalog to be cancelled by the user. Pops up a ProgressMonitor widget.

Author:

John Caron

Field Summary

Fields inherited from class thredds.catalog.InvCatalogFactory

debugDBurl, debugOpen, debugURL, debugVersion, debugXML, debugXMLopen, showCatalogXML, showParsedXML, showStackTrace

Constructor Summary

Constructors

Constructor and Description
CatalogFactoryCancellable(Component parent, String name, boolean validate) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isBusy() See if this object can be reused.
void	readXMLasynch(String catalogName, CatalogSetCallback callbacker) Pops up a ProgressMonitor to allow user cancellation while reading the named catalog.

Methods inherited from class thredds.catalog.InvCatalogFactory

appendErr, appendFatalErr, appendWarning, getCatalogConverter, getDataRootLocationAliasExpanders, getDefaultConverter, getDefaultFactory, getMetadataConverter, getName, main, readXML, readXML, readXML, readXML, readXML, readXML, registerCatalogConverter, registerMetadataConverter, setDataRootLocationAliasExpanders, writeXML, writeXML, writeXML, writeXML

Methods inherited from class java.lang.Object

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

Constructor Detail

CatalogFactoryCancellable

public CatalogFactoryCancellable(Component parent,
                         String name,
                         boolean validate)

Constructor.

Parameters:

parent - : put ProgressMonotpr on top of his component; may be null.

name - : name of the InvCatalogFactory

validate - : should CML validation be done?

See Also:

InvCatalogFactory, ProgressMonitor

Method Detail

readXMLasynch

public void readXMLasynch(String catalogName,
                 CatalogSetCallback callbacker)

Pops up a ProgressMonitor to allow user cancellation while reading the named catalog. This method immediately returns, and the reading is done on a background thread. If successfully read, callback.setCatalog() is called on the awt event thread. If failure, the user will be given a popup error message, and callback.failure() is called..

Overrides:

readXMLasynch in class InvCatalogFactory

Parameters:

catalogName - : the URI name that the XML doc is at.

callbacker - : this will be called (from AWT thread) if catalog was successfully called.

isBusy

public boolean isBusy()

See if this object can be reused.

Returns:

true if not completed last task.