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

Class SiteLayerDefinition

java.lang.Object
com.esri.arcgisruntime.mapping.floor.SiteLayerDefinition
All Implemented Interfaces:
JsonSerializable
public final class SiteLayerDefinition extends Object implements JsonSerializable
Defines the properties of the layer that contains sites for a floor-aware map or scene.

The layer contains boundaries of managed sites. A site is the largest space designation in the ArcGIS Indoors Information Model and is used to represent an area such as a campus, a barrack, or an industrial site. A site can contain multiple facilities.

Since:
100.12.0
See Also:

  • Constructor Details

    • SiteLayerDefinition

      public SiteLayerDefinition(String layerId, String nameField, String siteIdField)
      Creates a new SiteLayerDefinition object with the specified layer ID, site name attribute field and site ID attribute field.
      Parameters:
      layerId - an ID that specifies a layer in the map or scene that contains site features
      nameField - the name of the attribute field that contains each site feature's name
      siteIdField - the name of the attribute field that contains each site feature's unique identifier
      Throws:
      IllegalArgumentException - if layerId is null
      IllegalArgumentException - if nameField is null
      IllegalArgumentException - if siteIdField is null
      Since:
      100.12.0

  • Method Details

    • getLayerId

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

    • getNameField

      public String getNameField()
      Gets the name of the attribute field that contains each site feature's name.
      Returns:
      the name of the attribute field that contains each site feature's name
      Since:
      100.12.0

    • getSiteIdField

      public String getSiteIdField()
      Gets the name of the attribute field that contains each site feature's unique identifier.
      Returns:
      the name of the attribute field that contains each site feature's unique identifier
      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 SiteLayerDefinition fromJson(String json)
      Creates a SiteLayerDefinition instance from a JSON string.
      Parameters:
      json - a valid string in JSON format
      Returns:
      a SiteLayerDefinition 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