Package gov.nasa.gsfc.spdf.ssc

Class LocationFilter

  • All Implemented Interfaces:
    java.lang.Cloneable
    public class LocationFilter
extends java.lang.Object
implements java.lang.Cloneable
    This class represents location filter listing options. A description of these values is available at the Min Max Filter help and System Range Filters help.
    Notes:
    • The lower/upperDate attributes should never have been defined and were never functional. But the attributes are being retained for backward compatibility.
    Author:
    B. Harris

    • Constructor Summary

      Constructors 
      Constructor Description
      LocationFilter()
      Constructs a LocationFilter object with a default value.
      LocationFilter​(boolean minimum, boolean maximum, java.lang.Double lowerLimit, java.lang.Double upperLimit)
      Constructs a LocationFilter object with the given attribute values.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      java.lang.Object clone()  
      java.util.Calendar getLowerDate()
      Deprecated.
      local-time lower limit values should be gotten with getLowerLimit().
      java.lang.Double getLowerLimit()
      Gets the lower limit value that is to be included in the listing.
      java.util.Calendar getUpperDate()
      Deprecated.
      local-time upper limit values should be gotten with getUpperLimit().
      java.lang.Double getUpperLimit()
      Gets the upper limit value that is to be included in the listing.
      boolean isMaximum()
      Gets the value indicating whether the maximum value is to be marked by a "^" in the listing.
      boolean isMinimum()
      Gets the value indicating whether the minumum value is to be marked by a "v" in the listing.
      void list​(java.io.PrintStream out, java.lang.String title)
      Prints this object's value to the specified output stream.
      void setLowerDate​(java.util.Calendar value)
      Deprecated.
      local-time lower limit values should be set with setLowerLimit(Double).
      void setLowerLimit​(java.lang.Double value)
      Sets the lower limit value that is to be included in the listing.
      void setMaximum​(boolean value)
      Sets the value indicating whether the maximum value is to be marked by a "^" in the listing.
      void setMinimum​(boolean value)
      Sets the value indicating whether the minimum value is to be marked by a "v" in the listing.
      void setUpperDate​(java.util.Calendar value)
      Deprecated.
      local-time upper limit values should be set with setUpperLimit(Double).
      void setUpperLimit​(java.lang.Double value)
      Sets the upper limit value that is to be included in the listing.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LocationFilter

        public LocationFilter()
        Constructs a LocationFilter object with a default value.

      • LocationFilter

        public LocationFilter​(boolean minimum,
                      boolean maximum,
                      java.lang.Double lowerLimit,
                      java.lang.Double upperLimit)
        Constructs a LocationFilter object with the given attribute values.
        Parameters:
        minimum - specifies whether the minimum value is to be marked in the listing.
        maximum - specifies whether the maximum value is to be marked in the listing.
        lowerLimit - specified the lower limit of values that are to be included in the listing.
        upperLimit - specified the upper limit of values that are to be included in the listing.

    • Method Detail

      • isMinimum

        public boolean isMinimum()
        Gets the value indicating whether the minumum value is to be marked by a "v" in the listing.
        Returns:
        true if the minimum value is to be marked by a "v" in the listing, false if not
        See Also:
        setMinimum(boolean)

      • setMinimum

        public void setMinimum​(boolean value)
        Sets the value indicating whether the minimum value is to be marked by a "v" in the listing.
        Parameters:
        value - new value
        See Also:
        isMinimum()

      • isMaximum

        public boolean isMaximum()
        Gets the value indicating whether the maximum value is to be marked by a "^" in the listing.
        Returns:
        true if the maximum value is to be marked by a "^" in the listing, false if not
        See Also:
        setMaximum(boolean)

      • setMaximum

        public void setMaximum​(boolean value)
        Sets the value indicating whether the maximum value is to be marked by a "^" in the listing.
        Parameters:
        value - new value
        See Also:
        isMaximum()

      • getLowerLimit

        public java.lang.Double getLowerLimit()
        Gets the lower limit value that is to be included in the listing. The value is kilometer, degrees, or hours as applicable.
        Returns:
        lower limit value that is to be included in the listing.
        See Also:
        setLowerLimit(java.lang.Double)

      • setLowerLimit

        public void setLowerLimit​(java.lang.Double value)
        Sets the lower limit value that is to be included in the listing. The value is kilometer, degrees, or hours as applicable.
        Parameters:
        value - new value. null indicates no lower limit.
        See Also:
        getLowerLimit()

      • getUpperLimit

        public java.lang.Double getUpperLimit()
        Gets the upper limit value that is to be included in the listing. The value is kilometer, degrees, or hours as applicable.
        Returns:
        upper limit value that is to be included in the listing.
        See Also:
        setUpperLimit(java.lang.Double)

      • setUpperLimit

        public void setUpperLimit​(java.lang.Double value)
        Sets the upper limit value that is to be included in the listing. The value is kilometer, degrees, or hours as applicable.
        Parameters:
        value - new value. null indicates no upper limit.
        See Also:
        getUpperLimit()

      • getLowerDate

        @Deprecated
public java.util.Calendar getLowerDate()
        Deprecated.
        local-time lower limit values should be gotten with getLowerLimit().
        Gets the lower limit Calendar value that is to be included in the listing.
        Returns:
        lower limit value that is to be included in the listing.
        See Also:
        setLowerDate(java.util.Calendar)

      • setLowerDate

        @Deprecated
public void setLowerDate​(java.util.Calendar value)
        Deprecated.
        local-time lower limit values should be set with setLowerLimit(Double).
        Sets the lower limit Calendar value that is to be included in the listing.
        Parameters:
        value - new value. null indicates no lower limit.
        See Also:
        getLowerDate()

      • getUpperDate

        @Deprecated
public java.util.Calendar getUpperDate()
        Deprecated.
        local-time upper limit values should be gotten with getUpperLimit().
        Gets the upper limit Calendar value that is to be included in the listing.
        Returns:
        upper limit value that is to be included in the listing.
        See Also:
        setUpperDate(java.util.Calendar)

      • setUpperDate

        @Deprecated
public void setUpperDate​(java.util.Calendar value)
        Deprecated.
        local-time upper limit values should be set with setUpperLimit(Double).
        Sets the upper limit Calendar value that is to be included in the listing.
        Parameters:
        value - new value. null indicates no upper limit.
        See Also:
        getUpperDate()

      • list

        public void list​(java.io.PrintStream out,
                 java.lang.String title)
        Prints this object's value to the specified output stream. This method is useful for debugging.
        Parameters:
        out - an output stream
        title - a string value that is to preceed this object's value.

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object