Package gov.nasa.gsfc.spdf.ssc

Class FilteredCoordinateOptions

java.lang.Object

gov.nasa.gsfc.spdf.ssc.CoordinateOptions

gov.nasa.gsfc.spdf.ssc.FilteredCoordinateOptions

public class FilteredCoordinateOptions
extends CoordinateOptions

This class represents coordinate system component options that include location filters.

Version:

$Revison: $

Author:

B. Harris

Constructor Summary

Constructors

Constructor	Description
FilteredCoordinateOptions()	Constructs a FilteredCoordinateOptions object with a default value.
FilteredCoordinateOptions(CoordinateSystem coordinateSystem, CoordinateComponent component, LocationFilter filter)	Constructs a FilteredCoordinateOptions object with the given attribute values.

Method Summary

Modifier and Type	Method	Description
LocationFilter	getFilter()	Gets the filter criteria.
void	setFilter(LocationFilter value)	Sets the filter criteria.

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

getComponent, getCoordinateSystem, setComponent, setCoordinateSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

FilteredCoordinateOptions

public FilteredCoordinateOptions()

Constructs a FilteredCoordinateOptions object with a default value.

FilteredCoordinateOptions

public FilteredCoordinateOptions(CoordinateSystem coordinateSystem,
                                 CoordinateComponent component,
                                 LocationFilter filter)

Constructs a FilteredCoordinateOptions object with the given attribute values.

Parameters:

coordinateSystem - identifies the coordinate system.

component - identifies the componet. LOCAL_TIME is only valid with GEO, GM, GSE, and SM.

filter - coordinate value filter. null indicates no filtering.

Method Detail

getFilter

public LocationFilter getFilter()

Gets the filter criteria.

Returns:

the filter criteria, null if no filter

See Also:

setFilter(gov.nasa.gsfc.spdf.ssc.LocationFilter)

setFilter

public void setFilter(LocationFilter value)

Sets the filter criteria.

Parameters:

value - new value, null for no filter

See Also:

getFilter()