com.esri.arcgis.carto
Class ProportionalSymbolRenderer

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

All Implemented Interfaces:

IBarrierProperties2, IDataExclusion, IDataExclusion2, IDataNormalization, IExportSupport, IFeatureRenderer, ILegendInfo, IProportionalSymbolRenderer, IRotationRenderer, IRotationRenderer2, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class ProportionalSymbolRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IFeatureRenderer, IProportionalSymbolRenderer, IDataExclusion, IDataExclusion2, ILegendInfo, IPersistStream, IPersist, IRotationRenderer, IRotationRenderer2, IDataNormalization, IBarrierProperties2, IExportSupport, java.io.Externalizable

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

Description 'A proportional symbol renderer, used to draw symbols of varying size for each feature, sized in proportion to a field value.' 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.IProportionalSymbolRenderer

IID, IIDec45bfa6_8efc_11d2_ab21_00c04fa334b3, xxDummy

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

IID, IID3d961d65_fc94_11d1_aaca_00c04fa334b3, xxDummy

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

IID, IID765a9a92_f6fa_4501_a888_a793ad33e023, 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.carto.IRotationRenderer

IID, IID2f2047a6_42bd_11d2_aafd_00c04fa334b3, xxDummy

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

IID, IIDd85e5b0c_68b3_48c8_b8d2_087806273b47, xxDummy

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

IID, IID678d02a5_e3fa_11d3_9f7b_00c04f6bc709, xxDummy

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

IID, IIDe2d07333_5605_4ea6_87bd_7830927452e0, xxDummy

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

IID, IIDf6448010_3cc8_435e_b042_540e9a328f3b, xxDummy

Constructor Summary

ProportionalSymbolRenderer()
Constructs a ProportionalSymbolRenderer using ArcGIS Engine.

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

Method Summary

boolean	canRender(IFeatureClass featClass, IDisplay display) Indicates if the specified feature class can be rendered on the given display.
void	createLegendSymbols() Creates the legend.
void	disconnect() Disconnects the data from the renderer.
void	draw(IFeatureCursor cursor, int drawPhase, IDisplay display, ITrackCancel trackCancel) Draws features from the specified cursor on the given display.
boolean	equals(java.lang.Object o) Compare this object with another
IFillSymbol	getBackgroundSymbol() Background fill symbol used when proportional marker symbols are draw on polygon features.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getExclusionClause() Data exclusion where clause.
java.lang.String	getExclusionDescription() Description for the excluded data.
java.lang.String	getExclusionLabel() Label for the excluded data.
ISymbol	getExclusionSymbol() Symbol used to draw excluded values.
java.lang.String	getField() Value field.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
int	getLegendSymbolCount() Number of symbols displayed in the TOC and legend.
ISymbol	getMinSymbol() Symbol used to draw feature with the normalized minimum data value.
java.lang.String	getNormalizationField() Normalization field.
java.lang.String	getNormalizationFieldAlias() Normalization field alias.
double	getNormalizationTotal() Total of all values (used when normalizing by percent of total).
int	getNormalizationType() Normalization type.
java.lang.String	getNormField() Normalization field.
java.lang.String	getRotationField() Rotation field.
int	getRotationType() Rotation type.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISymbol	getSymbolByFeature(IFeature feature) Symbol used to draw the specified feature.
void	getSymbolRotation3DExpressions(java.lang.String[] pExpressionX, java.lang.String[] pExpressionY, java.lang.String[] pExpressionZ) Gets expressions for rotation about each axis.
int	getSymbolRotation3DFlags() Gets rotation flags composed of enum esriSymbolRotation3DFlags.
void	getSymbolRotation3DFlags2(int[] pFlagX, int[] pFlagY, int[] pFlagZ) Gets one flag for each axis.
void	getSymbolRotation3DRandomRanges(double[] pMinRotationX, double[] pMinRotationY, double[] pMinRotationZ, double[] pMaxRotationX, double[] pMaxRotationY, double[] pMaxRotationZ) Gets rotation range for each axis (for random rotation).
int	getSymbolRotation3DRotationTypeZ() Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).
int	getValueRepresentation() Representation type of the value field.
int	getValueUnit() Units of the value field.
int	getWeight() Weight of the barriers for this layer.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isFlanneryCompensation() Indicates if Flannery Compensation is applied.
boolean	isRenderPhase(int drawPhase) Indicates if renderer uses the specified draw phase.
boolean	isShowExclusionClass() Indicates if the exclusion symbol is used.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
void	load(IStream pstm) load
void	prepareFilter(IFeatureClass fc, IQueryFilter queryFilter) Prepares the query filter for the rendering process.
void	queryBarriers(IDisplay display, IGeometryCollection pBarriers, IEnvelope extent, ITrackCancel trackCancel) List of barriers within the specified extent, or all barriers if no extent given.
void	readExternal(java.io.ObjectInput in)
void	release() Release a ProportionalSymbolRenderer.
void	save(IStream pstm, int fClearDirty) save
void	setBackgroundSymbol(IFillSymbol sym) Background fill symbol used when proportional marker symbols are draw on polygon features.
void	setExclusionClause(java.lang.String clause) Data exclusion where clause.
void	setExclusionDescription(java.lang.String text) Description for the excluded data.
void	setExclusionLabel(java.lang.String label) Label for the excluded data.
void	setExclusionSetByRef(IFeatureIDSet rhs1) An object reference to a temporary drawing exclusion set.
void	setExclusionSymbol(ISymbol symbol) Symbol used to draw excluded values.
void	setExportInfoByRef(IFeatureExportInfoGenerator rhs1) The helper oject to generate export information.
void	setField(java.lang.String field) Value field.
void	setFlanneryCompensation(boolean flag) Indicates if Flannery Compensation is applied.
void	setLegendSymbolCount(int num) Number of symbols displayed in the TOC and legend.
void	setMaxDataValue(double rhs1) Normalized maximum data value.
void	setMinDataValue(double rhs1) Normalized minimum data value.
void	setMinSymbol(ISymbol sym) Symbol used to draw feature with the normalized minimum data value.
void	setNormalizationField(java.lang.String fieldName) Normalization field.
void	setNormalizationFieldAlias(java.lang.String name) Normalization field alias.
void	setNormalizationTotal(double value) Total of all values (used when normalizing by percent of total).
void	setNormalizationType(int type) Normalization type.
void	setNormField(java.lang.String field) Normalization field.
void	setRotationField(java.lang.String fieldName) Rotation field.
void	setRotationType(int type) Rotation type.
void	setShowExclusionClass(boolean show) Indicates if the exclusion symbol is used.
void	setSymbolRotation3DExpressions(java.lang.String expressionX, java.lang.String expressionY, java.lang.String expressionZ) Sets expressions for rotation about each axis.
void	setSymbolRotation3DFlags(int pFlags) Gets rotation flags composed of enum esriSymbolRotation3DFlags.
void	setSymbolRotation3DFlags2(int flagX, int flagY, int flagZ) Sets one flag for each axis.
void	setSymbolRotation3DRandomRanges(double minRotationX, double minRotationY, double minRotationZ, double maxRotationX, double maxRotationY, double maxRotationZ) Sets rotation range for each axis (for random rotation).
void	setSymbolRotation3DRotationTypeZ(int pType) Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setValueRepresentation(int rep) Representation type of the value field.
void	setValueUnit(int unit) Units of the value field.
void	setWeight(int weight) Weight of the barriers for this layer.
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

ProportionalSymbolRenderer

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

Constructs a ProportionalSymbolRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ProportionalSymbolRenderer

public ProportionalSymbolRenderer(java.lang.Object obj)
                           throws java.io.IOException

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

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

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

Specified by:

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

canRender

public boolean canRender(IFeatureClass featClass,
                         IDisplay display)
                  throws java.io.IOException,
                         AutomationException

Indicates if the specified feature class can be rendered on the given display.

Remarks

If the renderer is not applicable to a feature layer, then it can return False in response to a CanRender method. For example, the dot-density renderer is only applicable to polygon feature layers and returns False in response to other feature layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canRender in interface IFeatureRenderer

Parameters:

featClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

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

Returns:

The result

Throws:

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

AutomationException - If the ArcObject component throws an exception.

prepareFilter

public void prepareFilter(IFeatureClass fc,
                          IQueryFilter queryFilter)
                   throws java.io.IOException,
                          AutomationException

Prepares the query filter for the rendering process.

Remarks

This method is called prior to the Draw method and gives the renderer a chance to adjust the query filter to incorporate extra constraints. For example, if a particular field is required for the renderer, it would add this field to the filter to ensure it is accessible during the Draw method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

prepareFilter in interface IFeatureRenderer

Parameters:

fc - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

queryFilter - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IFeatureCursor cursor,
                 int drawPhase,
                 IDisplay display,
                 ITrackCancel trackCancel)
          throws java.io.IOException,
                 AutomationException

Draws features from the specified cursor on the given display.

Remarks

This method is typically called by the framework to renderer features to a display. This could be in response to a refresh on the map. This method typically iterates through all the features and renders each feature with an appropriate symbol.

An individual feature is typically drawn by calling the Draw method on the feature's IFeatureDraw with the symbol created by the renderer. However, when writing a custom feature renderer you can draw anything you want using a number of different methods. To learn more see the section on writing a custom feature renderer in Extending ArcObjects.

To allow complex rendering to be canceled halfway through a draw, the renderer typically checks the TrackCancel object after each feature or set of features. If a cancel action has occurred, the renderer will exit.

There are three drawing phases: selection, annotation, and geography, and this method can be called by the framework up to three times. With the exception of the selection phase, this method will only be called for a particular draw phase if the call by the framework to RenderPhase returns true for that phase.

Feature renderers typically only draw features during the geography phase, though in some cases features are drawn in the annotation phase. Take for example a case where proportional symbols are drawn for polygon features. The ProportionalSymbolRenderer draws the background fill symbol during the geography phase and the proportionally sized marker symbol during the annotation phase.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface IFeatureRenderer

Parameters:

cursor - A reference to a com.esri.arcgis.geodatabase.IFeatureCursor (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.

getSymbolByFeature

public ISymbol getSymbolByFeature(IFeature feature)
                           throws java.io.IOException,
                                  AutomationException

Symbol used to draw the specified feature.

Product Availability

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

Specified by:

getSymbolByFeature in interface IFeatureRenderer

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (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.

isRenderPhase

public boolean isRenderPhase(int drawPhase)
                      throws java.io.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 IFeatureRenderer

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.

setExclusionSetByRef

public void setExclusionSetByRef(IFeatureIDSet rhs1)
                          throws java.io.IOException,
                                 AutomationException

An object reference to a temporary drawing exclusion set.

Description

The list of feature IDs to be excluded from drawing.

Remarks

Some feature renderers support IDataExclusion which allows you to build a where clause to exclude features.

Exclusion prevents features from drawing. To prevent features from drawing as well as from appearing in tables and in query results, set a layer definition query using IFeatureLayerDefinition.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setExclusionSetByRef in interface IFeatureRenderer

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IFeatureIDSet (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

Value field.

Specified by:

getField in interface IProportionalSymbolRenderer

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

Value field.

Specified by:

setField in interface IProportionalSymbolRenderer

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 IProportionalSymbolRenderer

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 IProportionalSymbolRenderer

Parameters:

field - The field (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxDataValue

public void setMaxDataValue(double rhs1)
                     throws java.io.IOException,
                            AutomationException

Normalized maximum data value.

Specified by:

setMaxDataValue in interface IProportionalSymbolRenderer

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinDataValue

public void setMinDataValue(double rhs1)
                     throws java.io.IOException,
                            AutomationException

Normalized minimum data value.

Specified by:

setMinDataValue in interface IProportionalSymbolRenderer

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinSymbol

public ISymbol getMinSymbol()
                     throws java.io.IOException,
                            AutomationException

Symbol used to draw feature with the normalized minimum data value.

Specified by:

getMinSymbol in interface IProportionalSymbolRenderer

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.

setMinSymbol

public void setMinSymbol(ISymbol sym)
                  throws java.io.IOException,
                         AutomationException

Symbol used to draw feature with the normalized minimum data value.

Specified by:

setMinSymbol in interface IProportionalSymbolRenderer

Parameters:

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.

getValueUnit

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

Units of the value field.

Specified by:

getValueUnit in interface IProportionalSymbolRenderer

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValueUnit

public void setValueUnit(int unit)
                  throws java.io.IOException,
                         AutomationException

Units of the value field.

Specified by:

setValueUnit in interface IProportionalSymbolRenderer

Parameters:

unit - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValueRepresentation

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

Representation type of the value field.

Specified by:

getValueRepresentation in interface IProportionalSymbolRenderer

Returns:

A com.esri.arcgis.carto.esriValueRepresentations constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValueRepresentation

public void setValueRepresentation(int rep)
                            throws java.io.IOException,
                                   AutomationException

Representation type of the value field.

Specified by:

setValueRepresentation in interface IProportionalSymbolRenderer

Parameters:

rep - A com.esri.arcgis.carto.esriValueRepresentations constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFlanneryCompensation

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

Indicates if Flannery Compensation is applied.

Specified by:

isFlanneryCompensation in interface IProportionalSymbolRenderer

Returns:

The flag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFlanneryCompensation

public void setFlanneryCompensation(boolean flag)
                             throws java.io.IOException,
                                    AutomationException

Indicates if Flannery Compensation is applied.

Specified by:

setFlanneryCompensation in interface IProportionalSymbolRenderer

Parameters:

flag - The flag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLegendSymbolCount

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

Number of symbols displayed in the TOC and legend.

Specified by:

getLegendSymbolCount in interface IProportionalSymbolRenderer

Returns:

The num

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLegendSymbolCount

public void setLegendSymbolCount(int num)
                          throws java.io.IOException,
                                 AutomationException

Number of symbols displayed in the TOC and legend.

Specified by:

setLegendSymbolCount in interface IProportionalSymbolRenderer

Parameters:

num - The num (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 proportional marker symbols are draw on polygon features.

Specified by:

getBackgroundSymbol in interface IProportionalSymbolRenderer

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 proportional marker symbols are draw on polygon features.

Specified by:

setBackgroundSymbol in interface IProportionalSymbolRenderer

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.

createLegendSymbols

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

Creates the legend. Call after all properties have been set.

Specified by:

createLegendSymbols in interface IProportionalSymbolRenderer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExclusionClause

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

Data exclusion where clause.

Specified by:

getExclusionClause in interface IDataExclusion

Returns:

The clause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionClause

public void setExclusionClause(java.lang.String clause)
                        throws java.io.IOException,
                               AutomationException

Data exclusion where clause.

Specified by:

setExclusionClause in interface IDataExclusion

Parameters:

clause - The clause (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExclusionSymbol

public ISymbol getExclusionSymbol()
                           throws java.io.IOException,
                                  AutomationException

Symbol used to draw excluded values.

Specified by:

getExclusionSymbol in interface IDataExclusion

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.

setExclusionSymbol

public void setExclusionSymbol(ISymbol symbol)
                        throws java.io.IOException,
                               AutomationException

Symbol used to draw excluded values.

Specified by:

setExclusionSymbol in interface IDataExclusion

Parameters:

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.

isShowExclusionClass

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

Indicates if the exclusion symbol is used.

Specified by:

isShowExclusionClass in interface IDataExclusion

Returns:

The show

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowExclusionClass

public void setShowExclusionClass(boolean show)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the exclusion symbol is used.

Specified by:

setShowExclusionClass in interface IDataExclusion

Parameters:

show - The show (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExclusionLabel

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

Label for the excluded data.

Specified by:

getExclusionLabel in interface IDataExclusion

Returns:

The label

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionLabel

public void setExclusionLabel(java.lang.String label)
                       throws java.io.IOException,
                              AutomationException

Label for the excluded data.

Specified by:

setExclusionLabel in interface IDataExclusion

Parameters:

label - The label (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExclusionDescription

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

Description for the excluded data.

Specified by:

getExclusionDescription in interface IDataExclusion

Returns:

The text

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setExclusionDescription

public void setExclusionDescription(java.lang.String text)
                             throws java.io.IOException,
                                    AutomationException

Description for the excluded data.

Specified by:

setExclusionDescription in interface IDataExclusion

Parameters:

text - The text (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

disconnect

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

Disconnects the data from the renderer.

Specified by:

disconnect in interface IDataExclusion2

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.

getRotationField

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

Rotation field.

Specified by:

getRotationField in interface IRotationRenderer

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRotationField

public void setRotationField(java.lang.String fieldName)
                      throws java.io.IOException,
                             AutomationException

Rotation field.

Specified by:

setRotationField in interface IRotationRenderer

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRotationType

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

Rotation type.

Specified by:

getRotationType in interface IRotationRenderer

Returns:

A com.esri.arcgis.carto.esriSymbolRotationType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRotationType

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

Rotation type.

Specified by:

setRotationType in interface IRotationRenderer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DFlags

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

Gets rotation flags composed of enum esriSymbolRotation3DFlags. Not just for 3D rotation.

Specified by:

getSymbolRotation3DFlags in interface IRotationRenderer2

Returns:

The pFlags

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DFlags

public void setSymbolRotation3DFlags(int pFlags)
                              throws java.io.IOException,
                                     AutomationException

Gets rotation flags composed of enum esriSymbolRotation3DFlags. Not just for 3D rotation.

Specified by:

setSymbolRotation3DFlags in interface IRotationRenderer2

Parameters:

pFlags - The pFlags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DFlags2

public void getSymbolRotation3DFlags2(int[] pFlagX,
                                      int[] pFlagY,
                                      int[] pFlagZ)
                               throws java.io.IOException,
                                      AutomationException

Gets one flag for each axis. Serves same purpose as SymbolRotation3DFlags (get_, put_).

Specified by:

getSymbolRotation3DFlags2 in interface IRotationRenderer2

Parameters:

pFlagX - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)

pFlagY - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)

pFlagZ - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DFlags2

public void setSymbolRotation3DFlags2(int flagX,
                                      int flagY,
                                      int flagZ)
                               throws java.io.IOException,
                                      AutomationException

Sets one flag for each axis. For axis which is not to be rotated, set to esriSymbolRotation3DNone. Serves same purpose as SymbolRotation3DFlags (get_, put_).

Specified by:

setSymbolRotation3DFlags2 in interface IRotationRenderer2

Parameters:

flagX - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)

flagY - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)

flagZ - A com.esri.arcgis.carto.esriSymbolRotation3DFlags constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DRotationTypeZ

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

Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).

Specified by:

getSymbolRotation3DRotationTypeZ in interface IRotationRenderer2

Returns:

A com.esri.arcgis.carto.esriSymbolRotationType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DRotationTypeZ

public void setSymbolRotation3DRotationTypeZ(int pType)
                                      throws java.io.IOException,
                                             AutomationException

Gets rotation type (geographic or arithmetic) about the Z axis (hardcoded arithmetic about other axes).

Specified by:

setSymbolRotation3DRotationTypeZ in interface IRotationRenderer2

Parameters:

pType - A com.esri.arcgis.carto.esriSymbolRotationType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DExpressions

public void getSymbolRotation3DExpressions(java.lang.String[] pExpressionX,
                                           java.lang.String[] pExpressionY,
                                           java.lang.String[] pExpressionZ)
                                    throws java.io.IOException,
                                           AutomationException

Gets expressions for rotation about each axis. In case of non-3D rotation, Z axis is used.

Specified by:

getSymbolRotation3DExpressions in interface IRotationRenderer2

Parameters:

pExpressionX - The pExpressionX (out: use single element array)

pExpressionY - The pExpressionY (out: use single element array)

pExpressionZ - The pExpressionZ (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DExpressions

public void setSymbolRotation3DExpressions(java.lang.String expressionX,
                                           java.lang.String expressionY,
                                           java.lang.String expressionZ)
                                    throws java.io.IOException,
                                           AutomationException

Sets expressions for rotation about each axis. In case of non-3D rotation, Z axis is used.

Specified by:

setSymbolRotation3DExpressions in interface IRotationRenderer2

Parameters:

expressionX - The expressionX (in)

expressionY - The expressionY (in)

expressionZ - The expressionZ (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSymbolRotation3DRandomRanges

public void getSymbolRotation3DRandomRanges(double[] pMinRotationX,
                                            double[] pMinRotationY,
                                            double[] pMinRotationZ,
                                            double[] pMaxRotationX,
                                            double[] pMaxRotationY,
                                            double[] pMaxRotationZ)
                                     throws java.io.IOException,
                                            AutomationException

Gets rotation range for each axis (for random rotation).

Specified by:

getSymbolRotation3DRandomRanges in interface IRotationRenderer2

Parameters:

pMinRotationX - The pMinRotationX (out: use single element array)

pMinRotationY - The pMinRotationY (out: use single element array)

pMinRotationZ - The pMinRotationZ (out: use single element array)

pMaxRotationX - The pMaxRotationX (out: use single element array)

pMaxRotationY - The pMaxRotationY (out: use single element array)

pMaxRotationZ - The pMaxRotationZ (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbolRotation3DRandomRanges

public void setSymbolRotation3DRandomRanges(double minRotationX,
                                            double minRotationY,
                                            double minRotationZ,
                                            double maxRotationX,
                                            double maxRotationY,
                                            double maxRotationZ)
                                     throws java.io.IOException,
                                            AutomationException

Sets rotation range for each axis (for random rotation).

Specified by:

setSymbolRotation3DRandomRanges in interface IRotationRenderer2

Parameters:

minRotationX - The minRotationX (in)

minRotationY - The minRotationY (in)

minRotationZ - The minRotationZ (in)

maxRotationX - The maxRotationX (in)

maxRotationY - The maxRotationY (in)

maxRotationZ - The maxRotationZ (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationField

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

Normalization field.

Specified by:

getNormalizationField in interface IDataNormalization

Returns:

The fieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationField

public void setNormalizationField(java.lang.String fieldName)
                           throws java.io.IOException,
                                  AutomationException

Normalization field.

Specified by:

setNormalizationField in interface IDataNormalization

Parameters:

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationFieldAlias

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

Normalization field alias.

Specified by:

getNormalizationFieldAlias in interface IDataNormalization

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationFieldAlias

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

Normalization field alias.

Specified by:

setNormalizationFieldAlias in interface IDataNormalization

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationType

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

Normalization type.

Specified by:

getNormalizationType in interface IDataNormalization

Returns:

A com.esri.arcgis.carto.esriDataNormalization constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationType

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

Normalization type.

Specified by:

setNormalizationType in interface IDataNormalization

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNormalizationTotal

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

Total of all values (used when normalizing by percent of total).

Specified by:

getNormalizationTotal in interface IDataNormalization

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNormalizationTotal

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

Total of all values (used when normalizing by percent of total).

Specified by:

setNormalizationTotal in interface IDataNormalization

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWeight

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

Weight of the barriers for this layer.

Specified by:

getWeight in interface IBarrierProperties2

Returns:

The weight

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setWeight

public void setWeight(int weight)
               throws java.io.IOException,
                      AutomationException

Weight of the barriers for this layer.

Specified by:

setWeight in interface IBarrierProperties2

Parameters:

weight - The weight (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBarriers

public void queryBarriers(IDisplay display,
                          IGeometryCollection pBarriers,
                          IEnvelope extent,
                          ITrackCancel trackCancel)
                   throws java.io.IOException,
                          AutomationException

List of barriers within the specified extent, or all barriers if no extent given.

Specified by:

queryBarriers in interface IBarrierProperties2

Parameters:

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

pBarriers - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)

extent - A reference to a com.esri.arcgis.geometry.IEnvelope (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.

setExportInfoByRef

public void setExportInfoByRef(IFeatureExportInfoGenerator rhs1)
                        throws java.io.IOException,
                               AutomationException

The helper oject to generate export information.

Specified by:

setExportInfoByRef in interface IExportSupport

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IFeatureExportInfoGenerator (in)

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