com.esri.arcgis.carto
Class NetworkTrafficRenderer

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

All Implemented Interfaces:

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

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

COM Class 'NetworkTrafficRenderer'. Generated 3/19/2015 1:20:42 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A renderer used to display network dataset traffic.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.carto.INetworkTrafficRenderer

IID, IID9db10a1f_c9a6_473f_9ac7_475dd02baa2e, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IClassBreaksRenderer

IID, IIDae5f7ea1_8b48_11d0_8356_080009b996cc, xxDummy

Fields inherited from interface com.esri.arcgis.carto.INetworkRenderer

IID, IIDc33e3d68_ba60_4a02_856a_eec35f80d77c, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.system.IPropertySupport

IID, IID8a11ad55_2f4f_11d3_9fa0_00c04f6bc6a5, xxDummy

Fields inherited from interface com.esri.arcgis.carto.INetworkEdgeRenderer2

IID, IIDd2622cb5_e2ee_42a3_b0de_fede451f1762, xxDummy

Fields inherited from interface com.esri.arcgis.carto.INetworkEdgeRenderer

IID4bd03700_90bf_4658_8b95_1351ff49027c

Fields inherited from interface com.esri.arcgis.carto.INetworkSourceRenderer

IID, IIDb7d4910a_f568_4bc6_8d42_215b4f14dadc, xxDummy

Constructor Summary

NetworkTrafficRenderer()
Constructs a NetworkTrafficRenderer using ArcGIS Engine.

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

Method Summary

boolean	applies(java.lang.Object pUnk) Indicates if the receiver can apply the given object at any given time.
java.lang.Object	apply(java.lang.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(java.lang.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.
IColor	deriveLineCasingsColor(IColor interiorColor) The exterior line casing color dervived from the interior color.
void	draw(INetworkLayer layer, int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws the network dataset.
boolean	equals(java.lang.Object o) Compare this object with another
java.lang.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 java.lang.String	getClsid() getClsid.
java.lang.Object	getCurrent(java.lang.Object pUnk) The object currently being used.
java.lang.String	getDescription(int index) Description at the specified index.
double	getExteriorLineWidthIncrement() The additional width of the exterior line symbol above the width of the interior line symbol.
java.lang.String	getField() Classification field.
IDoubleArray	getInteriorLineWidthsByHierarchyLevelIndex() The interior line widths by hierarchy level index.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.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.
IColor	getLineCasingsColor() The line casings color.
double	getMinimumBreak() Minimum break, i.e.
java.lang.String	getName() The descriptive name of a renderer.
java.lang.String	getNormField() Normalization field.
int	getRendererType() The type of the network renderer.
IDoubleArray	getScaleFilters() The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
void	getSourceNames(IStringArray ppSourceNames) The cached subset of network sources that can be drawn by this renderer.
java.lang.String	getSourceQueryExpression(java.lang.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	isDrawLineWidthByHierarchyLevelIndex() Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.
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	isShowLiveTrafficOnly() Indicates whether to only show live traffic or otherwise show all traffic.
boolean	isSortClassesAscending() Indicates if classes are displayed in increasing order in legends/TOC.
boolean	isSourceVisible(java.lang.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.
boolean	isUseDerivedLineCasingsColor() Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.
boolean	isUseLineCasings() Indicates whether to use line casings.
boolean	isUseScaleFilters() Indicates whether to use scale ratio filters by hierarchy level.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a NetworkTrafficRenderer.
void	save(IStream pstm, int fClearDirty) save
void	setArrowAttributeName(java.lang.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, java.lang.String text) Description at the specified index.
void	setDrawLineWidthByHierarchyLevelIndex(boolean useHierarchy) Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.
void	setField(java.lang.String field) Classification field.
void	setInteriorLineWidthsByHierarchyLevelIndex(IDoubleArray widths) The interior line widths by hierarchy level index.
void	setIsSourceVisible(java.lang.String sourceName, boolean visible) Indicates if elements of the specified source should be rendered.
void	setLabel(int index, java.lang.String label) Label at the specified index.
void	setLineCasingsColor(IColor exteriorColor) The line casings color.
void	setMinimumBreak(double value) Minimum break, i.e.
void	setName(java.lang.String name) The descriptive name of a renderer.
void	setNormField(java.lang.String field) Normalization field.
void	setRendererType(int type) The type of the network renderer.
void	setScaleFilters(IDoubleArray scaleRatios) The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.
void	setShowArrows(int symbolType, boolean show) Indicates if arrows are visible for the specified arrow symbol type.
void	setShowLiveTrafficOnly(boolean liveTrafficOnly) Indicates whether to only show live traffic or otherwise show all traffic.
void	setSortClassesAscending(boolean ascending) Indicates if classes are displayed in increasing order in legends/TOC.
void	setSourceQueryExpression(java.lang.String sourceName, java.lang.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	setUseDerivedLineCasingsColor(boolean useDerivedLineCasingsColor) Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.
void	setUseLineCasings(boolean useLineCasings) Indicates whether to use line casings.
void	setUseScaleFilters(boolean useScaleFilters) Indicates whether to use scale ratio filters by hierarchy level.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

NetworkTrafficRenderer

public NetworkTrafficRenderer()
                       throws java.io.IOException,
                              java.net.UnknownHostException

Constructs a NetworkTrafficRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NetworkTrafficRenderer

public NetworkTrafficRenderer(java.lang.Object obj)
                       throws java.io.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:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a NetworkTrafficRenderer.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

isShowLiveTrafficOnly

public boolean isShowLiveTrafficOnly()
                              throws java.io.IOException,
                                     AutomationException

Indicates whether to only show live traffic or otherwise show all traffic.

Specified by:

isShowLiveTrafficOnly in interface INetworkTrafficRenderer

Returns:

The liveTrafficOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowLiveTrafficOnly

public void setShowLiveTrafficOnly(boolean liveTrafficOnly)
                            throws java.io.IOException,
                                   AutomationException

Indicates whether to only show live traffic or otherwise show all traffic.

Specified by:

setShowLiveTrafficOnly in interface INetworkTrafficRenderer

Parameters:

liveTrafficOnly - The liveTrafficOnly (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseScaleFilters

public boolean isUseScaleFilters()
                          throws java.io.IOException,
                                 AutomationException

Indicates whether to use scale ratio filters by hierarchy level.

Specified by:

isUseScaleFilters in interface INetworkTrafficRenderer

Returns:

The useScaleFilters

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseScaleFilters

public void setUseScaleFilters(boolean useScaleFilters)
                        throws java.io.IOException,
                               AutomationException

Indicates whether to use scale ratio filters by hierarchy level.

Specified by:

setUseScaleFilters in interface INetworkTrafficRenderer

Parameters:

useScaleFilters - The useScaleFilters (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getScaleFilters

public IDoubleArray getScaleFilters()
                             throws java.io.IOException,
                                    AutomationException

The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.

Specified by:

getScaleFilters in interface INetworkTrafficRenderer

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setScaleFilters

public void setScaleFilters(IDoubleArray scaleRatios)
                     throws java.io.IOException,
                            AutomationException

The maximum scale ratios for drawing hierarchy value 1 and also each hierarchy level max value.

Specified by:

setScaleFilters in interface INetworkTrafficRenderer

Parameters:

scaleRatios - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDrawLineWidthByHierarchyLevelIndex

public boolean isDrawLineWidthByHierarchyLevelIndex()
                                             throws java.io.IOException,
                                                    AutomationException

Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.

Specified by:

isDrawLineWidthByHierarchyLevelIndex in interface INetworkTrafficRenderer

Returns:

The useHierarchy

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDrawLineWidthByHierarchyLevelIndex

public void setDrawLineWidthByHierarchyLevelIndex(boolean useHierarchy)
                                           throws java.io.IOException,
                                                  AutomationException

Indicates whether to get interior line width by hierarchy level or instead use the interior line width of the legend symbols.

Specified by:

setDrawLineWidthByHierarchyLevelIndex in interface INetworkTrafficRenderer

Parameters:

useHierarchy - The useHierarchy (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInteriorLineWidthsByHierarchyLevelIndex

public IDoubleArray getInteriorLineWidthsByHierarchyLevelIndex()
                                                        throws java.io.IOException,
                                                               AutomationException

The interior line widths by hierarchy level index.

Specified by:

getInteriorLineWidthsByHierarchyLevelIndex in interface INetworkTrafficRenderer

Returns:

A reference to a com.esri.arcgis.system.IDoubleArray

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInteriorLineWidthsByHierarchyLevelIndex

public void setInteriorLineWidthsByHierarchyLevelIndex(IDoubleArray widths)
                                                throws java.io.IOException,
                                                       AutomationException

The interior line widths by hierarchy level index.

Specified by:

setInteriorLineWidthsByHierarchyLevelIndex in interface INetworkTrafficRenderer

Parameters:

widths - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExteriorLineWidthIncrement

public double getExteriorLineWidthIncrement()
                                     throws java.io.IOException,
                                            AutomationException

The additional width of the exterior line symbol above the width of the interior line symbol.

Specified by:

getExteriorLineWidthIncrement in interface INetworkTrafficRenderer

Returns:

The increment

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseLineCasings

public boolean isUseLineCasings()
                         throws java.io.IOException,
                                AutomationException

Indicates whether to use line casings.

Specified by:

isUseLineCasings in interface INetworkTrafficRenderer

Returns:

The useLineCasings

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseLineCasings

public void setUseLineCasings(boolean useLineCasings)
                       throws java.io.IOException,
                              AutomationException

Indicates whether to use line casings.

Specified by:

setUseLineCasings in interface INetworkTrafficRenderer

Parameters:

useLineCasings - The useLineCasings (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseDerivedLineCasingsColor

public boolean isUseDerivedLineCasingsColor()
                                     throws java.io.IOException,
                                            AutomationException

Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.

Specified by:

isUseDerivedLineCasingsColor in interface INetworkTrafficRenderer

Returns:

The useDerivedLineCasingsColor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseDerivedLineCasingsColor

public void setUseDerivedLineCasingsColor(boolean useDerivedLineCasingsColor)
                                   throws java.io.IOException,
                                          AutomationException

Indicates whether to derive the line casings colors from the interior color of the legend line symbols or otherwise use the line casings color.

Specified by:

setUseDerivedLineCasingsColor in interface INetworkTrafficRenderer

Parameters:

useDerivedLineCasingsColor - The useDerivedLineCasingsColor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deriveLineCasingsColor

public IColor deriveLineCasingsColor(IColor interiorColor)
                              throws java.io.IOException,
                                     AutomationException

The exterior line casing color dervived from the interior color.

Specified by:

deriveLineCasingsColor in interface INetworkTrafficRenderer

Parameters:

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

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLineCasingsColor

public IColor getLineCasingsColor()
                           throws java.io.IOException,
                                  AutomationException

The line casings color.

Specified by:

getLineCasingsColor in interface INetworkTrafficRenderer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLineCasingsColor

public void setLineCasingsColor(IColor exteriorColor)
                         throws java.io.IOException,
                                AutomationException

The line casings color.

Specified by:

setLineCasingsColor in interface INetworkTrafficRenderer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreakCount

public int getBreakCount()
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

getBreakCount in interface IClassBreaksRenderer

Returns:

The valueCount

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakCount

public void setBreakCount(int valueCount)
                   throws java.io.IOException,
                          AutomationException

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

Specified by:

setBreakCount in interface IClassBreaksRenderer

Parameters:

valueCount - The valueCount (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getField

public java.lang.String getField()
                          throws java.io.IOException,
                                 AutomationException

Classification field.

Specified by:

getField in interface IClassBreaksRenderer

Returns:

The field

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setField

public void setField(java.lang.String field)
              throws java.io.IOException,
                     AutomationException

Classification field.

Specified by:

setField in interface IClassBreaksRenderer

Parameters:

field - The field (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNormField

public java.lang.String getNormField()
                              throws java.io.IOException,
                                     AutomationException

Normalization field.

Specified by:

getNormField in interface IClassBreaksRenderer

Returns:

The field

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNormField

public void setNormField(java.lang.String field)
                  throws java.io.IOException,
                         AutomationException

Normalization field.

Specified by:

setNormField in interface IClassBreaksRenderer

Parameters:

field - The field (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(int index)
                  throws java.io.IOException,
                         AutomationException

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

Specified by:

getSymbol in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

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

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

Specified by:

setSymbol in interface IClassBreaksRenderer

Parameters:

index - The index (in)

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public java.lang.String getLabel(int index)
                          throws java.io.IOException,
                                 AutomationException

Label at the specified index.

Specified by:

getLabel in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

The label

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

public void setLabel(int index,
                     java.lang.String label)
              throws java.io.IOException,
                     AutomationException

Label at the specified index.

Specified by:

setLabel in interface IClassBreaksRenderer

Parameters:

index - The index (in)

label - The label (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription(int index)
                                throws java.io.IOException,
                                       AutomationException

Description at the specified index.

Specified by:

getDescription in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

The text

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(int index,
                           java.lang.String text)
                    throws java.io.IOException,
                           AutomationException

Description at the specified index.

Specified by:

setDescription in interface IClassBreaksRenderer

Parameters:

index - The index (in)

text - The text (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreak

public double getBreak(int index)
                throws java.io.IOException,
                       AutomationException

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

Specified by:

getBreak in interface IClassBreaksRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreak

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

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

Specified by:

setBreak in interface IClassBreaksRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumBreak

public double getMinimumBreak()
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

getMinimumBreak in interface IClassBreaksRenderer

Returns:

The value

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumBreak

public void setMinimumBreak(double value)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

setMinimumBreak in interface IClassBreaksRenderer

Parameters:

value - The value (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSortClassesAscending

public boolean isSortClassesAscending()
                               throws java.io.IOException,
                                      AutomationException

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

Specified by:

isSortClassesAscending in interface IClassBreaksRenderer

Returns:

The ascending

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSortClassesAscending

public void setSortClassesAscending(boolean ascending)
                             throws java.io.IOException,
                                    AutomationException

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

Specified by:

setSortClassesAscending in interface IClassBreaksRenderer

Parameters:

ascending - The ascending (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackgroundSymbol

public IFillSymbol getBackgroundSymbol()
                                throws java.io.IOException,
                                       AutomationException

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

Specified by:

getBackgroundSymbol in interface IClassBreaksRenderer

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundSymbol

public void setBackgroundSymbol(IFillSymbol sym)
                         throws java.io.IOException,
                                AutomationException

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

Specified by:

setBackgroundSymbol in interface IClassBreaksRenderer

Parameters:

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

Throws:

java.io.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 java.io.IOException,
                 AutomationException

Draws the network dataset.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRender

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

Indicates if the renderer can draw.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The descriptive name of a renderer.

Specified by:

getName in interface INetworkRenderer

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

The descriptive name of a renderer.

Specified by:

setName in interface INetworkRenderer

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRenderPhase

public boolean isRenderPhase(int drawPhase)
                      throws java.io.IOException,
                             AutomationException

Indicates if renderer uses the specified draw phase.

Specified by:

isRenderPhase in interface INetworkRenderer

Parameters:

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

Returns:

The result

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRendererType

public int getRendererType()
                    throws java.io.IOException,
                           AutomationException

The type of the network renderer.

Specified by:

getRendererType in interface INetworkRenderer

Returns:

A com.esri.arcgis.carto.esriNetworkRendererType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRendererType

public void setRendererType(int type)
                     throws java.io.IOException,
                            AutomationException

The type of the network renderer.

Specified by:

setRendererType in interface INetworkRenderer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws java.io.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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

applies

public boolean applies(java.lang.Object pUnk)
                throws java.io.IOException,
                       AutomationException

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

Specified by:

applies in interface IPropertySupport

Parameters:

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

Returns:

The applies

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(java.lang.Object pUnk)
                 throws java.io.IOException,
                        AutomationException

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

Specified by:

canApply in interface IPropertySupport

Parameters:

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

Returns:

The canApply

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrent

public java.lang.Object getCurrent(java.lang.Object pUnk)
                            throws java.io.IOException,
                                   AutomationException

The object currently being used.

Specified by:

getCurrent in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public java.lang.Object apply(java.lang.Object newObject)
                       throws java.io.IOException,
                              AutomationException

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

Specified by:

apply in interface IPropertySupport

Parameters:

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

Returns:

A reference to another Object (IUnknown)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrowAttributeName

public java.lang.String getArrowAttributeName()
                                       throws java.io.IOException,
                                              AutomationException

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

Specified by:

getArrowAttributeName in interface INetworkEdgeRenderer

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrowAttributeName

public void setArrowAttributeName(java.lang.String name)
                           throws java.io.IOException,
                                  AutomationException

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

Specified by:

setArrowAttributeName in interface INetworkEdgeRenderer

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrowType

public void setArrowType(int type)
                  throws java.io.IOException,
                         AutomationException

The position of the arrow used to display edge traversability.

Specified by:

setArrowType in interface INetworkEdgeRenderer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrowType

public int getArrowType()
                 throws java.io.IOException,
                        AutomationException

The position of the arrow used to display edge traversability.

Specified by:

getArrowType in interface INetworkEdgeRenderer

Returns:

A com.esri.arcgis.carto.esriNetworkArrowType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArrowSymbol

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

The symbol for the specified arrow symbol type.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArrowSymbol

public ISymbol getArrowSymbol(int symbolType)
                       throws java.io.IOException,
                              AutomationException

The symbol for the specified arrow symbol type.

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:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowArrows

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

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

Specified by:

setShowArrows in interface INetworkEdgeRenderer2

Parameters:

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

show - The show (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowArrows

public boolean isShowArrows(int symbolType)
                     throws java.io.IOException,
                            AutomationException

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

Specified by:

isShowArrows in interface INetworkEdgeRenderer2

Parameters:

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

Returns:

The show

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bindSources

public void bindSources(INetworkDataset pNetworkDataset)
                 throws java.io.IOException,
                        AutomationException

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

Specified by:

bindSources in interface INetworkSourceRenderer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceNames

public void getSourceNames(IStringArray ppSourceNames)
                    throws java.io.IOException,
                           AutomationException

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

Specified by:

getSourceNames in interface INetworkSourceRenderer

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSourceVisible

public boolean isSourceVisible(java.lang.String sourceName)
                        throws java.io.IOException,
                               AutomationException

Indicates if elements of the specified source should be rendered.

Specified by:

isSourceVisible in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

Returns:

The visible

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIsSourceVisible

public void setIsSourceVisible(java.lang.String sourceName,
                               boolean visible)
                        throws java.io.IOException,
                               AutomationException

Indicates if elements of the specified source should be rendered.

Specified by:

setIsSourceVisible in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

visible - The visible (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceQueryExpression

public java.lang.String getSourceQueryExpression(java.lang.String sourceName)
                                          throws java.io.IOException,
                                                 AutomationException

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

Specified by:

getSourceQueryExpression in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

Returns:

The expression

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceQueryExpression

public void setSourceQueryExpression(java.lang.String sourceName,
                                     java.lang.String expression)
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

setSourceQueryExpression in interface INetworkSourceRenderer

Parameters:

sourceName - The sourceName (in)

expression - The expression (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTrafficElementsOnly

public boolean isTrafficElementsOnly()
                              throws java.io.IOException,
                                     AutomationException

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

Specified by:

isTrafficElementsOnly in interface INetworkSourceRenderer

Returns:

The trafficElementsOnly

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException