Class GeospatialLayerItem

    • Method Detail

      • layerId

        public final String layerId()

        The ID of the layer.

        Returns:
        The ID of the layer.
      • dataSource

        public final GeospatialDataSourceItem dataSource()

        The data source for the layer.

        Returns:
        The data source for the layer.
      • label

        public final String label()

        The label that is displayed for the layer.

        Returns:
        The label that is displayed for the layer.
      • visibility

        public final Visibility visibility()

        The state of visibility for the layer.

        If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

        Returns:
        The state of visibility for the layer.
        See Also:
        Visibility
      • visibilityAsString

        public final String visibilityAsString()

        The state of visibility for the layer.

        If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

        Returns:
        The state of visibility for the layer.
        See Also:
        Visibility
      • layerDefinition

        public final GeospatialLayerDefinition layerDefinition()

        The definition properties for a layer.

        Returns:
        The definition properties for a layer.
      • tooltip

        public final TooltipOptions tooltip()
        Returns the value of the Tooltip property for this object.
        Returns:
        The value of the Tooltip property for this object.
      • joinDefinition

        public final GeospatialLayerJoinDefinition joinDefinition()

        The join definition properties for a layer.

        Returns:
        The join definition properties for a layer.
      • hasActions

        public final boolean hasActions()
        For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • actions

        public final List<LayerCustomAction> actions()

        A list of custom actions for a layer.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasActions() method.

        Returns:
        A list of custom actions for a layer.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)