Class CommonPointRule

  • All Implemented Interfaces:
    Serializable, Comparable<CommonPointRule>, ControlledVocabulary

    @UML(identifier="CV_CommonPointRule",
         specification=ISO_19123)
    public class CommonPointRule
    extends CodeList<CommonPointRule>
    List of codes that identify methods for handling cases where the direct position input to the evaluate operation falls within two or more of the geometric objects. The interpretation of these rules differs between discrete and continuous coverages. In the case of a discrete coverage, each geometry-value pair provides one value for each attribute. The rule is applied to the set of values associated with the set of geometry-value pairs that contain the direct position. In the case of a continuous coverage, a value for each attribute shall be interpolated for each ValueObject that contains the direct position. The rule shall then be applied to the set of interpolated values for each attribute.
    Since:
    GeoAPI 2.1
    See Also:
    Coverage.getCommonPointRule(), Serialized Form
    • Field Detail

      • AVERAGE

        @UML(identifier="average",
             obligation=CONDITIONAL,
             specification=ISO_19123)
        public static final CommonPointRule AVERAGE
        The mean of the feature attribute values.
      • LOW

        @UML(identifier="low",
             obligation=CONDITIONAL,
             specification=ISO_19123)
        public static final CommonPointRule LOW
        The least of the feature attribute values.
      • HIGH

        @UML(identifier="high",
             obligation=CONDITIONAL,
             specification=ISO_19123)
        public static final CommonPointRule HIGH
        The greatest of the feature attribute values.
      • ALL

        @UML(identifier="all",
             obligation=CONDITIONAL,
             specification=ISO_19123)
        public static final CommonPointRule ALL
        All the feature attribute values that can be determined for the input direct position.
      • START

        @UML(identifier="start",
             obligation=CONDITIONAL,
             specification=ISO_19123)
        public static final CommonPointRule START
        The start value of the second value segment. Applies only to segmented curve coverages.
      • END

        @UML(identifier="end",
             obligation=CONDITIONAL,
             specification=ISO_19123)
        public static final CommonPointRule END
        The end value of the first value segment. Applies only to segmented curve coverages.
    • Method Detail

      • values

        public static CommonPointRule[] values()
        Returns the list of CommonPointRules.
        Returns:
        the list of codes declared in the current JVM.
      • family

        public CommonPointRule[] family()
        Returns the list of codes of the same kind than this code list element. Invoking this method is equivalent to invoking values(), except that this method can be invoked on an instance of the parent CodeList class.
        Specified by:
        family in interface ControlledVocabulary
        Specified by:
        family in class CodeList<CommonPointRule>
        Returns:
        all code values for this code list.
      • valueOf

        public static CommonPointRule valueOf​(String code)
        Returns the common point rule that matches the given string, or returns a new one if none match it. More specifically, this methods returns the first instance for which name().equals(code) returns true. If no existing instance is found, then a new one is created for the given name.
        Parameters:
        code - the name of the code to fetch or to create.
        Returns:
        a code matching the given name.