com.esri.core.tasks.ags.na
Class NAFeaturesAsLayer

java.lang.Object
  com.esri.core.tasks.ags.na.NAFeaturesAsLayer

All Implemented Interfaces:

NAFeatures

public class NAFeaturesAsLayer
extends Object
implements NAFeatures

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.

Since:

10.1.1

Constructor Summary

NAFeaturesAsLayer()
Empty constructor

NAFeaturesAsLayer(String layerName)
Constructor taking the layer name

NAFeaturesAsLayer(String layerName, SpatialFilter spatialFilter)
Constructor taking the layer name and a spatial filter

NAFeaturesAsLayer(String layerName, String where)
Constructor taking the layer name and a where clause

Method Summary

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NAFeaturesAsLayer

public NAFeaturesAsLayer()

Empty constructor

Since:

10.1.1

NAFeaturesAsLayer

public NAFeaturesAsLayer(String layerName)

Constructor taking the layer name

Parameters:

layerName - the name of the layer

Since:

10.1.1

NAFeaturesAsLayer

public NAFeaturesAsLayer(String layerName,
                         String where)

Constructor taking the layer name and a where clause

Parameters:

layerName - the name of the layer

where - the where clause for filtering out features

Since:

10.1.1

NAFeaturesAsLayer

public NAFeaturesAsLayer(String layerName,
                         SpatialFilter spatialFilter)

Constructor taking the layer name and a spatial filter

Parameters:

layerName - the name of the layer

spatialFilter - the spatial filter for filtering out features

Since:

10.1.1

Method Detail

getLayerName

public String getLayerName()

Gets the name of the layer containing the features

Returns:

the layerName the name of the layer

Since:

10.1.1

setLayerName

public void setLayerName(String layerName)

Sets the name of the layer containing the features

Parameters:

layerName - the name of the layer

Since:

10.1.1

getWhere

public String getWhere()

Gets the where clause used to filter the features

Returns:

the where clause that filters the features

Since:

10.1.1

setWhere

public void setWhere(String where)

Sets the where clause used to filter the features

Parameters:

where - the where clause that filters the features

Since:

10.1.1

getSpatialFilter

public SpatialFilter getSpatialFilter()

Gets the spatial filter used to filter the features

Returns:

the spatialFilter the SpatialFilter to filter the features

Since:

10.1.1

setSpatialFilter

public void setSpatialFilter(SpatialFilter spatialFilter)

Sets the spatial filter used to filter the features

Parameters:

spatialFilter - the SpatialFilter to filter the features

Since:

10.1.1

isDoNotLocateOnRestrictedElements

public Boolean isDoNotLocateOnRestrictedElements()

Gets whether or not to ignore restricted elements when locating

Returns:

boolean true if restricted elements should be ignored

Since:

10.1.1

setDoNotLocateOnRestrictedElements

public void setDoNotLocateOnRestrictedElements(Boolean doNotLocateOnRestrictedElements)

Sets whether or not to ignore restricted elements when locating

Parameters:

doNotLocateOnRestrictedElements - true if restricted elements should be ignored

Since:

10.1.1

toJson

public String toJson()
              throws Exception

Translates all fields into a JSON object representation

Specified by:

toJson in interface NAFeatures

Returns:

String the JSON representation

Throws:

Exception

Since:

10.1.1

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object