Class FacilityLayerDefinition
- All Implemented Interfaces:
JsonSerializable
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:
-
Constructor Summary
ConstructorDescriptionFacilityLayerDefinition
(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
Modifier and TypeMethodDescriptionstatic FacilityLayerDefinition
Creates a FacilityLayerDefinition instance from a JSON string.Gets the name of the attribute field that contains a facility feature's unique identifier.Gets an ID that specifies a layer in the map or scene that contains facilities.Gets the name of the attribute field that contains each facility feature's name.Gets the name of the attribute field that contains a facility feature's site identifier (a foreign key to the Site layer).Gets unknown data from the source JSON.Gets unsupported data from the source JSON.toJson()
Serializes this object to a JSON string.
-
Constructor Details
-
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 Details
-
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
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
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
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
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 interfaceJsonSerializable
- Returns:
- an unmodifiable Map containing unknown data from the source JSON
-
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 interfaceJsonSerializable
- Returns:
- an unmodifiable Map containing unsupported data from the source JSON
-
fromJson
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
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
-