Class SiteLayerDefinition
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.floor.SiteLayerDefinition
-
- All Implemented Interfaces:
JsonSerializable
public final class SiteLayerDefinition extends java.lang.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:
GeoModelFloorDefinition
-
-
Constructor Summary
Constructors Constructor Description SiteLayerDefinition(java.lang.String layerId, java.lang.String nameField, java.lang.String siteIdField)
Creates a new SiteLayerDefinition object with the specified layer ID, site name attribute field and site ID attribute field.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SiteLayerDefinition
fromJson(java.lang.String json)
Creates a SiteLayerDefinition instance from a JSON string.java.lang.String
getLayerId()
Gets an ID that specifies a layer in the map or scene that contains site features.java.lang.String
getNameField()
Gets the name of the attribute field that contains each site feature's name.java.lang.String
getSiteIdField()
Gets the name of the attribute field that contains each site feature's unique identifier.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
toJson()
Serializes this object to a JSON string.
-
-
-
Constructor Detail
-
SiteLayerDefinition
public SiteLayerDefinition(java.lang.String layerId, java.lang.String nameField, java.lang.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 featuresnameField
- the name of the attribute field that contains each site feature's namesiteIdField
- the name of the attribute field that contains each site feature's unique identifier- Throws:
java.lang.IllegalArgumentException
- if layerId is nulljava.lang.IllegalArgumentException
- if nameField is nulljava.lang.IllegalArgumentException
- if siteIdField is null- Since:
- 100.12.0
-
-
Method Detail
-
getLayerId
public java.lang.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 java.lang.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 java.lang.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 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 interfaceJsonSerializable
- 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
- a
-
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 interfaceJsonSerializable
- 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
- a
-
fromJson
public static SiteLayerDefinition fromJson(java.lang.String json)
Creates a SiteLayerDefinition instance from a JSON string.- Parameters:
json
- a valid string in JSON format- Returns:
- a SiteLayerDefinition 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 interfaceJsonSerializable
- Returns:
- a JSON string
-
-