Package gov.nasa.gsfc.spdf.ssc

Class GraphRequest

java.lang.Object

gov.nasa.gsfc.spdf.ssc.Request

gov.nasa.gsfc.spdf.ssc.GraphRequest

public class GraphRequest
extends Request

This class represents a request for a graph from the Satellite Situation Center.

Notes:

• Only one graph options (OrbitGraphOptions, MapProjectionGraphOptions, or TimeSeriesGraphOptions) should be set. It was not possible to have a single, base class (i.e., GraphOptions) attribute instead of the three subclasses since this object is transmitted in a SOAP message.
• These Web services support specifying resolution factors for the requested satellites even though the Satellite Situation Center HTML interface does not.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
GraphRequest()	Constructs an GraphRequest object with a default value.
GraphRequest(java.util.List<SatelliteSpecification> satellites, java.util.Calendar beginTime, java.util.Calendar endTime, BFieldModelOptions bFieldModelOptions, GraphOptions graphOptions)	Constructs an GraphRequest object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
protected GraphOptions	getGraphOptions()	Gets the graph options.
MapProjectionGraphOptions	getMapProjectionOptions()	Gets the mapProjectionOptions value.
OrbitGraphOptions	getOrbitOptions()	Gets the orbitOptions value.
TimeSeriesGraphOptions	getTimeSeriesOptions()	Gets the timeSeriesOptions value.
protected void	setGraphOptions(GraphOptions value)	Sets the graph options.
void	setMapProjectionOptions(MapProjectionGraphOptions value)	Sets the mapProjectionOptions value.
void	setOrbitOptions(OrbitGraphOptions value)	Sets the orbitOptions value.
void	setTimeSeriesOptions(TimeSeriesGraphOptions value)	Sets the timeSeriesOptions value.

Methods inherited from class gov.nasa.gsfc.spdf.ssc.Request

getBeginTime, getBFieldModelOptions, getEndTime, getSatellites, list, setBeginTime, setBFieldModelOptions, setEndTime, setSatellites

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphRequest

public GraphRequest()

Constructs an GraphRequest object with a default value.

GraphRequest

public GraphRequest(java.util.List<SatelliteSpecification> satellites,
                    java.util.Calendar beginTime,
                    java.util.Calendar endTime,
                    BFieldModelOptions bFieldModelOptions,
                    GraphOptions graphOptions)

Constructs an GraphRequest object with the given attribute values.

Parameters:

satellites - identifies the satellites that information is being requested for (required)

beginTime - beginning of time range (required)

endTime - end of time range (required)

bFieldModelOptions - B field model options (optional)

graphOptions - graph options (required)

Method Detail

getGraphOptions

protected GraphOptions getGraphOptions()

Gets the graph options. This method is non-public so the JAX-WS 2.0 wsimport doesn't create a GraphOptions attribute and mis-lead a client into thinking they can pass one of the subclasses.

Returns:

graph options

See Also:

setGraphOptions(gov.nasa.gsfc.spdf.ssc.GraphOptions)

setGraphOptions

protected void setGraphOptions(GraphOptions value)

Sets the graph options. This method is non-public so the JAX-WS 2.0 wsimport doesn't create a GraphOptions attribute and mis-lead a client into thinking they can pass one of the subclasses by calling this method.

Parameters:

value - new value

See Also:

getGraphOptions()

getOrbitOptions

public OrbitGraphOptions getOrbitOptions()

Gets the orbitOptions value.

Returns:

orbitOptions value

See Also:

setOrbitOptions(gov.nasa.gsfc.spdf.ssc.OrbitGraphOptions)

setOrbitOptions

public void setOrbitOptions(OrbitGraphOptions value)

Sets the orbitOptions value.

Parameters:

value - new orbitOptions value

See Also:

getOrbitOptions()

getMapProjectionOptions

public MapProjectionGraphOptions getMapProjectionOptions()

Gets the mapProjectionOptions value.

Returns:

mapProjectionOptions value

See Also:

setMapProjectionOptions(gov.nasa.gsfc.spdf.ssc.MapProjectionGraphOptions)

setMapProjectionOptions

public void setMapProjectionOptions(MapProjectionGraphOptions value)

Sets the mapProjectionOptions value.

Parameters:

value - new mapProjectionOptions value

See Also:

getMapProjectionOptions()

getTimeSeriesOptions

public TimeSeriesGraphOptions getTimeSeriesOptions()

Gets the timeSeriesOptions value.

Returns:

timeSeriesOptions value

See Also:

setTimeSeriesOptions(gov.nasa.gsfc.spdf.ssc.TimeSeriesGraphOptions)

setTimeSeriesOptions

public void setTimeSeriesOptions(TimeSeriesGraphOptions value)

Sets the timeSeriesOptions value.

Parameters:

value - new timeSeriesOptions value

See Also:

getTimeSeriesOptions()