gov.nasa.gsfc.spdf.cdas

Interface CoordinatedDataAnalysisSystem

All Superinterfaces:

java.rmi.Remote

public interface CoordinatedDataAnalysisSystem
extends java.rmi.Remote

This interface defines the remote interface to NASA's Coordinated Data Analysis System.
The following is a general outline of the steps a client application should follow in using these Web services:

1. A client of this interface should begin by calling the getAllViewDescriptions() at the published endpoint address. All other methods should be invoked at the endpoint address associated with the desired dataview as returned by getAllViewDescriptions() in ViewDescription.endpointAddress.
2. Next, a client would typically call getAllMissionGroups() and getAllInstrumentTypes() (or possibly getSources() and getAllInstruments().
3. Following the mission-group and instrument-type selection (or source and instrument selection), a call would be made to getDatasets() (or getDatasetsBySource()).
4. Following dataset, time range, variable, and output selection, a call would be made to getDataAsText(), getDataFiles(), or getDataGraph().

Notes:

• Calls to services at endpoint addresses associated with non-public views (ViewDescription.publicAccess) require basic HTTP authentication.
• Unless otherwise noted, the source, instrument, and dataset values required below are the standard encoded (abbreviated) values and not long descriptive values (e.g., dataset value equals "PO_K0_CAM" instead of "Polar Charge and Mass Magnetospheric Ion Composition Key Parameter").
• When refering to this javadoc documentation of this Web Service interface, be aware that the code-level details seen by a client developer may contain differences. For example, where this javadoc documentation may describe a parameter as being of type java.util.Calendar, a client developer may be required to use a different type such as javax.xml.datatype.XMLGregorianCalendar. It is also likely that the object constructors used by a client do not function exactly like the ones described here (client developers should not trust that their constructors have the same default behavior). These types of differences are determined by the language (Java, Perl, etc.) and the tools and libararies (for example JAX-RPC) the client is using. The WSDL is the offical description of this Web Service. Nonetheless, this javadoc documentation contains important semantic information about this Web Service that is valuable to a client developer regardless of the language or tools they may be using.
• As of Release 1.6.15, these Web services recognize Space Physics Archive Search and Extract (SPASE) Spase/NumericalData/ResourceID values (for example, "spase://VHO/NumericalData/ACE/MAG/CDF_PT16S") as an alternative to CDAS dataset values (for example, "AC_H0_MFI"). Specifically, a client may make a request with a DatasetDescription.id value set to a SPASE ResourceID of the NumericalData corresponding to an CDAS dataset. The following additional notes apply to SPASE ResourceIDs:
  • As of August 2008, not all CDAS datasets have corresponding /Spase/NumericalData/ResourceID values. The current list is viewable at SPDF SPASE NumericalData.
  • Even when a client request contains a SPASE ResourceID, the results provided by these Web services may contain the corresponding CDAS dataset identifier.
• You are strongly encouraged to have your client set the HTTP User-Agent header (RFC 2068) to a value that identifies your client application in each CDAS Web Service request that it makes. This will allow us to measure the usefulness of these services and justify their continued support. It isn't too important what value you use but it is best if it uniquely identifies your application. The specifics of how to do this in the client varies depending upon the programming language and support libraries used for the client.
• There are server computer resource limits imposed on the methods of this interface. While these limits are not expected to be limiting for legitimate requests, it may be possible to exceed these limits and experience a "request exceeded computer resource limits" exception. A client may want to be prepared to deal with such occasions.

Author:

B. Harris

Method Summary

Modifier and Type	Method and Description
InstrumentDescription[]	getAllInstrumentDescriptions() Provides descriptions of all instruments available in this view.
java.lang.String[][]	getAllInstruments() Provides the names of all instruments available in this view.
java.lang.String[]	getAllInstrumentTypes() Provides the names of all instrument types available in this view.
java.lang.String[]	getAllMissionGroups() Provides the names of all the mission groups in this view.
ViewDescription[]	getAllViewDescriptions() Provides a description of all the data views available.
ResultDescription	getCdasDataFile(java.lang.String dataset, TimeInterval[] timeIntervals) Provides a description of the data file for the specified data.
ResultDescription	getCdasDataFile(java.lang.String dataset, TimeInterval[] timeIntervals, int cdfVersion) Provides a description of the data file for the specified data.
ResultDescription	getCdasDataFile(java.lang.String dataset, TimeInterval[] timeIntervals, java.lang.String[] variables) Provides a description of the data file for the specified data.
ResultDescription	getCdasDataFile(java.lang.String dataset, TimeInterval[] timeIntervals, java.lang.String[] variables, int cdfVersion) Provides a description of the data file for the specified data.
FileDescription[]	getCdfmlDataFiles(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, int compression) Provides descriptions of the CDFML-format data files for the given data set and time range.
FileDescription[]	getCdfmlDataFiles(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables, int compression) Provides descriptions of CDFML-format data files for the specified data.
java.lang.String[]	getCdfmlDataUrls(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, int compression) Deprecated. As of CDAS Web Service 1.6.7, replaced by getCdfmlDataFiles(String, Date, Date, int)
java.lang.String[]	getCdfmlDataUrls(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables, int compression) Deprecated. As of CDAS Web Service 1.6.7, replaced by getCdfmlDataFiles(String, Date, Date, String[], int)
ResultDescription	getDataAsText(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables) Provides the specified data in a textual representation.
ResultDescription	getDataAsText(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables, java.util.Set<java.lang.String> compression) Provides the specified data in a textual representation.
FileDescription[]	getDataFiles(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime) Provides descriptions of the data files for the given data set and time range.
FileDescription[]	getDataFiles(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.util.Date ifModifiedSince) Provides descriptions of the data files for the given data set and time range.
FileDescription[]	getDataFiles(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables) Provides descriptions of the data files for the specified data.
FileDescription[]	getDataFiles(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables, int cdfVersion) Provides descriptions of the data files for the specified data.
ResultDescription	getDataGraph(java.util.Date startTime, java.util.Date endTime, GraphVariableDescription[] variables, long options, java.lang.String[] formats) Provides a graph of the specified data.
ResultDescription	getDataGraph(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables) Provides a graph of the specified data.
ResultDescription	getDataGraph(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables, long options) Provides a graph of the specified data.
DatasetDescription[]	getDatasets(java.lang.String[] missionGroups, java.lang.String[] instrumentTypes) Provides a description of all the data sets available for the given mission group and instrument types.
DatasetDescription[]	getDatasets(java.lang.String[] missionGroups, java.lang.String[] instrumentTypes, TimeInterval timeInterval, java.lang.String idPattern, java.lang.String labelPattern, java.lang.String notesPattern) Provides a description of all the data sets available for the given mission group, instrument types, time interval, and search patterns.
DatasetDescription[]	getDatasetsByInstrument(java.lang.String[] missionGroups, java.lang.String[] instruments) Provides the names of all the data sets available for the the given source and instruments.
DatasetDescription[]	getDatasetsByInstrument(java.lang.String[] missionGroups, java.lang.String[] instruments, TimeInterval timeInterval, java.lang.String idPattern, java.lang.String labelPattern, java.lang.String notesPattern) Provides the names of all the data sets available for the the given source, instruments, time interval, and search pattern.
DatasetDescription[]	getDatasetsBySource(java.lang.String[] sources, java.lang.String[] instrumentTypes) Provides a description of all the data sets available for the given data source and instrument types.
DatasetDescription[]	getDatasetsBySource(java.lang.String[] sources, java.lang.String[] instrumentTypes, TimeInterval timeInterval, java.lang.String idPattern, java.lang.String labelPattern, java.lang.String notesPattern) Provides a description of all the data sets available for the given data source,instrument types, time interval, and search pattern.
java.lang.String[][]	getDatasetVariables(java.lang.String dataset) Provides the name, DICT_KEY attribute, and CATDESC attribute of the variables available in the given data set.
java.lang.String[]	getDataUrls(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime) Deprecated. As of CDAS Web Service 1.6.7, replaced by getDataFiles(String, Date, Date)
java.lang.String[]	getDataUrls(java.lang.String dataset, java.util.Date startTime, java.util.Date endTime, java.lang.String[] variables) Deprecated. As of CDAS Web Service 1.6.7, replaced by getDataFiles(String, Date, Date, String[])
java.lang.String[]	getInstrTypesForGroups(java.lang.String[] groups) Provides the names of all the instrument types available for the specified mission groups.
InstrumentDescription[]	getInstrumentDescriptions(java.lang.String[] sources) Provides descriptions of the instruments available for the specified data sources.
java.lang.String[][]	getInstruments(java.lang.String[] sources) Provides the names of all the instruments available for the specified mission sources.
java.lang.String[]	getInstrumentTypes(java.lang.String[] sources) Provides the names of all the instrument types available for the specified mission sources.
InventoryDescription	getInventory(java.lang.String dataset) Provides the time intervals when data is available for this dataset.
MissionGroupDescription[]	getMissionGroupDescriptions() Provides a description of all the mission groups in this view.
SourceDescription[]	getSourceDescriptions(java.lang.String[] instrumentTypes) Provides the names of the mission data sources at the specified sites providing this specified instrument type data.
SourceDescription[]	getSourceDescriptionsByInstrument(java.lang.String[] instruments) Provides descriptions of the mission data sources providing the specified instrument data.
java.lang.String[][]	getSources(java.lang.String[] instrumentTypes) Provides the names of all the mission data sources providing this specified instrument type data.
java.lang.String[][]	getSourcesByInstrument(java.lang.String[] instruments) Provides the names of all the mission data sources providing the specified instrument data.
ResultDescription	getThumbnailExpansion(gov.nasa.gsfc.spdf.cdas.ThumbnailDescription thumbnailDescription, int thumbnail) Provides the full size image of a thumbnail image previously returned by a call to getDataGraph.
VariableDescription[]	getVariableDescriptions(java.lang.String dataset) Provides a description of the variables within the given dataset.
void	updateMetadataIndex() Deprecated. As of CDAS Web Services 1.6.18, this method does nothing.

Method Detail

getAllViewDescriptions

ViewDescription[] getAllViewDescriptions()
                                  throws java.rmi.RemoteException

Provides a description of all the data views available.

Returns:

array containing descriptions of all the available data views.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getAllMissionGroups

java.lang.String[] getAllMissionGroups()
                                throws java.rmi.RemoteException

Provides the names of all the mission groups in this view.

Returns:

array containing the names of all the mission groups available in this view

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getMissionGroupDescriptions

MissionGroupDescription[] getMissionGroupDescriptions()
                                               throws java.rmi.RemoteException

Provides a description of all the mission groups in this view.

Returns:

array containing descriptions of all the mission groups available in this view

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.7

getAllInstrumentTypes

java.lang.String[] getAllInstrumentTypes()
                                  throws java.rmi.RemoteException

Provides the names of all instrument types available in this view.

Returns:

array containing the names of all the instrument types available in this view

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getAllInstruments

java.lang.String[][] getAllInstruments()
                                throws java.rmi.RemoteException

Provides the names of all instruments available in this view.

Returns:

array containing the names of all the instruments available in this view. element[i][0] contains the short, encoded name while element[i][1] contains the corresponding textual name

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

See Also:

getAllInstrumentDescriptions()

getAllInstrumentDescriptions

InstrumentDescription[] getAllInstrumentDescriptions()
                                              throws java.rmi.RemoteException

Provides descriptions of all instruments available in this view. This method is functionally equivalent to getAllInstruments() but is better supported by some Web service client environments (for example, Adobe Flash and Microsoft .NET).

Returns:

array containing descriptions of all the instruments available in this view.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.17

getSources

java.lang.String[][] getSources(java.lang.String[] instrumentTypes)
                         throws java.rmi.RemoteException

Provides the names of all the mission data sources providing this specified instrument type data.

Parameters:

instrumentTypes - instrument types (zero elements indicates all instrument types)

Returns:

array containing the names of all the sources available. element[i][0] contains the short, encoded name while element[i][1] contains the corresponding textual name

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

See Also:

getSourceDescriptions(String[])

getSourceDescriptions

SourceDescription[] getSourceDescriptions(java.lang.String[] instrumentTypes)
                                   throws java.rmi.RemoteException

Provides the names of the mission data sources at the specified sites providing this specified instrument type data. This method is functionally equivalent to getSources(String[]) but is better supported by some Web service client environments (for example, Adobe Flash and Microsoft .NET).

Parameters:

instrumentTypes - instrument types (zero elements indicates all instrument types)

Returns:

array containing a description of all the sources available.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.17

getSourcesByInstrument

java.lang.String[][] getSourcesByInstrument(java.lang.String[] instruments)
                                     throws java.rmi.RemoteException

Provides the names of all the mission data sources providing the specified instrument data.

Parameters:

instruments - instruments of interest (zero elements indicates all instruments)

Returns:

array containing the names of all the sources available. element[i][0] contains the short, encoded name while element[i][1] contains the corresponding textual name

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

See Also:

getSourceDescriptionsByInstrument(String[])

getSourceDescriptionsByInstrument

SourceDescription[] getSourceDescriptionsByInstrument(java.lang.String[] instruments)
                                               throws java.rmi.RemoteException

Provides descriptions of the mission data sources providing the specified instrument data. This method is functionally equivalent to getSourcesByInstrument(String[]) but is better supported by some Web service client environments (for example, Adobe Flash and Microsoft .NET).

Parameters:

instruments - instruments of interest (zero elements indicates all instruments)

Returns:

array containing a description of all the sources available.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.17

getInstrumentTypes

java.lang.String[] getInstrumentTypes(java.lang.String[] sources)
                               throws java.rmi.RemoteException

Provides the names of all the instrument types available for the specified mission sources.

Parameters:

sources - identifies desired mission sources (zero elements indicates all mission sources)

Returns:

array containing the names of all the instrument types available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getInstrTypesForGroups

java.lang.String[] getInstrTypesForGroups(java.lang.String[] groups)
                                   throws java.rmi.RemoteException

Provides the names of all the instrument types available for the specified mission groups.

Parameters:

groups - identifies desired mission groups (zero elements indicates all mission groups)

Returns:

array containing the names of all the instrument types available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.18

getInstruments

java.lang.String[][] getInstruments(java.lang.String[] sources)
                             throws java.rmi.RemoteException

Provides the names of all the instruments available for the specified mission sources.

Parameters:

sources - identifies desired mission sources (zero elements indicates all mission sources)

Returns:

array containing the names of all the instruments available in the specified view. element[i][0] contains the short, encoded name while element[i][1] contains the corresponding textual name

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

See Also:

getInstrumentDescriptions(String[])

getInstrumentDescriptions

InstrumentDescription[] getInstrumentDescriptions(java.lang.String[] sources)
                                           throws java.rmi.RemoteException

Provides descriptions of the instruments available for the specified data sources. This method is functionally equivalent to getInstruments(String[]) but is better supported by some Web service client environments (for example, Adobe Flash and Microsoft .NET).

Parameters:

sources - identifies desired data sources (zero elements indicates all data sources)

Returns:

array containing descriptions of all the instruments available for the specified sites and data sources.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.17

getDatasets

DatasetDescription[] getDatasets(java.lang.String[] missionGroups,
                                 java.lang.String[] instrumentTypes)
                          throws java.rmi.RemoteException

Provides a description of all the data sets available for the given mission group and instrument types.

Parameters:

missionGroups - identifies desired mission groups (zero elements indicates all groups)

instrumentTypes - identifies desired instrument types (zero elements indicates all instrument types)

Returns:

array containing a description of all the data sets available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDatasets

DatasetDescription[] getDatasets(java.lang.String[] missionGroups,
                                 java.lang.String[] instrumentTypes,
                                 TimeInterval timeInterval,
                                 java.lang.String idPattern,
                                 java.lang.String labelPattern,
                                 java.lang.String notesPattern)
                          throws java.rmi.RemoteException

Provides a description of all the data sets available for the given mission group, instrument types, time interval, and search patterns. The conditions specified by the individual parameters are logically ANDed together. There are no provisions for expressing more general logical relationships (e.g., OR, NOT, grouping) between the parameters (e.g., labelPattern OR notesPattern). Individual parameter values may support complex logical operators within the parameter. That is, those parameter values which are regular expressions do support all the logial operators supported the java.util.regex expression (e.g., notesPattern= (?s)(?i).*apollo(12|15).*).

Parameters:

missionGroups - identifies desired mission groups (zero elements indicates all groups)

instrumentTypes - identifies desired instrument types (zero elements indicates all instrument types)

timeInterval - restricts the returned datasets to only those whose entire data is within this inclusive interval. A dataset which has data both within and outside this interval will not be returned.

idPattern - a java.util.regex compatible regular expression that must match the dataset's identifier text. Omitting this parameter is equivalent to ".*".

labelPattern - a java.util.regex compatible regular expression that must match the dataset's label text. Omitting this parameter is equivalent to ".*". Embedded matching flag expressions (e.g., (?i) for case insensitive match mode) are supported and likely to be useful in this case.

notesPattern - a java.util.regex compatible regular expression that must match the dataset's notes text. Omitting this parameter is equivalent to ".*". Embedded matching flag expressions (e.g., (?s) for dotall match mode) are supported and likely to be useful in this case.

Returns:

array containing a description of all the data sets available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.7

getDatasetsBySource

DatasetDescription[] getDatasetsBySource(java.lang.String[] sources,
                                         java.lang.String[] instrumentTypes)
                                  throws java.rmi.RemoteException

Provides a description of all the data sets available for the given data source and instrument types.

Parameters:

sources - identifies desired data sources (zero elements indicates all sources)

instrumentTypes - identifies desired instrument types (zero elements indicates all instrument types)

Returns:

array containing a description of all the data sets available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDatasetsBySource

DatasetDescription[] getDatasetsBySource(java.lang.String[] sources,
                                         java.lang.String[] instrumentTypes,
                                         TimeInterval timeInterval,
                                         java.lang.String idPattern,
                                         java.lang.String labelPattern,
                                         java.lang.String notesPattern)
                                  throws java.rmi.RemoteException

Provides a description of all the data sets available for the given data source,instrument types, time interval, and search pattern.

Parameters:

sources - identifies desired data sources (zero elements indicates all sources)

instrumentTypes - identifies desired instrument types (zero elements indicates all instrument types)

timeInterval - restricts the returned datasets to only those within this interval.

idPattern - a java.util.regex compatible regular expression that must match the dataset's identifier text. Omitting this parameter is equivalent to ".*".

labelPattern - a java.util.regex compatible regular expression that must match the dataset's label text. Omitting this parameter is equivalent to ".*".

notesPattern - a java.util.regex compatible regular expression that must match the dataset's notes text. Omitting this parameter is equivalent to ".*". Embedded matching flag expressions (e.g., (?s) for dotall match mode) are supported and likely to be useful in this case.

Returns:

array containing a description of all the data sets available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.7

getDatasetsByInstrument

DatasetDescription[] getDatasetsByInstrument(java.lang.String[] missionGroups,
                                             java.lang.String[] instruments)
                                      throws java.rmi.RemoteException

Provides the names of all the data sets available for the the given source and instruments.

Parameters:

missionGroups - identifies desired mission groups (zero elements indicates all groups)

instruments - identifies desired instruments (zero elements indicates all instruments)

Returns:

array containing a description of all the data sets available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDatasetsByInstrument

DatasetDescription[] getDatasetsByInstrument(java.lang.String[] missionGroups,
                                             java.lang.String[] instruments,
                                             TimeInterval timeInterval,
                                             java.lang.String idPattern,
                                             java.lang.String labelPattern,
                                             java.lang.String notesPattern)
                                      throws java.rmi.RemoteException

Provides the names of all the data sets available for the the given source, instruments, time interval, and search pattern.

Parameters:

missionGroups - identifies desired mission groups (zero elements indicates all groups)

instruments - identifies desired instruments (zero elements indicates all instruments)

timeInterval - restricts the returned datasets to only those within this interval.

idPattern - a java.util.regex compatible regular expression that must match the dataset's identifier text. Omitting this parameter is equivalent to ".*".

labelPattern - a java.util.regex compatible regular expression that must match the dataset's label text. Omitting this parameter is equivalent to ".*".

notesPattern - a java.util.regex compatible regular expression that must match the dataset's notes text. Omitting this parameter is equivalent to ".*". Embedded matching flag expressions (e.g., (?s) for dotall match mode) are supported and likely to be useful in this case.

Returns:

array containing a description of all the data sets available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.7

getDatasetVariables

java.lang.String[][] getDatasetVariables(java.lang.String dataset)
                                  throws java.rmi.RemoteException

Provides the name, DICT_KEY attribute, and CATDESC attribute of the variables available in the given data set.

Parameters:

dataset - identifies data set

Returns:

array containing the names of the variables in the data set. Element[i][0] contains the variable's name. Element[i][1] contains the variables DICT_KEY attribute value. Element[i][2] contains the variables CATDESC attribute value.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

See Also:

getVariableDescriptions(String)

getVariableDescriptions

VariableDescription[] getVariableDescriptions(java.lang.String dataset)
                                       throws java.rmi.RemoteException

Provides a description of the variables within the given dataset. This method is functionally equivalent to getDatasetVariables(String) but is better supported by some Web service client environments (for example, Adobe Flash and Microsoft .NET).

Parameters:

dataset - identifies data set

Returns:

array containing descriptions of the variables in the data set.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.17

getDataUrls

java.lang.String[] getDataUrls(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime)
                        throws java.rmi.RemoteException

Deprecated. As of CDAS Web Service 1.6.7, replaced by getDataFiles(String, Date, Date)

Provides the URLs of the data files for the given data set and time range.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

Returns:

array containing the URLs of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDataUrls

java.lang.String[] getDataUrls(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime,
                               java.lang.String[] variables)
                        throws java.rmi.RemoteException

Deprecated. As of CDAS Web Service 1.6.7, replaced by getDataFiles(String, Date, Date, String[])

Provides the URLs of the data files for the specified data. This method differs from getDataUrls(String, Date, Date) in that only the specified variables are included in the resulting files. Also, whereas getDataUrls(String, Date, Date) returns original data files, the files returned by this method are created by extracting just the specified variable data from the original and merging in significant meta data from the CDAS master CDF for this dataset.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - names of the variables to include in returned files

Returns:

array containing the URLs of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getCdfmlDataUrls

java.lang.String[] getCdfmlDataUrls(java.lang.String dataset,
                                    java.util.Date startTime,
                                    java.util.Date endTime,
                                    int compression)
                             throws java.rmi.RemoteException

Deprecated. As of CDAS Web Service 1.6.7, replaced by getCdfmlDataFiles(String, Date, Date, int)

Provides the URLs of the CDFML-format data files for the given data set and time range. Note that not all datasets contain data that can be represented in CDFML (e.g., mpeg data).

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

compression - type of compression to use on resulting CDFML files: 0 = no compression, 1 = gzip, 2 = zip

Returns:

array containing the URLs of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getCdfmlDataUrls

java.lang.String[] getCdfmlDataUrls(java.lang.String dataset,
                                    java.util.Date startTime,
                                    java.util.Date endTime,
                                    java.lang.String[] variables,
                                    int compression)
                             throws java.rmi.RemoteException

Deprecated. As of CDAS Web Service 1.6.7, replaced by getCdfmlDataFiles(String, Date, Date, String[], int)

Provides the URLs of CDFML-format data files for the specified data. This method differs from getCdfmlDataUrls(String, Date, Date, int) in that only the specified variables are included in the resulting files. Also, whereas getCdfmlDataUrls(String, Date, Date, int) returns CDFML format versions of the original data files, the files returned by this method are created by extracting just the specified variable data from the original and merging in significant meta data from the CDAS master CDF for this dataset.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - contains the names of the variables to be included in returned files

compression - type of compression to use on resulting CDFML files: 0 = no compression, 1 = gzip, 2 = zip

Returns:

URLs of specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDataFiles

FileDescription[] getDataFiles(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime)
                        throws java.rmi.RemoteException

Provides descriptions of the data files for the given data set and time range.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

Returns:

array containing descriptions of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6

See Also:

getDataFiles(String, Date, Date, String[])

getDataFiles

FileDescription[] getDataFiles(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime,
                               java.util.Date ifModifiedSince)
                        throws java.rmi.RemoteException

Provides descriptions of the data files for the given data set and time range. Additionally, only files that have been modified since the given date are returned.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

ifModifiedSince - only get files that have been modified since this date. A null value causes this value to not be considered in selecting files.

Returns:

array containing descriptions of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.7.5

getDataFiles

FileDescription[] getDataFiles(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime,
                               java.lang.String[] variables)
                        throws java.rmi.RemoteException

Provides descriptions of the data files for the specified data. This method differs from getDataFiles(String, Date, Date) in that only the specified variables are included in the resulting files. Also, whereas getDataFiles(String, Date, Date) returns original data files, the files returned by this method are created by extracting just the specified variable data from the original and merging in significant meta data from the CDAS master CDF for this dataset.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - names of the variables to include in returned files

Returns:

array containing descriptions of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6

getDataFiles

FileDescription[] getDataFiles(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime,
                               java.lang.String[] variables,
                               int cdfVersion)
                        throws java.rmi.RemoteException

Provides descriptions of the data files for the specified data. This method differs from getDataFiles(String, Date, Date) in that only the specified variables are included in the resulting files. Also, whereas getDataFiles(String, Date, Date) returns original data files, the files returned by this method are created by extracting just the specified variable data from the original and merging in significant meta data from the CDAS master CDF for this dataset.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - names of the variables to include in returned files

cdfVersion - the CDF version of the created files. Must have a value of 2 or 3.

Returns:

array containing descriptions of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.5

getCdasDataFile

ResultDescription getCdasDataFile(java.lang.String dataset,
                                  TimeInterval[] timeIntervals)
                           throws java.rmi.RemoteException

Provides a description of the data file for the specified data. The file returned by this method are created by extracting all variable data for the specifed time intervals from the original cdf and merging in significant meta data from the CDAS master CDF for this dataset. The given time intervals may be given in any order and overlap. Overlapping intervals are coalesced.

Parameters:

dataset - identifies data set

timeIntervals - time intervals of requested data

Returns:

description of the file containing the specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.15

getCdasDataFile

ResultDescription getCdasDataFile(java.lang.String dataset,
                                  TimeInterval[] timeIntervals,
                                  java.lang.String[] variables)
                           throws java.rmi.RemoteException

Provides a description of the data file for the specified data. The file returned by this method are created by extracting just the specified variable data for the specifed time intervals from the original cdf and merging in significant meta data from the CDAS master CDF for this dataset. The given time intervals may be given in any order and overlap. Overlapping intervals are coalesced.

Parameters:

dataset - identifies data set

timeIntervals - time intervals of requested data

variables - names of the variables to include in returned file

Returns:

description of the file containing the specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.15

getCdasDataFile

ResultDescription getCdasDataFile(java.lang.String dataset,
                                  TimeInterval[] timeIntervals,
                                  int cdfVersion)
                           throws java.rmi.RemoteException

Provides a description of the data file for the specified data. The file returned by this method are created by extracting all variable data for the specifed time intervals from the original cdf and merging in significant meta data from the CDAS master CDF for this dataset. The given time intervals may be given in any order and overlap. Overlapping intervals are coalesced.

Parameters:

dataset - identifies data set

timeIntervals - time intervals of requested data

cdfVersion - the CDF version of the created files. Must have a value of 2 or 3.

Returns:

description of the file containing the specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.15

getCdasDataFile

ResultDescription getCdasDataFile(java.lang.String dataset,
                                  TimeInterval[] timeIntervals,
                                  java.lang.String[] variables,
                                  int cdfVersion)
                           throws java.rmi.RemoteException

Provides a description of the data file for the specified data. The file returned by this method are created by extracting just the specified variable data for the specifed time intervals from the original cdf and merging in significant meta data from the CDAS master CDF for this dataset. The given time intervals may be given in any order and overlap. Overlapping intervals are coalesced.

Parameters:

dataset - identifies data set

timeIntervals - time intervals of requested data

variables - names of the variables to include in returned file

cdfVersion - the CDF version of the created files. Must have a value of 2 or 3.

Returns:

description of the file containing the specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.15

getInventory

InventoryDescription getInventory(java.lang.String dataset)
                           throws java.rmi.RemoteException

Provides the time intervals when data is available for this dataset.

Parameters:

dataset - identifies the dataset

Returns:

an inventory description containing the times when data is available

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6.18

getCdfmlDataFiles

FileDescription[] getCdfmlDataFiles(java.lang.String dataset,
                                    java.util.Date startTime,
                                    java.util.Date endTime,
                                    int compression)
                             throws java.rmi.RemoteException

Provides descriptions of the CDFML-format data files for the given data set and time range. Note that not all datasets contain data that can be represented in CDFML (e.g., mpeg data).

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

compression - type of compression to use on resulting CDFML files: 0 = no compression, 1 = gzip, 2 = zip

Returns:

array containing descriptions of the data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6

See Also:

getCdfmlDataFiles(String, Date, Date, String[], int)

getCdfmlDataFiles

FileDescription[] getCdfmlDataFiles(java.lang.String dataset,
                                    java.util.Date startTime,
                                    java.util.Date endTime,
                                    java.lang.String[] variables,
                                    int compression)
                             throws java.rmi.RemoteException

Provides descriptions of CDFML-format data files for the specified data. This method differs from getCdfmlDataFiles(String, Date, Date, int) in that only the specified variables are included in the resulting files. Also, whereas getCdfmlDataFiles(String, Date, Date, int) returns CDFML format versions of the original data files, the files returned by this method are created by extracting just the specified variable data from the original and merging in significant meta data from the CDAS master CDF for this dataset.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - contains the names of the variables to be included in returned files

compression - type of compression to use on resulting CDFML files: 0 = no compression, 1 = gzip, 2 = zip

Returns:

descriptions of specified data files

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.6

getDataGraph

ResultDescription getDataGraph(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime,
                               java.lang.String[] variables)
                        throws java.rmi.RemoteException

Provides a graph of the specified data.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - contains the names of the variables to be plotted

Returns:

graph of specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDataGraph

ResultDescription getDataGraph(java.lang.String dataset,
                               java.util.Date startTime,
                               java.util.Date endTime,
                               java.lang.String[] variables,
                               long options)
                        throws java.rmi.RemoteException

Provides a graph of the specified data.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - contains the names of the variables to be plotted

options - ploting options specified by a bitwise inclusive OR of the following values:

                0x1 == use coarse noise filtering to remove values
                       outside 3 deviations from mean of all 
                       values in the plotted time interval
                0x2 == double the Y-axis height for time-series 
                       and spectrogram plots

Returns:

graph of specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDataGraph

ResultDescription getDataGraph(java.util.Date startTime,
                               java.util.Date endTime,
                               GraphVariableDescription[] variables,
                               long options,
                               java.lang.String[] formats)
                        throws java.rmi.RemoteException

Provides a graph of the specified data.

Parameters:

startTime - beginning of time range

endTime - end of time range

variables - contains the names of the variables to be plotted. Note:Only one variable description is allowed at this time. A future release will support multiple GraphVariableDescriptions.

options - ploting options specified by a bitwise inclusive OR of the following values:

            0x1 == use coarse noise filtering to remove values
                   outside 3 deviations from mean of all
                   values in the plotted time interval
            0x2 == double the Y-axis height for time-series
                   and spectrogram plots

formats - specifies the desired output formats. Values of GIF, PNG, PS, and PDF are currently allowed. Note that all formats may not be supported for a given dataset. It is not possible to determine programmatically which formats are supported without making a request and examining the results.

Returns:

graph of specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getThumbnailExpansion

ResultDescription getThumbnailExpansion(gov.nasa.gsfc.spdf.cdas.ThumbnailDescription thumbnailDescription,
                                        int thumbnail)
                                 throws java.rmi.RemoteException

Provides the full size image of a thumbnail image previously returned by a call to getDataGraph.

Parameters:

thumbnailDescription - thumbnail description that was returned by getDataGraph with the image of thumbnails

thumbnail - identifies the thumbnail (frame) whose full size image is to be returned. Thumbnail images are counted beginning at one (not zero).

Returns:

full size image of specified thumbnail

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDataAsText

ResultDescription getDataAsText(java.lang.String dataset,
                                java.util.Date startTime,
                                java.util.Date endTime,
                                java.lang.String[] variables)
                         throws java.rmi.RemoteException

Provides the specified data in a textual representation.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - contains the names of the variables to be listed

Returns:

file containing the specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

getDataAsText

ResultDescription getDataAsText(java.lang.String dataset,
                                java.util.Date startTime,
                                java.util.Date endTime,
                                java.lang.String[] variables,
                                java.util.Set<java.lang.String> compression)
                         throws java.rmi.RemoteException

Provides the specified data in a textual representation.

Parameters:

dataset - identifies data set

startTime - beginning of time range

endTime - end of time range

variables - contains the names of the variables to be listed

compression - file compression options. Valid values are: uncompressed, gzip, zip, bzip2.

Returns:

file containing the specified data

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request

Since:

1.7

updateMetadataIndex

void updateMetadataIndex()
                  throws java.rmi.RemoteException

Deprecated. As of CDAS Web Services 1.6.18, this method does nothing.

Causes the internal index for the metadata file for this dataview to be re-created. Note: This method is intended to only be used by the CDAS software itself and not by ordinary CDAS clients.

Throws:

java.rmi.RemoteException - thrown if unable to fulfill request