Class DisplayFilter

    • Constructor Summary

      Constructors 
      Constructor Description
      DisplayFilter​(java.lang.String name, java.lang.String whereClause)
      Creates a new DisplayFilter with the specified name and where clause.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getFilterId()
      Gets the identifier for this display filter.
      java.lang.String getName()
      Gets a descriptive name for this display filter.
      java.lang.String getWhereClause()
      Gets a SQL expression that defines which features are rendered.
      void setName​(java.lang.String name)
      Sets a descriptive name for this display filter.
      void setWhereClause​(java.lang.String whereClause)
      Sets a SQL expression that defines which features are rendered.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • DisplayFilter

        public DisplayFilter​(java.lang.String name,
                             java.lang.String whereClause)
        Creates a new DisplayFilter with the specified name and where clause.
        Parameters:
        name - a descriptive name for this display filter
        whereClause - a SQL expression that defines which features are rendered
        Throws:
        java.lang.IllegalArgumentException - if name is null or empty
        java.lang.IllegalArgumentException - if whereClause is null or empty
        Since:
        100.13.0
    • Method Detail

      • getFilterId

        public java.lang.String getFilterId()
        Gets the identifier for this display filter.

        Use a unique name to identify this display filter when used in a webmap as a ManualDisplayFilterDefinition.getActiveFilter().

        Returns:
        the identifier for this display filter
        Since:
        100.13.0
      • getName

        public java.lang.String getName()
        Gets a descriptive name for this display filter.
        Returns:
        a descriptive name for this display filter
        Since:
        100.13.0
      • setName

        public void setName​(java.lang.String name)
        Sets a descriptive name for this display filter.
        Parameters:
        name - a descriptive name for this display filter
        Throws:
        java.lang.IllegalArgumentException - if name is null
        Since:
        100.13.0