Class FacilityLayerDefinition
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.floor.FacilityLayerDefinition
-
- All Implemented Interfaces:
JsonSerializable
public final class FacilityLayerDefinition extends Object implements JsonSerializable
Defines the properties for the layer that contains facilities for a floor-aware map or scene.The layer contains the footprints of managed facilities. A facility represents any occupiable structure, such as an office or campus building, retail setting, or industrial structure. Facilities have one or more floor levels and are optionally grouped into sites.
- Since:
- 100.12.0
- See Also:
GeoModelFloorDefinition
-
-
Constructor Summary
Constructors Constructor Description FacilityLayerDefinition(String layerId, String facilityIdField, String nameField, String siteIdField)
Creates a new FacilityLayerDefinition object with the specified layer ID, facility ID attribute field, facility name attribute field and site ID attribute field.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static FacilityLayerDefinition
fromJson(String json)
Creates a FacilityLayerDefinition instance from a JSON string.String
getFacilityIdField()
Gets the name of the attribute field that contains a facility feature's unique identifier.String
getLayerId()
Gets an ID that specifies a layer in the map or scene that contains facilities.String
getNameField()
Gets the name of the attribute field that contains each facility feature's name.String
getSiteIdField()
Gets the name of the attribute field that contains a facility feature's site identifier (a foreign key to the Site layer).Map<String,Object>
getUnknownJson()
If this object was created from JSON, this method gets unknown data from the source JSON.Map<String,Object>
getUnsupportedJson()
If this object was created from JSON, this method gets unsupported data from the source JSON.String
toJson()
Serializes this object to a JSON string.
-
-
-
Constructor Detail
-
FacilityLayerDefinition
public FacilityLayerDefinition(String layerId, String facilityIdField, String nameField, String siteIdField)
Creates a new FacilityLayerDefinition object with the specified layer ID, facility ID attribute field, facility name attribute field and site ID attribute field.- Parameters:
layerId
- an ID that specifies a layer in the map or scene that contains facilitiesfacilityIdField
- the name of the attribute field that contains a facility feature's unique identifiernameField
- the name of the attribute field that contains a facility feature's namesiteIdField
- the name of the attribute field that contains a facility feature's site identifier (a foreign key to the layer that contains sites), may be null- Throws:
IllegalArgumentException
- if layerId is nullIllegalArgumentException
- if facilityIdField is nullIllegalArgumentException
- if nameField is null- Since:
- 100.12.0
-
-
Method Detail
-
getFacilityIdField
public String getFacilityIdField()
Gets the name of the attribute field that contains a facility feature's unique identifier.- Returns:
- the name of the attribute field that contains a facility feature's unique identifier
- Since:
- 100.12.0
-
getLayerId
public String getLayerId()
Gets an ID that specifies a layer in the map or scene that contains facilities. The layer provides access to facility features for floor filtering.- Returns:
- an ID that specifies a layer in the map or scene that contains facilities
- Since:
- 100.12.0
-
getNameField
public String getNameField()
Gets the name of the attribute field that contains each facility feature's name.- Returns:
- the name of the attribute field that contains each facility feature's name
- Since:
- 100.12.0
-
getSiteIdField
public String getSiteIdField()
Gets the name of the attribute field that contains a facility feature's site identifier (a foreign key to the Site layer). This property is optional.- Returns:
- the name of the attribute field that contains a facility feature's site identifier. Return empty string 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 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 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 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 FacilityLayerDefinition fromJson(String json)
Creates a FacilityLayerDefinition instance from a JSON string.- Parameters:
json
- a valid string in JSON format- Returns:
- a FacilityLayerDefinition 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 interfaceJsonSerializable
- Returns:
- a JSON string
-
-