Module com.esri.arcgisruntime
Package com.esri.arcgisruntime.mapping.floor

Class LevelLayerDefinition

java.lang.Object
com.esri.arcgisruntime.mapping.floor.LevelLayerDefinition
All Implemented Interfaces:
JsonSerializable
public final class LevelLayerDefinition extends 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:

  • Constructor Details

    • LevelLayerDefinition

      public LevelLayerDefinition(String layerId, String levelIdField, String levelNumberField, String shortNameField, String longNameField, String verticalOrderField, 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:
      IllegalArgumentException - if layerId is null
      IllegalArgumentException - if levelIdField is null
      IllegalArgumentException - if levelNumberField is null
      IllegalArgumentException - if shortNameField is null
      IllegalArgumentException - if longNameField is null
      IllegalArgumentException - if verticalOrderField is null
      IllegalArgumentException - if facilityIdField is null
      Since:
      100.12.0

  • Method Details

    • getFacilityIdField

      public 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 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 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 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 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 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 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 Map<String,Object> getUnknownJson()
      Description copied from interface: JsonSerializable
      Gets unknown data from the source JSON.

      Unknown JSON is a Map of values not defined in the ArcGIS specification used to create this object but found in the source JSON. If the object is written back to JSON, any unknown JSON data is not persisted. The ArcGIS specification may be for a web map, web scene, REST API, and so on.

      Specified by:
      getUnknownJson in interface JsonSerializable
      Returns:
      an unmodifiable Map containing unknown data from the source JSON

    • getUnsupportedJson

      public Map<String,Object> getUnsupportedJson()
      Description copied from interface: JsonSerializable
      Gets unsupported data from the source JSON.

      Unsupported JSON is a Map of values defined in the ArcGIS specification used to create this object but not currently used in this API. If the object is written back to JSON, any unsupported JSON data is persisted. The ArcGIS specification may be from a web map, web scene, REST API, and so on.

      Specified by:
      getUnsupportedJson in interface JsonSerializable
      Returns:
      an unmodifiable Map containing unsupported data from the source JSON

    • fromJson

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

    • toJson

      public 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