Class LevelLayerDefinition
- java.lang.Object
-
- com.esri.arcgisruntime.mapping.floor.LevelLayerDefinition
-
- All Implemented Interfaces:
JsonSerializable
public final class LevelLayerDefinition extends Object implements JsonSerializable
Defines the properties of the layer that contains floor levels for a floor-aware map or scene. A floor level describes the footprint of each occupiable floor contained in a managed facility.- Since:
- 100.12.0
- See Also:
GeoModelFloorDefinition
-
-
Constructor Summary
Constructors Constructor Description LevelLayerDefinition(String layerId, String levelIdField, String levelNumberField, String shortNameField, String longNameField, String verticalOrderField, String facilityIdField)
Creates a new LevelLayerDefinition object using the specified layer ID, level ID field, level number field, short name field, long name field, vertical order field, and facility ID field.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static LevelLayerDefinition
fromJson(String json)
Creates a LevelLayerDefinition instance from a JSON string.String
getFacilityIdField()
Gets the name of the attribute field that contains each floor level feature's facility identifier (a foreign key to the layer that contains facility features).String
getLayerId()
Gets an ID that specifies a layer in the map or scene that contains floor level features.String
getLevelIdField()
Gets the name of the attribute field that contains each floor level feature's unique identifier.String
getLevelNumberField()
Gets the name of the attribute field that contains each floor level feature's level number specific to its facility.String
getLongNameField()
Gets the name of the attribute field that contains each floor level feature's long name.String
getShortNameField()
Gets the name of the attribute field that contains each floor level feature's short name.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
getVerticalOrderField()
Gets the name of the attribute field that contains each floor level feature's vertical order.String
toJson()
Serializes this object to a JSON string.
-
-
-
Constructor Detail
-
LevelLayerDefinition
public LevelLayerDefinition(String layerId, String levelIdField, String levelNumberField, String shortNameField, String longNameField, String verticalOrderField, String facilityIdField)
Creates a new LevelLayerDefinition object using the specified layer ID, level ID field, level number field, short name field, long name field, vertical order field, and facility ID field.- Parameters:
layerId
- an ID that specifies a layer in the map or scene that describes floor levelslevelIdField
- the name of the attribute field that contains each level feature's unique identifierlevelNumberField
- the name of the attribute field that contains each level feature's level number specific to its facilityshortNameField
- the name of the attribute field that contains each level feature's short namelongNameField
- the name of the attribute field that contains each level feature's long nameverticalOrderField
- the name of the attribute field that contains each level feature's vertical order. The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.facilityIdField
- the name of the attribute field that contains each level feature's facility identifier (a foreign key to the layer that contains facility features)- Throws:
IllegalArgumentException
- if layerId is nullIllegalArgumentException
- if levelIdField is nullIllegalArgumentException
- if levelNumberField is nullIllegalArgumentException
- if shortNameField is nullIllegalArgumentException
- if longNameField is nullIllegalArgumentException
- if verticalOrderField is nullIllegalArgumentException
- if facilityIdField is null- Since:
- 100.12.0
-
-
Method Detail
-
getFacilityIdField
public String getFacilityIdField()
Gets the name of the attribute field that contains each floor level feature's facility identifier (a foreign key to the layer that contains facility features).- Returns:
- the name of the attribute field that contains each floor level feature's facility identifier
- Since:
- 100.12.0
-
getLayerId
public String getLayerId()
Gets an ID that specifies a layer in the map or scene that contains floor level features.- Returns:
- an ID that specifies a layer in the map or scene that contains floor level features
- Since:
- 100.12.0
-
getLevelIdField
public String getLevelIdField()
Gets the name of the attribute field that contains each floor level feature's unique identifier.- Returns:
- the name of the attribute field that contains each floor level feature's unique identifier
- Since:
- 100.12.0
-
getLevelNumberField
public String getLevelNumberField()
Gets the name of the attribute field that contains each floor level feature's level number specific to its facility.- Returns:
- the name of the attribute field that contains each floor level feature's level number specific to its facility
- Since:
- 100.12.0
-
getLongNameField
public String getLongNameField()
Gets the name of the attribute field that contains each floor level feature's long name.- Returns:
- the name of the attribute field that contains each floor level feature's long name
- Since:
- 100.12.0
-
getShortNameField
public String getShortNameField()
Gets the name of the attribute field that contains each floor level feature's short name.- Returns:
- the name of the attribute field that contains each floor level feature's short name
- Since:
- 100.12.0
-
getVerticalOrderField
public String getVerticalOrderField()
Gets the name of the attribute field that contains each floor level feature's vertical order.The vertical order defines the order of display in a floor filtering UI component, and it also references the floor levels of an Indoor Positioning System.
- Returns:
- the name of the attribute field that contains each floor level feature's vertical order
- 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 LevelLayerDefinition fromJson(String json)
Creates a LevelLayerDefinition instance from a JSON string.- Parameters:
json
- a valid string in JSON format- Returns:
- a LevelLayerDefinition 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
-
-