com.esri.arcgis.networkanalyst
Interface INALocatorFeatureAgent2

All Superinterfaces:

INALocatorFeatureAgent, Serializable

All Known Implementing Classes:

NALocatorFeatureAgent

public interface INALocatorFeatureAgent2
extends INALocatorFeatureAgent, Serializable

Provides access to properties of the feature locator agent.

Remarks

The INALocatorFeatureAgent2 interface allows you to specify a locator for spatial searching on a network source (a feature class).

There are properties to constrain the locator to a particular subtype. You can also specify a where clause to constrain the locator to only search on a subset of features. This is useful if you don't want to locate on features that may be restricted.

You need to call the Bind method after setting these properties before using the locator agent.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	getFullWhereClause() The full where clause including the subtype predicate in the UseSubtype case.
String	getWhereClause() The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.
void	setWhereClause(String whereClause) The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.

Methods inherited from interface com.esri.arcgis.networkanalyst.INALocatorFeatureAgent

getSnapType, getSourceName, getSubtypeCode, isUseSubtype, setSnapType, setSourceName, setSubtypeCode, setUseSubtype

Method Detail

setWhereClause

void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException

The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.

Remarks

The WhereClause specifies the user-defined portion of the where clause on the spatial filter that is used to constrain the features searched within the source feature class when finding the closest network location.

This is useful if you don't want to locate on features that may be restricted or otherwise undesirable to search on. For example, if you are using StreetMap network data, streets with a Speed of 1 are considered restricted. Thus, you may want to specify a where clause of "SPEED > 1" to ensure there streets are not considered when finding network locations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException

The where clause to filter candidate locations not including the subtype predicate in the UseSubtype case.

Remarks

The WhereClause specifies the user-defined portion of the where clause on the spatial filter that is used to constrain the features searched within the source feature class when finding the closest network location.

This is useful if you don't want to locate on features that may be restricted or otherwise undesirable to search on. For example, if you are using StreetMap network data, streets with a Speed of 1 are considered restricted. Thus, you may want to specify a where clause of "SPEED > 1" to ensure there streets are not considered when finding network locations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFullWhereClause

String getFullWhereClause()
                          throws IOException,
                                 AutomationException

The full where clause including the subtype predicate in the UseSubtype case.

Remarks

The FullWhereClause returns the where clause on the spatial filter that is used to constrain the features searched within the source feature class when finding the closest network location.

It is a concatenation of the WhereClause property and the subtype constraint set by the UseSubtype and SubytpeCode properties.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The fullWhereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.