com.esri.arcgis.carto
Class TinAspectRenderer

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

All Implemented Interfaces:

IClassBreaksUIProperties, IDataSampling, ILegendInfo, ITerrainRenderer, ITinColorRampRenderer, ITinIllumination, ITinRenderer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

public class TinAspectRenderer
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ITinColorRampRenderer, ITinRenderer, ITerrainRenderer, ITinIllumination, ILegendInfo, IPersistStream, IPersist, IClassBreaksUIProperties, IDataSampling, Externalizable

TIN aspect renderer component.

Remarks

This coclass handles Face Aspect with Graduated Color Ramp TIN renderer. Use the four interfaces that it implements to customize the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

TinAspectRenderer()
Constructs a TinAspectRenderer using ArcGIS Engine.

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

Method Summary

boolean	canRender() Indicates if renderer can draw.
void	copy(ITinRenderer pSource) Copies the properties of the given renderer.
void	draw(int drawPhase, IDisplay display, ISpatialReference aSpatialReference, ITrackCancel trackCancel) Draws the TIN.
boolean	equals(Object o) Compare this object with another
double	getBreak(int index) The value of the break at the index.
int	getBreakCount() The number of breaks.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getColorRamp() File and path name of the color ramp.
String	getDescription(int index) The description for the renderer.
double	getDeviationInterval() Deviation interval (0-1), where 0 means that no deviation is used.
String	getLabel(int index) The label for the break at the given index.
ILegendGroup	getLegendGroup(int index) Legend group at the specified index.
int	getLegendGroupCount() Number of legend groups contained by the object.
ILegendItem	getLegendItem() Optional.
double	getLowBreak(int index) Lower bound of the class at the specified index.
int	getMaxSampleSize() Maximum sample size.
IUID	getMethod() Classification method.
double	getMinimumBreak() The value of the minimum break.
String	getName() The descriptive name of a renderer.
INumberFormat	getNumberFormat() Number format for class labels.
int	getSamplingMethod() Data sampling method.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISymbol	getSymbol(int index) The symbol representing the break at the index.
ITerrain	getTerrain() The Terrain associated with the renderer.
ITin	getTin() The TIN associated with the renderer.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
boolean	isIlluminate() Indicates if the shading for TIN triangle faces is illuminated.
boolean	isShowClassGaps() Indicates if each lower bound is adjusted up to the nearest existing data value.
boolean	isSortClassesAscending() Indicates if the sort direction for the legend class labels is ascending.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isVisible() Indicates if the renderer is currently visible.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	setBreak(int index, double value) The value of the break at the index.
void	setBreakCount(int valueCount) The number of breaks.
void	setColorRamp(String colorRamp) File and path name of the color ramp.
void	setDescription(int index, String text) The description for the renderer.
void	setDeviationInterval(double interval) Deviation interval (0-1), where 0 means that no deviation is used.
void	setIlluminate(boolean illuminate) Indicates if the shading for TIN triangle faces is illuminated.
void	setLabel(int index, String label) The label for the break at the given 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) The value of the minimum break.
void	setName(String name) The descriptive name of a renderer.
void	setNumberFormatByRef(INumberFormat format) Number format for class labels.
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	setSortClassesAscending(boolean ascending) Indicates if the sort direction for the legend class labels is ascending.
void	setSymbol(int index, ISymbol sym) The symbol representing the break at the index.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTerrainByRef(ITerrain ppTerrain) The Terrain associated with the renderer.
void	setTinByRef(ITin ppTin) The TIN associated with the renderer.
void	setVisible(boolean visible) Indicates if the renderer is currently visible.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

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

getJintegraDispatch, release

Constructor Detail

TinAspectRenderer

public TinAspectRenderer()
                  throws IOException,
                         UnknownHostException

Constructs a TinAspectRenderer using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

TinAspectRenderer

public TinAspectRenderer(Object obj)
                  throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getBreakCount

public int getBreakCount()
                  throws IOException,
                         AutomationException

The number of breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBreakCount in interface ITinColorRampRenderer

Returns:

The valueCount

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakCount

public void setBreakCount(int valueCount)
                   throws IOException,
                          AutomationException

The number of breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBreakCount in interface ITinColorRampRenderer

Parameters:

valueCount - The valueCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSymbol

public ISymbol getSymbol(int index)
                  throws IOException,
                         AutomationException

The symbol representing the break at the index.

Product Availability

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

Specified by:

getSymbol in interface ITinColorRampRenderer

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbol

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

The symbol representing the break at the index.

Product Availability

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

Specified by:

setSymbol in interface ITinColorRampRenderer

Parameters:

index - The index (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLabel

public String getLabel(int index)
                throws IOException,
                       AutomationException

The label for the break at the given index.

Product Availability

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

Specified by:

getLabel in interface ITinColorRampRenderer

Parameters:

index - The index (in)

Returns:

The label

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLabel

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

The label for the break at the given index.

Product Availability

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

Specified by:

setLabel in interface ITinColorRampRenderer

Parameters:

index - The index (in)

label - The label (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription(int index)
                      throws IOException,
                             AutomationException

The description for the renderer.

Product Availability

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

Specified by:

getDescription in interface ITinColorRampRenderer

Parameters:

index - The index (in)

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

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

The description for the renderer.

Product Availability

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

Specified by:

setDescription in interface ITinColorRampRenderer

Parameters:

index - The index (in)

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBreak

public double getBreak(int index)
                throws IOException,
                       AutomationException

The value of the break at the index.

Product Availability

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

Specified by:

getBreak in interface ITinColorRampRenderer

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreak

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

The value of the break at the index.

Product Availability

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

Specified by:

setBreak in interface ITinColorRampRenderer

Parameters:

index - The index (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinimumBreak

public double getMinimumBreak()
                       throws IOException,
                              AutomationException

The value of the minimum break.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMinimumBreak in interface ITinColorRampRenderer

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinimumBreak

public void setMinimumBreak(double value)
                     throws IOException,
                            AutomationException

The value of the minimum break.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMinimumBreak in interface ITinColorRampRenderer

Parameters:

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSortClassesAscending

public boolean isSortClassesAscending()
                               throws IOException,
                                      AutomationException

Indicates if the sort direction for the legend class labels is ascending.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSortClassesAscending in interface ITinColorRampRenderer

Returns:

The ascending

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSortClassesAscending

public void setSortClassesAscending(boolean ascending)
                             throws IOException,
                                    AutomationException

Indicates if the sort direction for the legend class labels is ascending.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSortClassesAscending in interface ITinColorRampRenderer

Parameters:

ascending - The ascending (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(int drawPhase,
                 IDisplay display,
                 ISpatialReference aSpatialReference,
                 ITrackCancel trackCancel)
          throws IOException,
                 AutomationException

Draws the TIN.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

draw in interface ITinRenderer

Parameters:

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

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

aSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(ITinRenderer pSource)
          throws IOException,
                 AutomationException

Copies the properties of the given renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface ITinRenderer

Parameters:

pSource - A reference to a com.esri.arcgis.carto.ITinRenderer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender()
                  throws IOException,
                         AutomationException

Indicates if renderer can draw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

canRender in interface ITinRenderer

Returns:

The pCanRender

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTinByRef

public void setTinByRef(ITin ppTin)
                 throws IOException,
                        AutomationException

The TIN associated with the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setTinByRef in interface ITinRenderer

Parameters:

ppTin - A reference to a com.esri.arcgis.geodatabase.ITin (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTin

public ITin getTin()
            throws IOException,
                   AutomationException

The TIN associated with the renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getTin in interface ITinRenderer

Returns:

A reference to a com.esri.arcgis.geodatabase.ITin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The descriptive name of a renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getName in interface ITinRenderer

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

The descriptive name of a renderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setName in interface ITinRenderer

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isVisible

public boolean isVisible()
                  throws IOException,
                         AutomationException

Indicates if the renderer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isVisible in interface ITinRenderer

Returns:

The visible

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVisible

public void setVisible(boolean visible)
                throws IOException,
                       AutomationException

Indicates if the renderer is currently visible.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setVisible in interface ITinRenderer

Parameters:

visible - The visible (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTerrainByRef

public void setTerrainByRef(ITerrain ppTerrain)
                     throws IOException,
                            AutomationException

The Terrain associated with the renderer.

Product Availability

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

Specified by:

setTerrainByRef in interface ITerrainRenderer

Parameters:

ppTerrain - A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTerrain

public ITerrain getTerrain()
                    throws IOException,
                           AutomationException

The Terrain associated with the renderer.

Product Availability

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

Specified by:

getTerrain in interface ITerrainRenderer

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITerrain

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIlluminate

public boolean isIlluminate()
                     throws IOException,
                            AutomationException

Indicates if the shading for TIN triangle faces is illuminated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIlluminate in interface ITinIllumination

Returns:

The illuminate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIlluminate

public void setIlluminate(boolean illuminate)
                   throws IOException,
                          AutomationException

Indicates if the shading for TIN triangle faces is illuminated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setIlluminate in interface ITinIllumination

Parameters:

illuminate - The illuminate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroupCount

public int getLegendGroupCount()
                        throws IOException,
                               AutomationException

Number of legend groups contained by the object.

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendGroupCount in interface ILegendInfo

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendGroup

public ILegendGroup getLegendGroup(int index)
                            throws IOException,
                                   AutomationException

Legend group at the specified index.

Product Availability

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

Specified by:

getLegendGroup in interface ILegendInfo

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendItem

public ILegendItem getLegendItem()
                          throws IOException,
                                 AutomationException

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

Remarks

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getLegendItem in interface ILegendInfo

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSymbolsAreGraduated

public boolean isSymbolsAreGraduated()
                              throws IOException,
                                     AutomationException

Indicates if symbols are graduated.

Description

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

Remarks

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

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isSymbolsAreGraduated in interface ILegendInfo

Returns:

The symbolsAreGraduated

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSymbolsAreGraduated

public void setSymbolsAreGraduated(boolean symbolsAreGraduated)
                            throws IOException,
                                   AutomationException

Indicates if symbols are graduated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSymbolsAreGraduated in interface ILegendInfo

Parameters:

symbolsAreGraduated - The symbolsAreGraduated (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLowBreak

public double getLowBreak(int index)
                   throws IOException,
                          AutomationException

Lower bound of the class at the specified index.

Product Availability

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

Specified by:

getLowBreak in interface IClassBreaksUIProperties

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLowBreak

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

Lower bound of the class at the specified index.

Product Availability

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

Specified by:

setLowBreak in interface IClassBreaksUIProperties

Parameters:

index - The index (in)

value - The value (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColorRamp

public String getColorRamp()
                    throws IOException,
                           AutomationException

File and path name of the color ramp.

Description

ColorRamp is the name of the color ramp that is used to display the data. If that color ramp does not exist in the currently referenced styles, then use "Custom", this way something will appear in the user interface (versus a blank line, which can be confusing).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColorRamp in interface IClassBreaksUIProperties

Returns:

The colorRamp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColorRamp

public void setColorRamp(String colorRamp)
                  throws IOException,
                         AutomationException

File and path name of the color ramp.

Description

ColorRamp is the name of the color ramp that is used to display the data. If that color ramp does not exist in the currently referenced styles, then use "Custom", this way something will appear in the user interface (versus a blank line, which can be confusing).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColorRamp in interface IClassBreaksUIProperties

Parameters:

colorRamp - The colorRamp (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMethod

public IUID getMethod()
               throws IOException,
                      AutomationException

Classification method.

Description

Method is the classification method used to create the class breaks. Use IClassify.MethodName to set this value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMethod in interface IClassBreaksUIProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMethodByRef

public void setMethodByRef(IUID clsid)
                    throws IOException,
                           AutomationException

Classification method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMethodByRef in interface IClassBreaksUIProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNumberFormat

public INumberFormat getNumberFormat()
                              throws IOException,
                                     AutomationException

Number format for class labels.

Description

NumberFormat is the INumberFormat that defines how the labels of the classification appear.

Remarks

This property affects the formatting of the class labels on the layer properties dialog's symbology tab.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getNumberFormat in interface IClassBreaksUIProperties

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ILatLonFormat2, CustomNumberFormat, IRateFormat, IAngleFormat, NumericFormat, LatLonFormat, CurrencyFormat, INumericFormat, IFractionFormat, RateFormat, IScientificNumberFormat, ICustomNumberFormat, ILatLonFormat, IPercentageFormat, INumberFormat, ScientificFormat, FractionFormat, PercentageFormat, AngleFormat

setNumberFormatByRef

public void setNumberFormatByRef(INumberFormat format)
                          throws IOException,
                                 AutomationException

Number format for class labels.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setNumberFormatByRef in interface IClassBreaksUIProperties

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isShowClassGaps

public boolean isShowClassGaps()
                        throws IOException,
                               AutomationException

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

Description

This value indicates whether or not the minimum values of the classes are displayed on the layer properties dialog's symbology tab using actual data values. If False, then the values are displayed based on the precision specified in the NumberFormat property.

The framework sets this value internally. You cannot set this value.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isShowClassGaps in interface IClassBreaksUIProperties

Returns:

The showGaps

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShowClassGaps

public void setShowClassGaps(boolean showGaps)
                      throws IOException,
                             AutomationException

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

Description

ShowClassGaps is whether the minimum and maximum values of the class are displayed using actual data values. If false, then the minimum and maximum values are displayed based on the precision specified in the NumberFormat property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setShowClassGaps in interface IClassBreaksUIProperties

Parameters:

showGaps - The showGaps (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDeviationInterval

public double getDeviationInterval()
                            throws IOException,
                                   AutomationException

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

Description

DeviationInterval is the percentage of one standard deviation to be used as the interval of the class breaks. Range is 0 to 1. This is a user interface property only. Match this to the value of IDeviationInterval::DeviationInterval on the StandardDeviation object used to generate the class breaks for the ClassBreaksRenderer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDeviationInterval in interface IClassBreaksUIProperties

Returns:

The interval

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDeviationInterval

public void setDeviationInterval(double interval)
                          throws IOException,
                                 AutomationException

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

Description

DeviationInterval is the percentage of one standard deviation to be used as the interval of the class breaks. Range is 0 to 1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDeviationInterval in interface IClassBreaksUIProperties

Parameters:

interval - The interval (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxSampleSize

public int getMaxSampleSize()
                     throws IOException,
                            AutomationException

Maximum sample size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getMaxSampleSize in interface IDataSampling

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxSampleSize

public void setMaxSampleSize(int size)
                      throws IOException,
                             AutomationException

Maximum sample size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setMaxSampleSize in interface IDataSampling

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSamplingMethod

public int getSamplingMethod()
                      throws IOException,
                             AutomationException

Data sampling method.

Remarks

esriAllRecords samples all features up to the maximum sample size

esriRandomRecords is not implemented

esriEveryNthRecord is not implemented

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSamplingMethod in interface IDataSampling

Returns:

A com.esri.arcgis.carto.esriDataSampling constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSamplingMethod

public void setSamplingMethod(int method)
                       throws IOException,
                              AutomationException

Data sampling method.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setSamplingMethod in interface IDataSampling

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException