com.esri.arcgis.networkanalyst
Interface INASymbolizer

All Superinterfaces:
Serializable
All Known Subinterfaces:
INASymbolizer2
All Known Implementing Classes:
NAClosestFacilitySymbolizer, NAODCostMatrixSymbolizer, NARouteSymbolizer, NAServiceAreaSymbolizer, NAVRPSymbolizer

public interface INASymbolizer
extends Serializable

Provides access to the analysis result drawing.

Superseded By

INASymbolizer2

Remarks

NASymbolizer creates the default symbology for the input and output classes of an NASolver's NAContext. For example, the stops for a route solver are symbolized with located, unlocated or error symbols.

Product Availability

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


Method Summary
 boolean applies(INAContext nAContext)
          Indicates if the symbolizer applies to the analysis context.
 INALayer createLayer(INAContext nAContext)
          Creates a new analysis layer.
 int getPriority()
          The symbolizer priority.
 boolean updateLayer(INALayer nALayer)
          Updates an existing analysis layer.
 

Method Detail

applies

boolean applies(INAContext nAContext)
                throws IOException,
                       AutomationException
Indicates if the symbolizer applies to the analysis context.

Remarks

Applies returns true or false if the symbolizer applies to the solver context specified by NAContext.

Product Availability

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

Parameters:
nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)
Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPriority

int getPriority()
                throws IOException,
                       AutomationException
The symbolizer priority. The highest priority symbolizer is used to create and update the network analysis layer.

Remarks

get_Priority returns the priority of the NASymbolizer. This allows a custom symbolizer with higher priority to be registered with NASymbolizer to be used in place of the default symbolizer for a particular NAContext.

Product Availability

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

Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createLayer

INALayer createLayer(INAContext nAContext)
                     throws IOException,
                            AutomationException
Creates a new analysis layer.

Remarks

CreateLayer creates the symbology for an NALayer's sublayers. For example, the stops for a route solver are symbolized with located, unlocated, or error symbols.

Product Availability

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

Parameters:
nAContext - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)
Returns:
A reference to a com.esri.arcgis.networkanalyst.INALayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateLayer

boolean updateLayer(INALayer nALayer)
                    throws IOException,
                           AutomationException
Updates an existing analysis layer.

Remarks

UpdateLayer updates the existing renderer such as when a service area solver is run again with a different set of breaks.

Product Availability

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

Parameters:
nALayer - A reference to a com.esri.arcgis.networkanalyst.INALayer (in)
Returns:
The updated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.