Package com.esri.arcgisruntime.mapping.floor

Class LayerFloorDefinition

  • All Implemented Interfaces:
    JsonSerializable
    public final class LayerFloorDefinition
extends java.lang.Object
implements JsonSerializable
    Describes how features in a FloorAware layer are associated with floor levels of a facility.

    LayerFloorDefinition defines the properties that are used to filter the levels, or floors, of a facility.

    Since:
    100.12.0
    See Also:
    GeoModelFloorDefinition

    • Constructor Summary

      Constructors 
      Constructor Description
      LayerFloorDefinition​(java.lang.String floorField)
      Creates a new LayerFloorDefinition object with a name of an attribute field.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static LayerFloorDefinition fromJson​(java.lang.String json)
      Creates a LayerFloorDefinition instance from a JSON string.
      java.lang.String getFloorField()
      Gets the name of the attribute field that contains each floor level's ID.
      java.util.Map<java.lang.String,​java.lang.Object> getUnknownJson()
      If this object was created from JSON, this method gets unknown data from the source JSON.
      java.util.Map<java.lang.String,​java.lang.Object> getUnsupportedJson()
      If this object was created from JSON, this method gets unsupported data from the source JSON.
      java.lang.String toJson()
      Serializes this object to a JSON string.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • LayerFloorDefinition

        public LayerFloorDefinition​(java.lang.String floorField)
        Creates a new LayerFloorDefinition object with a name of an attribute field.
        Parameters:
        floorField - the name of the attribute field that contains each floor level's ID
        Throws:
        java.lang.IllegalArgumentException - if floorField is null
        Since:
        100.12.0

    • Method Detail

      • getFloorField

        public java.lang.String getFloorField()
        Gets the name of the attribute field that contains each floor level's ID.
        Returns:
        the name of the attribute field that contains each floor level's ID
        Since:
        100.12.0

      • getUnknownJson

        public java.util.Map<java.lang.String,​java.lang.Object> getUnknownJson()
        Description copied from interface: JsonSerializable
        If this object was created from JSON, this method gets unknown data from the source JSON. Unknown JSON is a Map of values that were in the source JSON but are not known by the Runtime and therefore not exposed in the API.
        Specified by:
        getUnknownJson in interface JsonSerializable
        Returns:
        an unmodifiable Map containing unknown JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:
        • a Map<String, Object> represents an object in the JSON
        • a List<Object> represents an array in the JSON
        • a String represents a string in the JSON
        • a Double represents a number in the JSON
        • a Boolean represents true or false in the JSON
        • null represents null in the JSON

      • getUnsupportedJson

        public java.util.Map<java.lang.String,​java.lang.Object> getUnsupportedJson()
        Description copied from interface: JsonSerializable
        If this object was created from JSON, this method gets unsupported data from the source JSON. Unsupported JSON is a Map of values that are supported by webmaps and known to the version of the webmap specification the API supports (see system requirements), but are not explicitly exposed through the Runtime API.
        Specified by:
        getUnsupportedJson in interface JsonSerializable
        Returns:
        an unmodifiable Map containing unsupported JSON data. The keys are Strings containing names. The types of the values depend on the types of tokens within the JSON as follows:
        • a Map<String, Object> represents an object in the JSON
        • a List<Object> represents an array in the JSON
        • a String represents a string in the JSON
        • a Double represents a number in the JSON
        • a Boolean represents true or false in the JSON
        • null represents null in the JSON

      • fromJson

        public static LayerFloorDefinition fromJson​(java.lang.String json)
        Creates a LayerFloorDefinition instance from a JSON string.
        Parameters:
        json - a valid string in JSON format
        Returns:
        a LayerFloorDefinition instance
        Throws:
        java.lang.IllegalArgumentException - if json is null or empty
        Since:
        100.12.0

      • toJson

        public java.lang.String toJson()
        Description copied from interface: JsonSerializable
        Serializes this object to a JSON string. Note that unknown JSON is omitted from the serialized string.
        Specified by:
        toJson in interface JsonSerializable
        Returns:
        a JSON string