org.autoplot.hapi

Class HapiDataSourceFactory

java.lang.Object

org.autoplot.datasource.AbstractDataSourceFactory

org.autoplot.hapi.HapiDataSourceFactory

All Implemented Interfaces:

DataSourceFactory

public class HapiDataSourceFactory
extends AbstractDataSourceFactory

Constructor for HAPI data sources.

Constructor Summary

Constructors

Constructor and Description
HapiDataSourceFactory()

Method Summary

Modifier and Type	Method and Description
<T> T	getCapability(java.lang.Class<T> clazz) return additional tools for creating valid URIs, such as TimeSeriesBrowse.
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
boolean	reject(java.lang.String surl, java.util.List<java.lang.String> problems, ProgressMonitor mon) quick check to see that an uri looks acceptable.
boolean	supportsDiscovery() mark that this source has an editor that allows discovery of data, and the GUI can be entered with "vap+ext:" This must be consistent with the reject method of the editor.

Methods inherited from class java.lang.Object

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

Constructor Detail

HapiDataSourceFactory

public HapiDataSourceFactory()

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

getCapability

public <T> T getCapability(java.lang.Class<T> clazz)

Description copied from interface: DataSourceFactory

return additional tools for creating valid URIs, such as TimeSeriesBrowse. This may soon include a file selector, and an automatic GUI created from the completions model.

Specified by:

getCapability in interface DataSourceFactory

Overrides:

getCapability in class AbstractDataSourceFactory

Parameters:

clazz - the class, such as org.autoplot.datasource.capability.TimeSeriesBrowse

Returns:

the capability, such as an instance of org.autoplot.datasource.capability.TimeSeriesBrowse

supportsDiscovery

public boolean supportsDiscovery()

Description copied from interface: DataSourceFactory

mark that this source has an editor that allows discovery of data, and the GUI can be entered with "vap+ext:" This must be consistent with the reject method of the editor.

Specified by:

supportsDiscovery in interface DataSourceFactory

Overrides:

supportsDiscovery in class AbstractDataSourceFactory

Returns:

true if the data source factory supports discovery.