|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface CoordinatedDataAnalysisSystem
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:
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.getAllMissionGroups() and
getAllInstrumentTypes() (or
possibly getSources() and
getAllInstruments().getDatasets() (or
getDatasetsBySource()).getDataAsText(),
getDataFiles(), or
getDataGraph().Notes:
ViewDescription.publicAccess) require basic HTTP
authentication.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 about this Web Service
that is valuable to a client developer regardless of the
language or tools they may be using.DatasetDescription.id value set to a SPASE
ResourceID of the NumericalData corresponding to an CDAS
dataset. The following additional notes apply to SPASE
ResourceIDs:
| Method Summary | |
|---|---|
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. |
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.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[] |
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[] |
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. |
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. |
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 |
|---|
ViewDescription[] getAllViewDescriptions()
throws java.rmi.RemoteException
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[] getAllMissionGroups()
throws java.rmi.RemoteException
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[] getAllInstrumentTypes()
throws java.rmi.RemoteException
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[][] getAllInstruments()
throws java.rmi.RemoteException
java.rmi.RemoteException - thrown if unable to fulfill requestgetAllInstrumentDescriptions()
InstrumentDescription[] getAllInstrumentDescriptions()
throws java.rmi.RemoteException
getAllInstruments() but is better supported by some Web
service client environments (for example, Adobe Flash and
Microsoft .NET).
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[][] getSources(java.lang.String[] instrumentTypes)
throws java.rmi.RemoteException
instrumentTypes - instrument types (zero elements indicates
all instrument types)
java.rmi.RemoteException - thrown if unable to fulfill requestgetSourceDescriptions(String[])
SourceDescription[] getSourceDescriptions(java.lang.String[] instrumentTypes)
throws java.rmi.RemoteException
getSources(String[]) but is better supported by some Web
service client environments (for example, Adobe Flash and
Microsoft .NET).
instrumentTypes - instrument types (zero elements indicates
all instrument types)
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[][] getSourcesByInstrument(java.lang.String[] instruments)
throws java.rmi.RemoteException
instruments - instruments of interest (zero elements
indicates all instruments)
java.rmi.RemoteException - thrown if unable to fulfill requestgetSourceDescriptionsByInstrument(String[])
SourceDescription[] getSourceDescriptionsByInstrument(java.lang.String[] instruments)
throws java.rmi.RemoteException
getSourcesByInstrument(String[]) but is better
supported by some Web service client environments (for example,
Adobe Flash and Microsoft .NET).
instruments - instruments of interest (zero elements
indicates all instruments)
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[] getInstrumentTypes(java.lang.String[] sources)
throws java.rmi.RemoteException
sources - identifies desired mission sources (zero elements
indicates all mission sources)
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[] getInstrTypesForGroups(java.lang.String[] groups)
throws java.rmi.RemoteException
groups - identifies desired mission groups (zero elements
indicates all mission groups)
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[][] getInstruments(java.lang.String[] sources)
throws java.rmi.RemoteException
sources - identifies desired mission sources (zero elements
indicates all mission sources)
java.rmi.RemoteException - thrown if unable to fulfill requestgetInstrumentDescriptions(String[])
InstrumentDescription[] getInstrumentDescriptions(java.lang.String[] sources)
throws java.rmi.RemoteException
getInstruments(String[]) but is better
supported by some Web service client environments (for example,
Adobe Flash and Microsoft .NET).
sources - identifies desired data sources (zero elements
indicates all data sources)
java.rmi.RemoteException - thrown if unable to fulfill request
DatasetDescription[] getDatasets(java.lang.String[] missionGroups,
java.lang.String[] instrumentTypes)
throws java.rmi.RemoteException
missionGroups - identifies desired mission groups (zero
elements indicates all groups)instrumentTypes - identifies desired instrument types (zero
elements indicates all instrument types)
java.rmi.RemoteException - thrown if unable to fulfill request
DatasetDescription[] getDatasetsBySource(java.lang.String[] sources,
java.lang.String[] instrumentTypes)
throws java.rmi.RemoteException
sources - identifies desired data sources (zero elements
indicates all sources)instrumentTypes - identifies desired instrument types (zero
elements indicates all instrument types)
java.rmi.RemoteException - thrown if unable to fulfill request
DatasetDescription[] getDatasetsByInstrument(java.lang.String[] missionGroups,
java.lang.String[] instruments)
throws java.rmi.RemoteException
missionGroups - identifies desired mission groups (zero elements
indicates all groups)instruments - identifies desired instruments (zero elements
indicates all instruments)
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[][] getDatasetVariables(java.lang.String dataset)
throws java.rmi.RemoteException
dataset - identifies data set
java.rmi.RemoteException - thrown if unable to fulfill requestgetVariableDescriptions(String)
VariableDescription[] getVariableDescriptions(java.lang.String dataset)
throws java.rmi.RemoteException
getDatasetVariables(String) but is better
supported by some Web service client environments (for example,
Adobe Flash and Microsoft .NET).
dataset - identifies data set
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[] getDataUrls(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime)
throws java.rmi.RemoteException
getDataFiles(String, Date, Date)
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time range
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[] getDataUrls(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
java.lang.String[] variables)
throws java.rmi.RemoteException
getDataFiles(String, Date, Date, String[])
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.
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - names of the variables to include in returned files
java.rmi.RemoteException - thrown if unable to fulfill request
java.lang.String[] getCdfmlDataUrls(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
int compression)
throws java.rmi.RemoteException
getCdfmlDataFiles(String, Date, Date, int)
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangecompression - type of compression to use on resulting CDFML files:
0 = no compression, 1 = gzip, 2 = zip
java.rmi.RemoteException - thrown if unable to fulfill request
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
getCdfmlDataFiles(String, Date, Date, String[], int)
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.
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - contains the names of the variables to be included
in returned filescompression - type of compression to use on resulting CDFML files:
0 = no compression, 1 = gzip, 2 = zip
java.rmi.RemoteException - thrown if unable to fulfill request
FileDescription[] getDataFiles(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime)
throws java.rmi.RemoteException
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time range
java.rmi.RemoteException - thrown if unable to fulfill requestgetDataFiles(String, Date, Date, String[])
FileDescription[] getDataFiles(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
java.lang.String[] variables)
throws java.rmi.RemoteException
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.
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - names of the variables to include in returned files
java.rmi.RemoteException - thrown if unable to fulfill request
FileDescription[] getDataFiles(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
java.lang.String[] variables,
int cdfVersion)
throws java.rmi.RemoteException
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.
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - names of the variables to include in returned filescdfVersion - the CDF version of the created files. Must have
a value of 2 or 3.
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getCdasDataFile(java.lang.String dataset,
TimeInterval[] timeIntervals)
throws java.rmi.RemoteException
dataset - identifies data settimeIntervals - time intervals of requested data
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getCdasDataFile(java.lang.String dataset,
TimeInterval[] timeIntervals,
java.lang.String[] variables)
throws java.rmi.RemoteException
dataset - identifies data settimeIntervals - time intervals of requested datavariables - names of the variables to include in returned
file
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getCdasDataFile(java.lang.String dataset,
TimeInterval[] timeIntervals,
int cdfVersion)
throws java.rmi.RemoteException
dataset - identifies data settimeIntervals - time intervals of requested datacdfVersion - the CDF version of the created files. Must
have a value of 2 or 3.
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getCdasDataFile(java.lang.String dataset,
TimeInterval[] timeIntervals,
java.lang.String[] variables,
int cdfVersion)
throws java.rmi.RemoteException
dataset - identifies data settimeIntervals - time intervals of requested datavariables - names of the variables to include in returned
filecdfVersion - the CDF version of the created files. Must
have a value of 2 or 3.
java.rmi.RemoteException - thrown if unable to fulfill request
InventoryDescription getInventory(java.lang.String dataset)
throws java.rmi.RemoteException
dataset - identifies the dataset
java.rmi.RemoteException - thrown if unable to fulfill request
FileDescription[] getCdfmlDataFiles(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
int compression)
throws java.rmi.RemoteException
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangecompression - type of compression to use on resulting CDFML files:
0 = no compression, 1 = gzip, 2 = zip
java.rmi.RemoteException - thrown if unable to fulfill requestgetCdfmlDataFiles(String, Date, Date, String[], int)
FileDescription[] getCdfmlDataFiles(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
java.lang.String[] variables,
int compression)
throws java.rmi.RemoteException
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.
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - contains the names of the variables to be included
in returned filescompression - type of compression to use on resulting CDFML files:
0 = no compression, 1 = gzip, 2 = zip
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getDataGraph(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
java.lang.String[] variables)
throws java.rmi.RemoteException
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - contains the names of the variables to be plotted
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getDataGraph(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
java.lang.String[] variables,
long options)
throws java.rmi.RemoteException
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - contains the names of the variables to be
plottedoptions - 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
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getDataGraph(java.util.Date startTime,
java.util.Date endTime,
GraphVariableDescription[] variables,
long options,
java.lang.String[] formats)
throws java.rmi.RemoteException
startTime - beginning of time rangeendTime - end of time rangevariables - 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 plotsformats - specifies the desired output formats. Values of
GIF, 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.
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getThumbnailExpansion(gov.nasa.gsfc.spdf.cdas.ThumbnailDescription thumbnailDescription,
int thumbnail)
throws java.rmi.RemoteException
thumbnailDescription - thumbnail description that was
returned by getDataGraph with the image of thumbnailsthumbnail - identifies the thumbnail (frame) whose full
size image is to be returned
java.rmi.RemoteException - thrown if unable to fulfill request
ResultDescription getDataAsText(java.lang.String dataset,
java.util.Date startTime,
java.util.Date endTime,
java.lang.String[] variables)
throws java.rmi.RemoteException
dataset - identifies data setstartTime - beginning of time rangeendTime - end of time rangevariables - contains the names of the variables to be listed
java.rmi.RemoteException - thrown if unable to fulfill request
void updateMetadataIndex()
throws java.rmi.RemoteException
java.rmi.RemoteException - thrown if unable to fulfill request
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||