org.autoplot.jythonsupport.Util

Utilities for Jython scripts in both the datasource and application contexts.

Util( )

fileCanRead

return true if the file can be read. This is introduced to avoid imports of java.io.File.

Parameters

Returns:

fileExists

return true if the file exists. This is introduced to avoid imports of java.io.File.

Parameters

Returns:

generateTimeRanges

Given a spec to format timeranges and a range to contain each timerange, produce a list of all timeranges covering the range formatted with the spec. For example, generateTimeRanges( "%Y-%m-%d", "Jun 2009" ) would result in 2009-06-01, 2009-06-02, ..., 2009-06-30. This is limited to create no more than 100000 elements.

Parameters

Returns:

See Also:

getAllCompletions

return a list of all completions, even if they are not complete. This is useful in the IDL context as well as Jython scripts. This will perform the completion for where the carot is at the end of the string. All completions are returned, so for example http://autoplot.org/data/somedata.cdf?noDep is returned as well as http://autoplot.org/data/somedata.cdf?Magnitude.

Parameters

Returns:

getAutoplotScriptingVersion

this returns a double indicating the current scripting version, found at the top of autoplot2017.py in AUTOPLOT_DATA/jython/autoplot2017.py. Do not parse this number and expect it to work in future versions!

Returns:

getCompletions

return a list of completions. This is useful in the IDL context as well as Jython scripts. This will perform the completion for where the carot is at the end of the string. Only completions where maybePlot indicates the URI is now valid are returned, so for example http://autoplot.org/data/somedata.cdf?noDep is not returned and http://autoplot.org/data/somedata.cdf?Magnitude is.

Parameters

Returns:

getDataSet

load the data specified by URI into Autoplot's internal data model. This will block until the load is complete, and a ProgressMonitor object can be used to monitor the load. This adds a timeRange parameter so that TimeSeriesBrowse-capable datasources can be used from AutoplotServer.

Parameters

Returns:

getDataSetFromStream

load data from the input stream into Autoplot internal data model. This will block until the load is complete. This works by creating a temporary file and then using the correct reader to read the data. When the data source is able to read directly from a stream, no temporary file is created. Currently this always loads to a file, and therefore does not support applets. This may have been introduced to support scripts, but it's not clear who uses it.

Parameters

Returns:

getDataSets

load multiple uris simultaneously. This will read all the data at once, returning all data or throwing one of the exceptions.

Parameters

Returns:

getDataSource

returns the dataSource for the given URI. This will include capabilities, like TimeSeriesBrowse.

Parameters

Returns:

getMetadata

load the metadata for the url. This can be called independently from getDataSet, and data sources should not assume that getDataSet is called before getMetaData. Some may, in which case a bug report should be submitted. The metadata is a tree of name/value pairs, for human consumption, and used when a particular metadata model is expects.

Parameters

Returns:

getTimeRangesFor

return an array of URLs that match the spec for the time range provided. For example,

  uri= 'https://cdaweb.gsfc.nasa.gov/istp_public/data/polar/hyd_h0/$Y/po_h0_hyd_$Y$m$d_v01.cdf?ELECTRON_DIFFERENTIAL_ENERGY_FLUX'
  xx= getTimeRangesFor( uri, '2000-jan', '$Y-$d-$m' )
  for x in xx:
    print x
 

Parameters

Returns:

getTimeSeriesBrowse

get the TimeSeriesBrowse capability, if available. Null (None) is returned if it is not found.

Parameters

Returns:

guardedSplit

only split on the delimiter when we are not within the exclude delimiters. For example, x=getDataSet("http://autoplot.org/data/autoplot.cdf?Magnitude&noDep=T")&y=getDataSet('http://autoplot.org/data/autoplot.cdf?BGSEc&slice1=2')&sqrt(x)

Parameters

Returns:

isLegacyImports

return true if we should do the imports as before, where all of Autoplot is imported with each session. This is used to ease migration.

Returns:

listDirectory

returns an array of the files in the local or remote filesystem pointed to by suri. The files are returned without the path, and directories are marked with a trailing slash character. Windows a forward slash is still used, even though a back slash is more conventional. When the suri ends in slash, all entries in the directory are listed, and when it ends in a file glob, all matching files are returned.

 print listDirectory( 'http://autoplot.org/data/pngwalk/' )
  --> 'product.vap', 'product_20080101.png', 'product_20080102.png', ...
 print listDirectory( 'http://autoplot.org/data/pngwalk/*.png' )
  --> 'product_20080101.png', 'product_20080102.png', ...
 

Parameters

Returns:

main

Parameters

Returns:

popString

Parameters

Returns:

readConfiguration

read the preferences into a map. These are name=value pairs and anything following a pound symbol (#) is ignored. Anything before the equal sign is trimmed, so "x=2" and "x = 2" have the same interpretation. This has a number of TODOs, namely:

• allow quoted values, and hashes within quotes.
• allow defaults to be specified.
• allow ini files to be used as well.
• allow json files to be used as well.

Parameters

Returns:

requireAutoplotScriptingVersion

throw an exception if the scripting version cannot be supported. These versions are numeric--so note that v1.7 is newer than v1.50, and for this reason versions should always be vNNN.NN.

Parameters

Returns:

runInParallel

run the python jobs in parallel.

Parameters

Returns:

sleep

sleep for so many milliseconds. This is introduced to avoid the import, which makes running scripts securely non-trivial.

Parameters

Returns: