public class

NetworkDescription

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.na.NetworkDescription

Class Overview

Class containing all of the relevant information about the Network Dataset used for routing. This information includes network name, cost attributes, restrictions attributes, supported directions languages, and supported directions styles.

Summary

Public Methods
static NetworkDescription fromJson(JsonParser parser)
List<CostAttribute> getCostAttributes()
Get a list of available cost attributes from the network.
String getName()
Get the name of the Network Dataset associated with the RouteTask.
List<RestrictionAttribute> getRestrictionAttributes()
Get a list of available restriction attributes from the network.
static List<String> getRestrictionUsageParameterValues()
Get a list of the special String values that can be used when setting the value for AttributeParameterValue
List<String> getSupportedDirectionsLanguages()
Get a list of available directions langauges.
List<String> getSupportedDirectionsStyles()
Get a list of available directions styles i.e.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static NetworkDescription fromJson (JsonParser parser)

Parameters
parser JsonParser
Returns
NetworkDescription
Throws
Exception

public List<CostAttribute> getCostAttributes ()

Get a list of available cost attributes from the network. These can be set as accumulate attributes with setAccumulateAttributeNames(String[]) or as the impedance attribute with setImpedanceAttributeName(String).

Returns
List<CostAttribute> List containing all cost attributes in the network.

public String getName ()

Get the name of the Network Dataset associated with the RouteTask.

Returns
String the name of the Network Dataset.

public List<RestrictionAttribute> getRestrictionAttributes ()

Get a list of available restriction attributes from the network. These can be set using setRestrictionAttributeNames(String[]) and individual parameters of these restrictions can be set using setAccumulateAttributeNames(String[]).

Returns
List<RestrictionAttribute> List containing all restriction attributes in the network.

public static List<String> getRestrictionUsageParameterValues ()

Get a list of the special String values that can be used when setting the value for AttributeParameterValue

Returns
List<String> The seven special String keys that can be used along with/instead of numeric values.

public List<String> getSupportedDirectionsLanguages ()

Get a list of available directions langauges. These values can be used in the setDirectionsLanguage(String) method.

Returns
List<String> A list of supported languages.

public List<String> getSupportedDirectionsStyles ()

Get a list of available directions styles i.e. Campus, Desktop, etc. These values can be used in the setDirectionsStyleName(String) method.

Returns
List<String> A list of supported directions styles.