org.autoplot.aggregator

Class AggregatingDataSourceFactory

java.lang.Object

org.autoplot.aggregator.AggregatingDataSourceFactory

All Implemented Interfaces:

DataSourceFactory

public class AggregatingDataSourceFactory
extends java.lang.Object
implements DataSourceFactory

ftp://cdaweb.gsfc.nasa.gov/pub/data/noaa/noaa14/$Y/noaa14_meped1min_sem_$Y$m$d_v01.cdf?timerange=2000-01-01

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROB_NO_TIMERANGE_PROVIDED
static java.lang.String	PROB_PARSE_ERROR_IN_TIMERANGE

Constructor Summary

Constructors

Constructor and Description
AggregatingDataSourceFactory() Creates a new instance of AggregatingDataSourceFactory

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
static DataSourceFactory	getDelegateDataSourceFactory(java.lang.String surl)
static java.lang.String	getDelegateDataSourceFactoryUri(java.lang.String suri, ProgressMonitor mon)
java.lang.String	getDescription() return a short description of the factory, or empty string.
static FileStorageModel	getFileStorageModel(java.lang.String suri) return the FileStorageModel for the URI.
static java.lang.String	getRepresentativeFile(java.net.URI uri, ProgressMonitor monitor) return a file from the aggregation, so that it can be inspected externally.
protected static boolean	hasTimeFields(java.lang.String surl)
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.
void	setDelegateDataSourceFactory(DataSourceFactory delegateFactory)
static int	splitIndex(java.lang.String surl) return the index of the agg part of the uri.
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

Field Detail

PROB_NO_TIMERANGE_PROVIDED

public static final java.lang.String PROB_NO_TIMERANGE_PROVIDED

See Also:

Constant Field Values

PROB_PARSE_ERROR_IN_TIMERANGE

public static final java.lang.String PROB_PARSE_ERROR_IN_TIMERANGE

See Also:

Constant Field Values

Constructor Detail

AggregatingDataSourceFactory

public AggregatingDataSourceFactory()

Creates a new instance of AggregatingDataSourceFactory

Method Detail

getRepresentativeFile

public static java.lang.String getRepresentativeFile(java.net.URI uri,
                                                     ProgressMonitor monitor)
                                              throws java.io.IOException

return a file from the aggregation, so that it can be inspected externally.

Parameters:

uri -

monitor -

Returns:

null or a file.

Throws:

java.io.IOException

See Also:

setDelegateDataSourceFactory

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

Parameters:

uri - the URI

Returns:

the DataSource

Throws:

java.lang.Exception - any exception may occur.

splitIndex

public static int splitIndex(java.lang.String surl)

return the index of the agg part of the uri. Like FileStorageModel.splitIndex(surl), but also treats * as $x.

Parameters:

surl - the URI as a string.

Returns:

the index of the first part of the aggregation, which will be one more than the position of the static part's last slash.

getFileStorageModel

public static FileStorageModel getFileStorageModel(java.lang.String suri)
                                            throws java.io.IOException

return the FileStorageModel for the URI.

Parameters:

suri - eg. file:/tmp/foo/$Y/$Y$m.dat

Returns:

the FileStorageModel, eg. for $Y/$Y$m.dat.

Throws:

java.io.IOException

See Also:

which splits the static part from the agg part.

getDelegateDataSourceFactoryUri

public static java.lang.String getDelegateDataSourceFactoryUri(java.lang.String suri,
                                                               ProgressMonitor mon)
                                                        throws java.io.IOException,
                                                               java.lang.IllegalArgumentException

Parameters:

suri - the aggregation, containing the template and the timerange parameter.

mon - a progress monitor.

Returns:

the URI for each granule.

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if it is not able to find any data files.

getDelegateDataSourceFactory

public static DataSourceFactory getDelegateDataSourceFactory(java.lang.String surl)
                                                      throws java.io.IOException,
                                                             java.lang.IllegalArgumentException,
                                                             java.net.URISyntaxException

Throws:

java.io.IOException

java.lang.IllegalArgumentException

java.net.URISyntaxException

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

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

hasTimeFields

protected static boolean hasTimeFields(java.lang.String surl)

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

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.

setDelegateDataSourceFactory

public void setDelegateDataSourceFactory(DataSourceFactory delegateFactory)

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

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

Returns:

true if the data source factory supports discovery.

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

Returns:

true if the data source is based on files.

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

Returns:

a short description of the factory.