com.esri.arcgis.networkanalyst
Class NAServiceAreaSymbolizer

java.lang.Object
  com.esri.arcgis.networkanalyst.NAServiceAreaSymbolizer

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INASymbolizer, INASymbolizer2, Serializable

public class NAServiceAreaSymbolizer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INASymbolizer, INASymbolizer2

Symbolizes service area analysis results.

Remarks

NAServiceAreaSymbolizer allows you to create a new symbolizer for use with a service area layer and register it with the NASymbolizer category. If a symbolizer has a higher priority than the default symbolizer then it will be used in place of the default symbolizer. For example, the default facility symbol could be changed from a dot to a cross.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NAServiceAreaSymbolizer()
Constructs a NAServiceAreaSymbolizer using ArcGIS Engine.

NAServiceAreaSymbolizer(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServiceAreaSymbolizer theNAServiceAreaSymbolizer = (NAServiceAreaSymbolizer) obj;

Method Summary

boolean	applies(INAContext nAContext) Indicates if the symbolizer applies to the analysis context.
INALayer	createLayer(INAContext nAContext) Creates a new analysis layer.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
int	getPriority() The priority is used to determine the best symbolizer to symbolize a network analysis layer.
int	hashCode() the hashcode for this object
void	resetRenderers(IColor solverColor, INALayer nALayer) Resets the renderers based on the provided solver color.
boolean	updateLayer(INALayer nALayer) Updates an existing analysis layer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NAServiceAreaSymbolizer

public NAServiceAreaSymbolizer()
                        throws IOException,
                               UnknownHostException

Constructs a NAServiceAreaSymbolizer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NAServiceAreaSymbolizer

public NAServiceAreaSymbolizer(Object obj)
                        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServiceAreaSymbolizer theNAServiceAreaSymbolizer = (NAServiceAreaSymbolizer) obj;

Construct a NAServiceAreaSymbolizer using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to NAServiceAreaSymbolizer.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

applies

public 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.

Specified by:

applies in interface INASymbolizer

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

public int getPriority()
                throws IOException,
                       AutomationException

The priority is used to determine the best symbolizer to symbolize a network analysis layer. If multiple symbolizers apply to the network analysis layer, the one with the largest numeric value for priority is used to create and update the network analysis laye?U??&

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.

Specified by:

getPriority in interface INASymbolizer

Returns:

The priority

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createLayer

public 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.

Specified by:

createLayer in interface INASymbolizer

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

public 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.

Specified by:

updateLayer in interface INASymbolizer

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.

resetRenderers

public void resetRenderers(IColor solverColor,
                           INALayer nALayer)
                    throws IOException,
                           AutomationException

Resets the renderers based on the provided solver color.

Remarks

ResetRenderers resets the NALayer's renderers based on a specified seed color. This is useful if you want to clear all changes users have made to the symbology of any of the NALayer's sublayers.

Product Availability

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

Specified by:

resetRenderers in interface INASymbolizer2

Parameters:

solverColor - A reference to a com.esri.arcgis.display.IColor (in)

nALayer - A reference to a com.esri.arcgis.networkanalyst.INALayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.