Package com.esri.arcgisruntime.mapping.floor

Class LevelLayerDefinition

  • All Implemented Interfaces:
    JsonSerializable
    public final class LevelLayerDefinition
extends java.lang.Object
implements JsonSerializable
    Defines the properties of the layer that contains floor levels for a floor-aware map or scene. A floor level describes the footprint of each occupiable floor contained in a managed facility.
    Since:
    100.12.0
    See Also:
    GeoModelFloorDefinition

    • Constructor Summary

      Constructors 
      Constructor Description
      LevelLayerDefinition​(java.lang.String layerId, java.lang.String levelIdField, java.lang.String levelNumberField, java.lang.String shortNameField, java.lang.String longNameField, java.lang.String verticalOrderField, java.lang.String facilityIdField)
      Creates a new LevelLayerDefinition object using the specified layer ID, level ID field, level number field, short name field, long name field, vertical order field, and facility ID field.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static LevelLayerDefinition fromJson​(java.lang.String json)
      Creates a LevelLayerDefinition instance from a JSON string.
      java.lang.String getFacilityIdField()
      Gets the name of the attribute field that contains each floor level feature's facility identifier (a foreign key to the layer that contains facility features).
      java.lang.String getLayerId()
      Gets an ID that specifies a layer in the map or scene that contains floor level features.
      java.lang.String getLevelIdField()
      Gets the name of the attribute field that contains each floor level feature's unique identifier.
      java.lang.String getLevelNumberField()
      Gets the name of the attribute field that contains each floor level feature's level number specific to its facility.
      java.lang.String getLongNameField()
      Gets the name of the attribute field that contains each floor level feature's long name.
      java.lang.String getShortNameField()
      Gets the name of the attribute field that contains each floor level feature's short name.
      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 getVerticalOrderField()
      Gets the name of the attribute field that contains each floor level feature's vertical order.
      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

      • LevelLayerDefinition

        public LevelLayerDefinition​(java.lang.String layerId,
                            java.lang.String levelIdField,
                            java.lang.String levelNumberField,
                            java.lang.String shortNameField,
                            java.lang.String longNameField,
                            java.lang.String verticalOrderField,
                            java.lang.String facilityIdField)
        Creates a new LevelLayerDefinition object using the specified layer ID, level ID field, level number field, short name field, long name field, vertical order field, and facility ID field.
        Parameters:
        layerId - an ID that specifies a layer in the map or scene that describes floor levels
        levelIdField - the name of the attribute field that contains each level feature's unique identifier
        levelNumberField - the name of the attribute field that contains each level feature's level number specific to its facility
        shortNameField - the name of the attribute field that contains each level feature's short name
        longNameField - the name of the attribute field that contains each level feature's long name
        verticalOrderField - the name of the attribute field that contains each level feature's vertical order. The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.
        facilityIdField - the name of the attribute field that contains each level feature's facility identifier (a foreign key to the layer that contains facility features)
        Throws:
        java.lang.IllegalArgumentException - if layerId is null
        java.lang.IllegalArgumentException - if levelIdField is null
        java.lang.IllegalArgumentException - if levelNumberField is null
        java.lang.IllegalArgumentException - if shortNameField is null
        java.lang.IllegalArgumentException - if longNameField is null
        java.lang.IllegalArgumentException - if verticalOrderField is null
        java.lang.IllegalArgumentException - if facilityIdField is null
        Since:
        100.12.0

    • Method Detail

      • getFacilityIdField

        public java.lang.String getFacilityIdField()
        Gets the name of the attribute field that contains each floor level feature's facility identifier (a foreign key to the layer that contains facility features).
        Returns:
        the name of the attribute field that contains each floor level feature's facility identifier
        Since:
        100.12.0

      • getLayerId

        public java.lang.String getLayerId()
        Gets an ID that specifies a layer in the map or scene that contains floor level features.
        Returns:
        an ID that specifies a layer in the map or scene that contains floor level features
        Since:
        100.12.0

      • getLevelIdField

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

      • getLevelNumberField

        public java.lang.String getLevelNumberField()
        Gets the name of the attribute field that contains each floor level feature's level number specific to its facility.
        Returns:
        the name of the attribute field that contains each floor level feature's level number specific to its facility
        Since:
        100.12.0

      • getLongNameField

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

      • getShortNameField

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

      • getVerticalOrderField

        public java.lang.String getVerticalOrderField()
        Gets the name of the attribute field that contains each floor level feature's vertical order.

        The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.

        Returns:
        the name of the attribute field that contains each floor level feature's vertical order
        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 LevelLayerDefinition fromJson​(java.lang.String json)
        Creates a LevelLayerDefinition instance from a JSON string.
        Parameters:
        json - a valid string in JSON format
        Returns:
        a LevelLayerDefinition 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