com.esri.arcgis.carto
Class ClassBreaksRenderer

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

All Implemented Interfaces:

IBarrierProperties2, IClassBreaksRenderer, IClassBreaksUIProperties, IClassBreaksUIProperties2, IDataExclusion, IDataExclusion2, IDataNormalization, IDataSampling, IExportSupport, IFeatureRenderer, IFeatureRendererUpdate, ILegendInfo, ILevelRenderer, ILookupLegendClass, ILookupSymbol, IRendererClasses, IRotationRenderer, IRotationRenderer2, ISizeRenderer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class ClassBreaksRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IClassBreaksRenderer, IFeatureRenderer, IFeatureRendererUpdate, ILevelRenderer, ILegendInfo, IPersistStream, IPersist, IClassBreaksUIProperties, IClassBreaksUIProperties2, IDataSampling, IDataExclusion, IDataExclusion2, IRotationRenderer, IRotationRenderer2, ISizeRenderer, IDataNormalization, IBarrierProperties2, ILookupSymbol, IRendererClasses, IXMLSerialize, IXMLVersionSupport, IExportSupport, ILookupLegendClass, java.io.Externalizable

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

Description 'A renderer that can be used to draw graduated color (choropleth) and graduated symbol maps.' 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.IClassBreaksRenderer

IID, IIDae5f7ea1_8b48_11d0_8356_080009b996cc, xxDummy

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

IID, IID735c4d99_e28d_4ad4_b5b9_a12c1d8319fc, xxDummy

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

IID, IIDdc3d8097_c1ed_11d2_9f21_00c04f6bc709, 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.IClassBreaksUIProperties

IID, IID427788f2_31fe_11d2_aaf0_00c04fa334b3, xxDummy

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

IID, IID9e4f9561_af25_4c61_bf8a_9c5477e4437b, xxDummy

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

IID, IID4eab5690_8f9c_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.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.ISizeRenderer

IID, IID5ba3418a_4ba5_431a_b879_f2539c7be5ff, 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.ILookupSymbol

IID, IID736a377d_a1eb_4ce4_84b9_90f9588374c2, xxDummy

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

IID, IID3f25cc56_cc66_4930_a5fd_bc981601cea6, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

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

IID, IIDf6448010_3cc8_435e_b042_540e9a328f3b, xxDummy

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

IID, IIDbdb4bf86_8691_4f1c_b009_42e39035f40e, xxDummy

Constructor Summary

ClassBreaksRenderer()
Constructs a ClassBreaksRenderer using ArcGIS Engine.

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

Method Summary

boolean	canRender(IFeatureClass featClass, IDisplay display) Indicates if the specified feature class can be rendered on the given display.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
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
java.lang.String	esri_getClass(int index) Class name.
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).
int	getClassCount() Number of classes.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.String	getColorRamp() File and path name of the color ramp.
java.lang.String	getDescription(int index) Description at the specified index.
double	getDeviationInterval() Deviation interval (0-1), where 0 means that no deviation is used.
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() Classification field.
java.lang.String	getField(int index) Field at the specified index.
int	getFieldCount() Number of fields.
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.
java.lang.Object	getLevelArray() Array that contains all levels used by the symbols, (symbols without a level get a level of 0).
double	getLowBreak(int index) Lower bound of the class at the specified index.
int	getMaxSampleSize() Maximum sample size.
IUID	getMethod() Classification method.
double	getMinimumBreak() Minimum break, i.e.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
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.
INumberFormat	getNumberFormat() Number format for class labels.
java.lang.String	getRotationField() Rotation field.
int	getRotationType() Rotation type.
int	getSamplingMethod() Data sampling method.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.String	getSizeRendererExpression() Gets size expression.
int	getSizeRendererFlags() Gets sizing flags composed of enum esriSizeRendererFlags.
void	getSizeRendererRandomRange(double[] pMinSize, double[] pMaxSize) Gets size range for random sizing.
ISymbol	getSymbol(int index) Symbol at the specified index (used to draw features in the specified class).
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	getWeight() Weight of the barriers for this layer.
java.lang.String	getWhereClause(int index, ITable table) WhereClause.
int	hashCode() the hashcode for this object
IColorRamp	IClassBreaksUIProperties2_getColorRamp() Color Ramp Object.
void	isDirty() isDirty
boolean	isFlipSymbols() Indicates if symbols are flipped.
boolean	isRenderPhase(int drawPhase) Indicates if renderer uses the specified draw phase.
boolean	isShowClassGaps() Indicates if each lower bound is adjusted up to the nearest existing data value.
boolean	isShowExclusionClass() Indicates if the exclusion symbol is used.
boolean	isSortClassesAscending() Indicates if classes are displayed in increasing order in legends/TOC.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
void	load(IStream pstm) load
int	lookupLegendClass(IFeature feature, int[] legendGroupIdx) Returns the legend group and the legend class indexes for the input feature.
ISymbol	lookupSymbol(boolean firstPass, IFeature feature) Returns a reference to the renderer's symbol for the input feature.
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 ClassBreaksRenderer.
void	resetLookupSymbol(ISymbol symbol) Resets temporary options on the symbol (e.g.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
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	setColorRamp(java.lang.String colorRamp) File and path name of the color ramp.
void	setColorRampByRef(IColorRamp ppColorRamp) Color Ramp Object.
void	setCurrentDrawLevel(int rhs1) The current draw level, (set to -1 to draw all levels).
void	setDescription(int index, java.lang.String text) Description at the specified index.
void	setDeviationInterval(double interval) Deviation interval (0-1), where 0 means that no deviation is used.
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) Classification field.
void	setFlipSymbols(boolean ascending) Indicates if symbols are flipped.
void	setLabel(int index, java.lang.String label) Label at the specified index.
void	setLowBreak(int index, double value) Lower bound of the class at the specified index.
void	setMaxSampleSize(int size) Maximum sample size.
void	setMethodByRef(IUID cLSID) Classification method.
void	setMinimumBreak(double value) Minimum break, i.e.
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	setNumberFormatByRef(INumberFormat format) Number format for class labels.
void	setRotationField(java.lang.String fieldName) Rotation field.
void	setRotationType(int type) Rotation type.
void	setSamplingMethod(int method) Data sampling method.
void	setShowClassGaps(boolean showGaps) Indicates if each lower bound is adjusted up to the nearest existing data value.
void	setShowExclusionClass(boolean show) Indicates if the exclusion symbol is used.
void	setSizeRendererExpression(java.lang.String pExpression) Gets size expression.
void	setSizeRendererFlags(int pFlags) Gets sizing flags composed of enum esriSizeRendererFlags.
void	setSizeRendererRandomRange(double minSize, double maxSize) Sets size range for random sizing.
void	setSortClassesAscending(boolean ascending) Indicates if classes are displayed in increasing order in legends/TOC.
void	setSymbol(int index, ISymbol sym) Symbol at the specified index (used to draw features in the specified class).
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	setWeight(int weight) Weight of the barriers for this layer.
void	update(IFeatureLayer pFeatureLayer) update
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

ClassBreaksRenderer

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

Constructs a ClassBreaksRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ClassBreaksRenderer

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

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

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

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

Specified by:

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

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.

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.

update

public void update(IFeatureLayer pFeatureLayer)
            throws java.io.IOException,
                   AutomationException

update

Specified by:

update in interface IFeatureRendererUpdate

Parameters:

pFeatureLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentDrawLevel

public void setCurrentDrawLevel(int rhs1)
                         throws java.io.IOException,
                                AutomationException

The current draw level, (set to -1 to draw all levels).

Specified by:

setCurrentDrawLevel in interface ILevelRenderer

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLevelArray

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

Array that contains all levels used by the symbols, (symbols without a level get a level of 0).

Specified by:

getLevelArray in interface ILevelRenderer

Returns:

A Variant

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.

getLowBreak

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

Lower bound of the class at the specified index.

Specified by:

getLowBreak in interface IClassBreaksUIProperties

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.

setLowBreak

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

Lower bound of the class at the specified index.

Specified by:

setLowBreak in interface IClassBreaksUIProperties

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.

getColorRamp

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

File and path name of the color ramp.

Specified by:

getColorRamp in interface IClassBreaksUIProperties

Returns:

The colorRamp

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorRamp

public void setColorRamp(java.lang.String colorRamp)
                  throws java.io.IOException,
                         AutomationException

File and path name of the color ramp.

Specified by:

setColorRamp in interface IClassBreaksUIProperties

Parameters:

colorRamp - The colorRamp (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMethod

public IUID getMethod()
               throws java.io.IOException,
                      AutomationException

Classification method.

Specified by:

getMethod in interface IClassBreaksUIProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMethodByRef

public void setMethodByRef(IUID cLSID)
                    throws java.io.IOException,
                           AutomationException

Classification method.

Specified by:

setMethodByRef in interface IClassBreaksUIProperties

Parameters:

cLSID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws java.io.IOException,
                                     AutomationException

Number format for class labels.

Specified by:

getNumberFormat in interface IClassBreaksUIProperties

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberFormatByRef

public void setNumberFormatByRef(INumberFormat format)
                          throws java.io.IOException,
                                 AutomationException

Number format for class labels.

Specified by:

setNumberFormatByRef in interface IClassBreaksUIProperties

Parameters:

format - A reference to a com.esri.arcgis.system.INumberFormat (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isShowClassGaps

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

Indicates if each lower bound is adjusted up to the nearest existing data value.

Specified by:

isShowClassGaps in interface IClassBreaksUIProperties

Returns:

The showGaps

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setShowClassGaps

public void setShowClassGaps(boolean showGaps)
                      throws java.io.IOException,
                             AutomationException

Indicates if each lower bound is adjusted up to the nearest existing data value.

Specified by:

setShowClassGaps in interface IClassBreaksUIProperties

Parameters:

showGaps - The showGaps (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDeviationInterval

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

Deviation interval (0-1), where 0 means that no deviation is used.

Specified by:

getDeviationInterval in interface IClassBreaksUIProperties

Returns:

The interval

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDeviationInterval

public void setDeviationInterval(double interval)
                          throws java.io.IOException,
                                 AutomationException

Deviation interval (0-1), where 0 means that no deviation is used.

Specified by:

setDeviationInterval in interface IClassBreaksUIProperties

Parameters:

interval - The interval (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IClassBreaksUIProperties2_getColorRamp

public IColorRamp IClassBreaksUIProperties2_getColorRamp()
                                                  throws java.io.IOException,
                                                         AutomationException

Color Ramp Object.

Specified by:

IClassBreaksUIProperties2_getColorRamp in interface IClassBreaksUIProperties2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorRampByRef

public void setColorRampByRef(IColorRamp ppColorRamp)
                       throws java.io.IOException,
                              AutomationException

Color Ramp Object.

Specified by:

setColorRampByRef in interface IClassBreaksUIProperties2

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFlipSymbols

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

Indicates if symbols are flipped.

Specified by:

isFlipSymbols in interface IClassBreaksUIProperties2

Returns:

The ascending

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFlipSymbols

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

Indicates if symbols are flipped.

Specified by:

setFlipSymbols in interface IClassBreaksUIProperties2

Parameters:

ascending - The ascending (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxSampleSize

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

Maximum sample size.

Specified by:

getMaxSampleSize in interface IDataSampling

Returns:

The size

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxSampleSize

public void setMaxSampleSize(int size)
                      throws java.io.IOException,
                             AutomationException

Maximum sample size.

Specified by:

setMaxSampleSize in interface IDataSampling

Parameters:

size - The size (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSamplingMethod

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

Data sampling method.

Specified by:

getSamplingMethod in interface IDataSampling

Returns:

A com.esri.arcgis.carto.esriDataSampling constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSamplingMethod

public void setSamplingMethod(int method)
                       throws java.io.IOException,
                              AutomationException

Data sampling method.

Specified by:

setSamplingMethod in interface IDataSampling

Parameters:

method - A com.esri.arcgis.carto.esriDataSampling constant (in)

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.

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.

getSizeRendererFlags

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

Gets sizing flags composed of enum esriSizeRendererFlags.

Specified by:

getSizeRendererFlags in interface ISizeRenderer

Returns:

The pFlags

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSizeRendererFlags

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

Gets sizing flags composed of enum esriSizeRendererFlags.

Specified by:

setSizeRendererFlags in interface ISizeRenderer

Parameters:

pFlags - The pFlags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeRendererExpression

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

Gets size expression.

Specified by:

getSizeRendererExpression in interface ISizeRenderer

Returns:

The pExpression

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSizeRendererExpression

public void setSizeRendererExpression(java.lang.String pExpression)
                               throws java.io.IOException,
                                      AutomationException

Gets size expression.

Specified by:

setSizeRendererExpression in interface ISizeRenderer

Parameters:

pExpression - The pExpression (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeRendererRandomRange

public void getSizeRendererRandomRange(double[] pMinSize,
                                       double[] pMaxSize)
                                throws java.io.IOException,
                                       AutomationException

Gets size range for random sizing.

Specified by:

getSizeRendererRandomRange in interface ISizeRenderer

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSizeRendererRandomRange

public void setSizeRendererRandomRange(double minSize,
                                       double maxSize)
                                throws java.io.IOException,
                                       AutomationException

Sets size range for random sizing.

Specified by:

setSizeRendererRandomRange in interface ISizeRenderer

Parameters:

minSize - The minSize (in)

maxSize - The maxSize (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.

lookupSymbol

public ISymbol lookupSymbol(boolean firstPass,
                            IFeature feature)
                     throws java.io.IOException,
                            AutomationException

Returns a reference to the renderer's symbol for the input feature.

Specified by:

lookupSymbol in interface ILookupSymbol

Parameters:

firstPass - The firstPass (in)

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.

resetLookupSymbol

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

Resets temporary options on the symbol (e.g. Rotation).

Specified by:

resetLookupSymbol in interface ILookupSymbol

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.

getClassCount

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

Number of classes.

Specified by:

getClassCount in interface IRendererClasses

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

esri_getClass

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

Class name.

Specified by:

esri_getClass in interface IRendererClasses

Parameters:

index - The index (in)

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause(int index,
                                       ITable table)
                                throws java.io.IOException,
                                       AutomationException

WhereClause.

Specified by:

getWhereClause in interface IRendererClasses

Parameters:

index - The index (in)

table - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Returns:

The whereClause

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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.

lookupLegendClass

public int lookupLegendClass(IFeature feature,
                             int[] legendGroupIdx)
                      throws java.io.IOException,
                             AutomationException

Returns the legend group and the legend class indexes for the input feature.

Specified by:

lookupLegendClass in interface ILookupLegendClass

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

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

Returns:

The legendClassIdx

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFieldCount

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

Number of fields.

Specified by:

getFieldCount in interface ILookupLegendClass

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getField

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

Field at the specified index.

Specified by:

getField in interface ILookupLegendClass

Parameters:

index - The index (in)

Returns:

The name

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