org.tsds.datasource

Class TsdsDataSourceFactory

java.lang.Object

org.autoplot.datasource.AbstractDataSourceFactory

org.tsds.datasource.TsdsDataSourceFactory

All Implemented Interfaces:

DataSourceFactory

public class TsdsDataSourceFactory
extends AbstractDataSourceFactory
implements DataSourceFactory

Constructor Summary

Constructors

Constructor and Description
TsdsDataSourceFactory()

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	isFileResource() true if the data source is based on files.
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

getDescription, supportsDiscovery

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.autoplot.datasource.DataSourceFactory

getDescription, supportsDiscovery

Constructor Detail

TsdsDataSourceFactory

public TsdsDataSourceFactory()

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.

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

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.

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

isFileResource

public boolean isFileResource()

Description copied from interface: DataSourceFactory

true if the data source is based on files. For example, a CDF file is true, since the URIs contain cdf file names, and while vap+cdaweb uses files to move data, it is not file based. This is initially used to limit the entries in file choosers.

Specified by:

isFileResource in interface DataSourceFactory

Overrides:

isFileResource in class AbstractDataSourceFactory

Returns:

true if the data source is based on files.