org.autoplot.idlsupport

Class IdlsavDataSourceFactory

java.lang.Object

org.autoplot.datasource.AbstractDataSourceFactory

org.autoplot.idlsupport.IdlsavDataSourceFactory

All Implemented Interfaces:

DataSourceFactory

public class IdlsavDataSourceFactory
extends AbstractDataSourceFactory

Factory for reading IDLSave files.

Constructor Summary

Constructors

Constructor and Description
IdlsavDataSourceFactory()

Method Summary

Modifier and Type	Method and Description
java.util.List<CompletionContext>	getCompletions(CompletionContext cc, ProgressMonitor mon) return a list of context-sensitive completions.
DataSource	getDataSource(java.net.URI uri) return a dataSource for the url
java.lang.String	getDescription() return a short description of the factory, or empty string.
boolean	reject(java.lang.String surl, java.util.List<java.lang.String> problems, ProgressMonitor mon) quick check to see that an uri looks acceptable.

Methods inherited from class org.autoplot.datasource.AbstractDataSourceFactory

getCapability, isFileResource, supportsDiscovery

Methods inherited from class java.lang.Object

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

Constructor Detail

IdlsavDataSourceFactory

public IdlsavDataSourceFactory()

Method Detail

getDataSource

public DataSource getDataSource(java.net.URI uri)
                         throws java.lang.Exception

Description copied from interface: DataSourceFactory

return a dataSource for the url

Specified by:

getDataSource in interface DataSourceFactory

Specified by:

getDataSource in class AbstractDataSourceFactory

Parameters:

uri - the URI

Returns:

the DataSource

Throws:

java.lang.Exception - any exception may occur.

reject

public boolean reject(java.lang.String surl,
                      java.util.List<java.lang.String> problems,
                      ProgressMonitor mon)

Description copied from interface: DataSourceFactory

quick check to see that an uri looks acceptable. since 2012b, this should provide a list of objects marking reasons for rejecting. Though each object is simply a marker, toString method of each should provide some meaningful information to developers. This list will be passed into the editor if available.

Specified by:

reject in interface DataSourceFactory

Overrides:

reject in class AbstractDataSourceFactory

Parameters:

surl - the uri.

problems - list to which problems should be added. TODO: human readable or PROB_TIMERANGE?

mon - a progress monitor, for example to monitor a file download.

Returns:

true if the string cannot be used as a URI.

getCompletions

public java.util.List<CompletionContext> getCompletions(CompletionContext cc,
                                                        ProgressMonitor mon)
                                                 throws java.lang.Exception

Description copied from interface: DataSourceFactory

return a list of context-sensitive completions. If an exception is thrown, then an a error dialog is displayed for RuntimeExceptions. Compile-time exceptions may be displayed more gently, relying on getMessage to aid the human operator.

Specified by:

getCompletions in interface DataSourceFactory

Overrides:

getCompletions in class AbstractDataSourceFactory

Parameters:

cc - the context for the completion.

mon - a progress monitor, for example to monitor a file download.

Returns:

a set of completions

Throws:

java.lang.Exception

getDescription

public java.lang.String getDescription()

Description copied from interface: DataSourceFactory

return a short description of the factory, or empty string. For example, "NASA Common Data Format (CDF) Files" or "NASA CDAWeb". This will be used to identify files or discovery sources.

Specified by:

getDescription in interface DataSourceFactory

Overrides:

getDescription in class AbstractDataSourceFactory

Returns:

a short description of the factory.