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

Class GeoModelFloorDefinition

java.lang.Object
com.esri.arcgisruntime.mapping.floor.GeoModelFloorDefinition
All Implemented Interfaces:
JsonSerializable
public final class GeoModelFloorDefinition extends Object implements JsonSerializable
Contains floor-awareness settings for a map or scene.

GeoModelFloorDefinition defines the required layers, and the required fields for each of those layers in a floor-aware map or scene.

The floor definition must contain getLevelLayerDefinition() and getFacilityLayerDefinition() properties at a minimum representing the facilities (eg. buildings) and the floor levels within those facilities. The getSiteLayerDefinition() property is optional and represents the sites (campuses) that the facilities may be grouped into. //@see LayerFloorDefinition (TODO: uncomment this line when wrapping layer floor definition)

Since:
100.12.0

  • Constructor Details

    • GeoModelFloorDefinition

      public GeoModelFloorDefinition(FacilityLayerDefinition facilityLayerDefinition, LevelLayerDefinition levelLayerDefinition, SiteLayerDefinition siteLayerDefinition)
      Creates a new GeoModelFloorDefinition object with the specified facility layer definition, level layer definition, and site layer definition.
      Parameters:
      facilityLayerDefinition - the layer and field properties for the layer used to describe facilities
      levelLayerDefinition - the layer and field properties for the layer used to describe floor levels
      siteLayerDefinition - the layer and field properties for the layer used to describe sites, may be null
      Throws:
      IllegalArgumentException - if facilityLayerDefinition is null
      IllegalArgumentException - if levelLayerDefinition is null
      Since:
      100.12.0

  • Method Details

    • getFacilityLayerDefinition

      public FacilityLayerDefinition getFacilityLayerDefinition()
      Gets the layer and field properties for the layer used to describe facilities.
      Returns:
      a FacilityLayerDefinition specifying the layer and field properties for the layer used to describe facilities
      Since:
      100.12.0

    • getLevelLayerDefinition

      public LevelLayerDefinition getLevelLayerDefinition()
      Gets the layer and field properties for the layer used to describe floor levels.
      Returns:
      a LevelLayerDefinition specifying the layer and field properties for the layer used to describe floor levels
      Since:
      100.12.0

    • getSiteLayerDefinition

      public SiteLayerDefinition getSiteLayerDefinition()
      Gets the layer and field properties for the layer used to describe sites. This property is optional.
      Returns:
      a SiteLayerDefinition specifying the layer and field properties for the layer used to describe sites. Returns null if none.
      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 GeoModelFloorDefinition fromJson(String json)
      Creates a GeoModelFloorDefinition instance from a JSON string.
      Parameters:
      json - a valid string in JSON format
      Returns:
      a GeoModelFloorDefinition 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