Package com.esri.arcgisruntime.mapping.floor

Class 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 Detail

      • 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 Detail

      • 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
        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 Map<String,​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 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