com.esri.arcgis.carto
Class NetworkTrafficRenderer

java.lang.Object
  com.esri.arcgis.carto.NetworkTrafficRenderer

All Implemented Interfaces:

IClassBreaksRenderer, ILegendInfo, INetworkEdgeRenderer, INetworkEdgeRenderer2, INetworkRenderer, INetworkSourceRenderer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IPropertySupport, Externalizable, Serializable

public class NetworkTrafficRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClassBreaksRenderer, INetworkRenderer, ILegendInfo, IPersistStream, IPropertySupport, INetworkEdgeRenderer, INetworkEdgeRenderer2, INetworkSourceRenderer, Externalizable

A renderer used to display network dataset traffic.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NetworkTrafficRenderer()
Constructs a NetworkTrafficRenderer using ArcGIS Engine.

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

Method Summary

boolean	applies(Object pUnk) Indicates if the receiver can apply the given object at any given time.
Object	apply(Object newObject) Applies the given property to the receiver and returns the old object.
void	bindSources(INetworkDataset pNetworkDataset) Caches the subset of network sources that can be drawn by this renderer.
boolean	canApply(Object pUnk) Indicates if the receiver can apply the given object at that particular moment.
boolean	canRender(INetworkLayer layer, IDisplay display) Indicates if the renderer can draw.
void	draw(INetworkLayer layer, int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the network dataset.
boolean	equals(Object o) Compare this object with another
String	getArrowAttributeName() The name of the restriction attribute used to display edge traversability.
ISymbol	getArrowSymbol(int symbolType) The symbol for the specified arrow symbol type.
int	getArrowType() The position of the arrow used to display edge traversability.
IFillSymbol	getBackgroundSymbol() Background fill symbol used when graduated marker symbols are draw on polygon features.
double	getBreak(int index) Break value at the specified index.
int	getBreakCount() Number of class breaks (equal to the number of classes).
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getCurrent(Object pUnk) The object currently being used.
String	getDescription(int index) Description at the specified index.
String	getField() Classification field.
String	getLabel(int index) Label at the specified index.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
double	getMinimumBreak() Minimum break, i.e.
String	getName() The descriptive name of a renderer.
String	getNormField() Normalization field.
int	getRendererType() The type of the network renderer.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
void	getSourceNames(IStringArray ppSourceNames) The cached subset of network sources that can be drawn by this renderer.
String	getSourceQueryExpression(String sourceName) The query expression used to identify the subset of source features whose elements should be rendered.
ISymbol	getSymbol(int index) Symbol at the specified index (used to draw features in the specified class).
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isRenderPhase(int drawPhase) Indicates if renderer uses the specified draw phase.
boolean	isShowArrows(int symbolType) Indicates if arrows are visible for the specified arrow symbol type.
boolean	isSortClassesAscending() Indicates if classes are displayed in increasing order in legends/TOC.
boolean	isSourceVisible(String sourceName) Indicates if elements of the specified source should be rendered.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isTrafficElementsOnly() Indicates if only traffic features should be included in the subset of source features whose elements should be rendered.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setArrowAttributeName(String name) The name of the restriction attribute used to display edge traversability.
void	setArrowSymbol(int symbolType, ISymbol symbol) The symbol for the specified arrow symbol type.
void	setArrowType(int type) The position of the arrow used to display edge traversability.
void	setBackgroundSymbol(IFillSymbol sym) Background fill symbol used when graduated marker symbols are draw on polygon features.
void	setBreak(int index, double value) Break value at the specified index.
void	setBreakCount(int valueCount) Number of class breaks (equal to the number of classes).
void	setDescription(int index, String text) Description at the specified index.
void	setField(String field) Classification field.
void	setIsSourceVisible(String sourceName, boolean visible) Indicates if elements of the specified source should be rendered.
void	setLabel(int index, String label) Label at the specified index.
void	setMinimumBreak(double value) Minimum break, i.e.
void	setName(String name) The descriptive name of a renderer.
void	setNormField(String field) Normalization field.
void	setRendererType(int type) The type of the network renderer.
void	setShowArrows(int symbolType, boolean show) Indicates if arrows are visible for the specified arrow symbol type.
void	setSortClassesAscending(boolean ascending) Indicates if classes are displayed in increasing order in legends/TOC.
void	setSourceQueryExpression(String sourceName, String expression) The query expression used to identify the subset of source features whose elements should be rendered.
void	setSymbol(int index, ISymbol sym) Symbol at the specified index (used to draw features in the specified class).
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	writeExternal(ObjectOutput out)

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

NetworkTrafficRenderer

public NetworkTrafficRenderer()
                       throws IOException,
                              UnknownHostException

Constructs a NetworkTrafficRenderer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NetworkTrafficRenderer

public NetworkTrafficRenderer(Object obj)
                       throws IOException

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

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

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

getBreakCount

public int getBreakCount()
                  throws IOException,
                         AutomationException

Number of class breaks (equal to the number of classes).

Description

BreakCount is the number of class breaks which is equal to the number of classes in which the features are grouped for symbolization.

Remarks

Increasing this property preserves existing breaks, but decreasing it removes excess break values.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBreakCount in interface IClassBreaksRenderer

Returns:

The valueCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakCount

public void setBreakCount(int valueCount)
                   throws IOException,
                          AutomationException

Number of class breaks (equal to the number of classes).

Description

BreakCount is the number of class breaks (not the number of classes) that will be used to divide the data of classification Field .

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBreakCount in interface IClassBreaksRenderer

Parameters:

valueCount - The valueCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

public String getField()
                throws IOException,
                       AutomationException

Classification field.

Description

Field that contains the values upon which the symbolization is based. This is the Value Field on the user interface.

Remarks

This field must be numeric.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getField in interface IClassBreaksRenderer

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

public void setField(String field)
              throws IOException,
                     AutomationException

Classification field.

Description

Field is the field that contains the values that will be classified.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setField in interface IClassBreaksRenderer

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormField

public String getNormField()
                    throws IOException,
                           AutomationException

Normalization field.

Description

NormField is the field that contains the values that the Field values will be divided by to produce the symbolization.

Remarks

Normalizing, i.e. dividing, by a field is the most common way to normalize data for a ClassBreaksRenderer. In general, mapping of ratios or densities is preferrable to mapping counts and a NormField can be used to generate these types of values. Normalize by an area field to represent a density, or normalize by another field with the same units as the values in Field to produce a rate. For example, to map a rate set Field to a field that stores the count of hispanic persons, and set NormField to a field that stores total persons.

Setting NormField is the same as setting IDataNormalization::NormalizationField and setting IDataNormalization::NormalizationType to esriNormalizeByField. You can use IDataNormalization to do other types of normalization.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNormField in interface IClassBreaksRenderer

Returns:

The field

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormField

public void setNormField(String field)
                  throws IOException,
                         AutomationException

Normalization field.

Description

NormField is the field that contains the values that the classification field will be divided by when the IClassify object generates class breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNormField in interface IClassBreaksRenderer

Parameters:

field - The field (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(int index)
                  throws IOException,
                         AutomationException

Symbol at the specified index (used to draw features in the specified class).

Product Availability

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

Specified by:

getSymbol in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(int index,
                      ISymbol sym)
               throws IOException,
                      AutomationException

Symbol at the specified index (used to draw features in the specified class).

Product Availability

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

Specified by:

setSymbol in interface IClassBreaksRenderer

Parameters:

index - The index (in)

sym - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel(int index)
                throws IOException,
                       AutomationException

Label at the specified index.

Product Availability

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

Specified by:

getLabel in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(int index,
                     String label)
              throws IOException,
                     AutomationException

Label at the specified index.

Product Availability

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

Specified by:

setLabel in interface IClassBreaksRenderer

Parameters:

index - The index (in)

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription(int index)
                      throws IOException,
                             AutomationException

Description at the specified index.

Product Availability

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

Specified by:

getDescription in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(int index,
                           String text)
                    throws IOException,
                           AutomationException

Description at the specified index.

Product Availability

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

Specified by:

setDescription in interface IClassBreaksRenderer

Parameters:

index - The index (in)

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreak

public double getBreak(int index)
                throws IOException,
                       AutomationException

Break value at the specified index. Break(0) is the lowest break and represents the upper bound of the lowest class.

Product Availability

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

Specified by:

getBreak in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreak

public void setBreak(int index,
                     double value)
              throws IOException,
                     AutomationException

Break value at the specified index. Break(0) is the lowest break and represents the upper bound of the lowest class.

Product Availability

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

Specified by:

setBreak in interface IClassBreaksRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumBreak

public double getMinimumBreak()
                       throws IOException,
                              AutomationException

Minimum break, i.e. the lower bound of the first class.

Remarks

Represents the minimum value symbolized by the renderer. Values less than the MinimumBreak will not be drawn by the renderer, thererfore is is common to set this property to the minimum value in the dataset being symbolized.

If you change the data being symbolized, you may need to reset the MinimumBreak if the minimum value in the data is affected.

MinimumBreak does NOT equal Break(0). Break(0) is the highest value in the first class, while MinimumBreak is functionally the lowest value in the first class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumBreak in interface IClassBreaksRenderer

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumBreak

public void setMinimumBreak(double value)
                     throws IOException,
                            AutomationException

Minimum break, i.e. the lower bound of the first class.

Remarks

Commonly the minimum value in the dataset. Does NOT equal Break(0).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumBreak in interface IClassBreaksRenderer

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSortClassesAscending

public boolean isSortClassesAscending()
                               throws IOException,
                                      AutomationException

Indicates if classes are displayed in increasing order in legends/TOC.

Description

Indicates whether or not the classes are sorted by their values in ascending order.

Remarks

Changing this property reverses the Break array, but keeps the Symbol, Label, and Description arrays intact and in the same order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSortClassesAscending in interface IClassBreaksRenderer

Returns:

The ascending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSortClassesAscending

public void setSortClassesAscending(boolean ascending)
                             throws IOException,
                                    AutomationException

Indicates if classes are displayed in increasing order in legends/TOC.

Description

SortClassesAscending is whether the classes are sorted by their values in ascending order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSortClassesAscending in interface IClassBreaksRenderer

Parameters:

ascending - The ascending (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundSymbol

public IFillSymbol getBackgroundSymbol()
                                throws IOException,
                                       AutomationException

Background fill symbol used when graduated marker symbols are draw on polygon features.

Description

BackgroundSymbol is the fill symbol that is used when the layer's features are polygons and the ClassBreaksRenderer is used to draw graduated marker symbols.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBackgroundSymbol in interface IClassBreaksRenderer

Returns:

A reference to a com.esri.arcgis.display.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundSymbol

public void setBackgroundSymbol(IFillSymbol sym)
                         throws IOException,
                                AutomationException

Background fill symbol used when graduated marker symbols are draw on polygon features.

Description

BackgroundSymbol is the Symbol that is used when the layer's features are polygons and the classification is applied to a graduated symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBackgroundSymbol in interface IClassBreaksRenderer

Parameters:

sym - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(INetworkLayer layer,
                 int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the network dataset.

Product Availability

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

Specified by:

draw in interface INetworkRenderer

Parameters:

layer - A reference to a com.esri.arcgis.carto.INetworkLayer (in)

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

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

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(INetworkLayer layer,
                         IDisplay display)
                  throws IOException,
                         AutomationException

Indicates if the renderer can draw.

Product Availability

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

Specified by:

canRender in interface INetworkRenderer

Parameters:

layer - A reference to a com.esri.arcgis.carto.INetworkLayer (in)

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

Returns:

The canRender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The descriptive name of a renderer.

Product Availability

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

Specified by:

getName in interface INetworkRenderer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The descriptive name of a renderer.

Product Availability

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

Specified by:

setName in interface INetworkRenderer

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRenderPhase

public boolean isRenderPhase(int drawPhase)
                      throws IOException,
                             AutomationException

Indicates if renderer uses the specified draw phase.

Product Availability

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

Specified by:

isRenderPhase in interface INetworkRenderer

Parameters:

drawPhase - A com.esri.arcgis.system.esriDrawPhase constant (in)

Returns:

The result

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRendererType

public int getRendererType()
                    throws IOException,
                           AutomationException

The type of the network renderer.

Product Availability

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

Specified by:

getRendererType in interface INetworkRenderer

Returns:

A com.esri.arcgis.carto.esriNetworkRendererType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererType

public void setRendererType(int type)
                     throws IOException,
                            AutomationException

The type of the network renderer.

Product Availability

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

Specified by:

setRendererType in interface INetworkRenderer

Parameters:

type - A com.esri.arcgis.carto.esriNetworkRendererType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException

Number of legend groups contained by the object.

Remarks

The number of legend groups is determined by the implementation of the renderer, consequently this property is read only. For example, SimpleRenderer has one group, while a BiUniqueValueRenderer has any number of groups.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.carto.ILegendGroup

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException

Optional. Defines legend formatting for layer rendered with this object.

Remarks

Layer or renderer legend information is further formatted for display in ArcMap legends. A renderer can override this formatting by returning a LegendItem for this property. ESRI renderers typically do not return anything for this property. With this configuration, legend formatting becomes a user or developer choice on the legend object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

A reference to a com.esri.arcgis.carto.ILegendItem

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

Indicates whether the symbols used for a layer or renderer's legend vary by size.

Remarks

For example the proportional symbol renderer returns True for this property.

You can use this property to distinguish between a layer symbolized with graduated color or graduated symbol type layer symbology. Both of these symbolizations use a ClassBreaksRenderer, but only a graduated symbol symbolization will return True for this property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(Object pUnk)
                throws IOException,
                       AutomationException

Indicates if the receiver can apply the given object at any given time.

Remarks

Applies indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

applies in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The applies

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(Object pUnk)
                 throws IOException,
                        AutomationException

Indicates if the receiver can apply the given object at that particular moment.

Remarks

CanApply indicates whether the specified object can be applied to the current object. For instance, we might want to ask our CircleElement whether a Color object applies to it. If it does, then we can use the Apply method to update our CircleElement with the new Color object.

CanApply differs from Applies in that it is a check for the editability of the object at any given time. Applies indicates whether an object can be applied at all, while CanApply indicates whether an object can be applied at that particular moment.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canApply in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

The canApply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

public Object getCurrent(Object pUnk)
                  throws IOException,
                         AutomationException

The object currently being used.

Product Availability

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

Specified by:

getCurrent in interface IPropertySupport

Parameters:

pUnk - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public Object apply(Object newObject)
             throws IOException,
                    AutomationException

Applies the given property to the receiver and returns the old object.

Remarks

Apply will apply the specified object to the current object. For instance, I might apply a Color object to my RectangleElement. When I execute Apply, the object I replace (the old object) is returned.

Use the Applies and CanApply methods to determine if an Apply can be used on an object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

apply in interface IPropertySupport

Parameters:

newObject - A reference to another Object (IUnknown) (in)

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrowAttributeName

public String getArrowAttributeName()
                             throws IOException,
                                    AutomationException

The name of the restriction attribute used to display edge traversability.

Product Availability

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

Specified by:

getArrowAttributeName in interface INetworkEdgeRenderer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrowAttributeName

public void setArrowAttributeName(String name)
                           throws IOException,
                                  AutomationException

The name of the restriction attribute used to display edge traversability.

Product Availability

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

Specified by:

setArrowAttributeName in interface INetworkEdgeRenderer

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrowType

public void setArrowType(int type)
                  throws IOException,
                         AutomationException

The position of the arrow used to display edge traversability.

Product Availability

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

Specified by:

setArrowType in interface INetworkEdgeRenderer

Parameters:

type - A com.esri.arcgis.carto.esriNetworkArrowType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrowType

public int getArrowType()
                 throws IOException,
                        AutomationException

The position of the arrow used to display edge traversability.

Product Availability

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

Specified by:

getArrowType in interface INetworkEdgeRenderer

Returns:

A com.esri.arcgis.carto.esriNetworkArrowType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrowSymbol

public void setArrowSymbol(int symbolType,
                           ISymbol symbol)
                    throws IOException,
                           AutomationException

The symbol for the specified arrow symbol type.

Product Availability

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

Specified by:

setArrowSymbol in interface INetworkEdgeRenderer

Parameters:

symbolType - A com.esri.arcgis.carto.esriNetworkArrowSymbolType constant (in)

symbol - A reference to a com.esri.arcgis.display.ISymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrowSymbol

public ISymbol getArrowSymbol(int symbolType)
                       throws IOException,
                              AutomationException

The symbol for the specified arrow symbol type.

Product Availability

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

Specified by:

getArrowSymbol in interface INetworkEdgeRenderer

Parameters:

symbolType - A com.esri.arcgis.carto.esriNetworkArrowSymbolType constant (in)

Returns:

A reference to a com.esri.arcgis.display.ISymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowArrows

public void setShowArrows(int symbolType,
                          boolean show)
                   throws IOException,
                          AutomationException

Indicates if arrows are visible for the specified arrow symbol type.

Product Availability

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

Specified by:

setShowArrows in interface INetworkEdgeRenderer2

Parameters:

symbolType - A com.esri.arcgis.carto.esriNetworkArrowSymbolType constant (in)

show - The show (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowArrows

public boolean isShowArrows(int symbolType)
                     throws IOException,
                            AutomationException

Indicates if arrows are visible for the specified arrow symbol type.

Product Availability

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

Specified by:

isShowArrows in interface INetworkEdgeRenderer2

Parameters:

symbolType - A com.esri.arcgis.carto.esriNetworkArrowSymbolType constant (in)

Returns:

The show

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindSources

public void bindSources(INetworkDataset pNetworkDataset)
                 throws IOException,
                        AutomationException

Caches the subset of network sources that can be drawn by this renderer.

Product Availability

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

Specified by:

bindSources in interface INetworkSourceRenderer

Parameters:

pNetworkDataset - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceNames

public void getSourceNames(IStringArray ppSourceNames)
                    throws IOException,
                           AutomationException

The cached subset of network sources that can be drawn by this renderer.

Product Availability

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

Specified by:

getSourceNames in interface INetworkSourceRenderer

Parameters:

ppSourceNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSourceVisible

public boolean isSourceVisible(String sourceName)
                        throws IOException,
                               AutomationException

Indicates if elements of the specified source should be rendered.

Product Availability

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

Specified by:

isSourceVisible in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsSourceVisible

public void setIsSourceVisible(String sourceName,
                               boolean visible)
                        throws IOException,
                               AutomationException

Indicates if elements of the specified source should be rendered.

Product Availability

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

Specified by:

setIsSourceVisible in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceQueryExpression

public String getSourceQueryExpression(String sourceName)
                                throws IOException,
                                       AutomationException

The query expression used to identify the subset of source features whose elements should be rendered.

Product Availability

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

Specified by:

getSourceQueryExpression in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

Returns:

The expression

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceQueryExpression

public void setSourceQueryExpression(String sourceName,
                                     String expression)
                              throws IOException,
                                     AutomationException

The query expression used to identify the subset of source features whose elements should be rendered.

Product Availability

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

Specified by:

setSourceQueryExpression in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

expression - The expression (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTrafficElementsOnly

public boolean isTrafficElementsOnly()
                              throws IOException,
                                     AutomationException

Indicates if only traffic features should be included in the subset of source features whose elements should be rendered.

Product Availability

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

Specified by:

isTrafficElementsOnly in interface INetworkSourceRenderer

Returns:

The trafficElementsOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException