public class

NAFeaturesAsLayer

extends Object
implements NAFeatures
java.lang.Object
   ↳ com.esri.core.tasks.na.NAFeaturesAsLayer

Class Overview

Class containing the name of a layer within the map service containing stops, facilities, incidents, or barriers to use. Includes parameters to choose a subset of that layer.

Summary

Public Constructors
NAFeaturesAsLayer()
Empty constructor
NAFeaturesAsLayer(String layerName)
Constructor taking the layer name
NAFeaturesAsLayer(String layerName, String where)
Constructor taking the layer name and a where clause
NAFeaturesAsLayer(String layerName, SpatialFilter spatialFilter)
Constructor taking the layer name and a spatial filter
Public Methods
boolean equals(Object obj)
String getLayerName()
Gets the name of the layer containing the features
SpatialFilter getSpatialFilter()
Gets the spatial filter used to filter the features
String getWhere()
Gets the where clause used to filter the features
int hashCode()
Boolean isDoNotLocateOnRestrictedElements()
Gets whether or not to ignore restricted elements when locating
void setDoNotLocateOnRestrictedElements(Boolean doNotLocateOnRestrictedElements)
Sets whether or not to ignore restricted elements when locating
void setLayerName(String layerName)
Sets the name of the layer containing the features
void setSpatialFilter(SpatialFilter spatialFilter)
Sets the spatial filter used to filter the features
void setWhere(String where)
Sets the where clause used to filter the features
String toJson()
Translates all fields into a JSON object representation
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.esri.core.tasks.na.NAFeatures

Public Constructors

public NAFeaturesAsLayer ()

Empty constructor

public NAFeaturesAsLayer (String layerName)

Constructor taking the layer name

Parameters
layerName String: the name of the layer

public NAFeaturesAsLayer (String layerName, String where)

Constructor taking the layer name and a where clause

Parameters
layerName String: the name of the layer
where String: the where clause for filtering out features

public NAFeaturesAsLayer (String layerName, SpatialFilter spatialFilter)

Constructor taking the layer name and a spatial filter

Parameters
layerName String: the name of the layer
spatialFilter SpatialFilter: the spatial filter for filtering out features

Public Methods

public boolean equals (Object obj)

Parameters
obj Object
Returns
boolean

public String getLayerName ()

Gets the name of the layer containing the features

Returns
String the layerName the name of the layer

public SpatialFilter getSpatialFilter ()

Gets the spatial filter used to filter the features

Returns
SpatialFilter the spatialFilter the SpatialFilter to filter the features

public String getWhere ()

Gets the where clause used to filter the features

Returns
String the where clause that filters the features

public int hashCode ()

Returns
int

public Boolean isDoNotLocateOnRestrictedElements ()

Gets whether or not to ignore restricted elements when locating

Returns
Boolean boolean true if restricted elements should be ignored

public void setDoNotLocateOnRestrictedElements (Boolean doNotLocateOnRestrictedElements)

Sets whether or not to ignore restricted elements when locating

Parameters
doNotLocateOnRestrictedElements Boolean: true if restricted elements should be ignored

public void setLayerName (String layerName)

Sets the name of the layer containing the features

Parameters
layerName String: the name of the layer

public void setSpatialFilter (SpatialFilter spatialFilter)

Sets the spatial filter used to filter the features

Parameters
spatialFilter SpatialFilter: the SpatialFilter to filter the features

public void setWhere (String where)

Sets the where clause used to filter the features

Parameters
where String: the where clause that filters the features

public String toJson ()

Translates all fields into a JSON object representation

Returns
String String the JSON representation
Throws
Exception