com.esri.arcgis.carto
Class RasterUniqueValueRenderer

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

All Implemented Interfaces:

IDisplayTableExchange, IIdentify, ILegendInfo, IRasterDisplayProps, IRasterRenderer, IRasterRenderer2, IRasterRendererClassInfo, IRasterRendererColorRamp, IRasterRendererInfo, IRasterRendererUniqueValues, IRasterRendererUpdate, IRasterUniqueValueRenderer, IDisplayAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class RasterUniqueValueRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterUniqueValueRenderer, IRasterRenderer, IRasterRenderer2, IRasterRendererInfo, IRasterRendererColorRamp, IRasterDisplayProps, IIdentify, ILegendInfo, IDisplayAdmin, IRasterRendererClassInfo, IRasterRendererUniqueValues, IDisplayTableExchange, IRasterRendererUpdate, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable

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

Description 'A renderer for rasters with unique values.' 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.IRasterUniqueValueRenderer

IID, IID279369a8_57da_11d2_aab1_00c04fa33416, xxDummy

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

IID, IID6f5322d1_3790_11d2_8d26_0000f8780535, xxDummy

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

IID, IID36695416_2a62_4f24_a97c_5b60f40cf311, xxDummy

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

IID, IID2546feb5_7334_41c7_9160_0b15ba62c809, xxDummy

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

IID, IID04402b9e_6136_4ba4_a5f7_50fdbc245d9c, xxDummy

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

IID, IIDa6a46058_92f3_11d3_aba5_0008c73fca1c, xxDummy

Fields inherited from interface com.esri.arcgis.display.IDisplayAdmin

IID, IID12e361f0_1907_11d3_80c7_0080c79f0371, xxDummy

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

IID, IID0f3e50d0_3194_11d4_a66c_0008c7df8989, xxDummy

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

IID, IID58e9fbff_c3ad_4baa_9258_aa3902e73bc9, xxDummy

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

IID, IID56448e92_9ef7_11d4_b286_00508bcdc7c8, xxDummy

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

IID, IID76877c54_c010_4550_a202_bc882196af40, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

RasterUniqueValueRenderer()
Constructs a RasterUniqueValueRenderer using ArcGIS Engine.

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

Method Summary

void	adaptRaster(IRaster pRaster) Adapts to the new raster.
void	addValue(int iHeading, int iClass, java.lang.Object value) Adds a value to a particular class in the specified heading.
boolean	canRender(IRaster raster) Indicates if the raster can be rendered.
void	copy(IRasterRenderer pSource) Selects a raster as the current copy object.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
void	draw(IRaster raster, int drawPhase, IDisplay pDisplay, ITrackCancel pTrackCancel) Draws the raster on the display.
boolean	equals(java.lang.Object o) Compare this object with another
int	getBrightnessValue() Brightness value for a raster.
int	getClassCount() Number of classes in the renderer.
int	getClassCount(int iHeading) Number of classes in the specified heading.
void	getClassID(GUID[] pClassID) getClassID
java.lang.String	getClassificationField() Classification field name or an empty string if a table doesn't exist.
static java.lang.String	getClsid() getClsid.
java.lang.String	getColorScheme() Current renderer color scheme.
int	getContrastValue() Contrast value for a raster.
java.lang.String	getDefaultLabel() Default label for the unique value renderer.
ISymbol	getDefaultSymbol() Default unique value renderer.
java.lang.String	getDescription() The description of the raster renderer.
java.lang.String	getDescription(int iHeading, int iClass) Description for a particular class in the specified heading.
int	getDisplayResolutionFactor() Display resolution factor.
ITable	getDisplayTable() The renderer display table.
java.lang.String	getField() Currently active renderer field.
java.lang.String	getHeading(int iHeading) One heading in the heading list based on its index.
int	getHeadingCount() Number of headings used by the renderer.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLabel(int iHeading, int iClass) Label for a particular class in the specified heading.
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.String	getName() The name of the raster renderer.
IColor	getNoDataColor() Nodata color for a raster.
java.lang.String	getNormalizationField() Normalization field name or an empty string if none.
IRaster	getRaster() Raster to be rendered.
int	getResamplingType() Resampling method for displaying a raster.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ISymbol	getSymbol(int iHeading, int iClass) Symbol for a particular class in the specified heading.
int	getTransparencyValue() Transparency value for a raster.
IUniqueValues	getUniqueValues() The list of unique values.
java.lang.Object	getValue(int iHeading, int iClass, int iValue) Value of a particular class in the specified heading based on its index.
int	getValueCount(int iHeading, int iClass) Number of values in a particular class in the specified heading.
int	hashCode() the hashcode for this object
IArray	identify(IGeometry pGeom) Identifies objects at the specified location.
IColorRamp	IRasterRendererColorRamp_getColorRamp() The color ramp of the color map.
void	isDirty() isDirty
boolean	isNumericClasses() Indicates if the classification field is numeric.
boolean	isSymbolsAreGraduated() Indicates if symbols are graduated.
boolean	isUpdated() Indicates whether the renderer requires updating.
boolean	isUseDefaultSymbol() Indicates whether the default unique value renderer is currently active.
boolean	isUsesFilter() Indicates if the current object draws using a filter.
void	load(IStream pstm) load
void	queryNumberClass(int classIndex, double[] minValue, double[] maxValue, int[] outValue) Information for a number class by index.
void	queryStringClass(int classIndex, java.lang.String[] inValue, int[] outValue) Information for a string class by index.
void	readExternal(java.io.ObjectInput in)
void	recreateRaster(IRasterDataset pDataset, IRaster pRaster) Recreates a raster, if necessary, from a given RasterDataset.
void	release() Release a RasterUniqueValueRenderer.
void	removeValues(int iHeading, int iClass) Removes a value from a particular class in the specified heading.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setBrightnessValue(int pValue) Brightness value for a raster.
void	setClassCount(int iHeading, int pCount) Number of classes in the specified heading.
void	setColorRamp(IColorRamp ppColorRamp) The color ramp of the color map.
void	setColorScheme(java.lang.String pName) Current renderer color scheme.
void	setContrastValue(int iValue) Contrast value for a raster.
void	setDefaultLabel(java.lang.String pLabel) Default label for the unique value renderer.
void	setDefaultSymbolByRef(ISymbol ppSymbol) Default unique value renderer.
void	setDescription(int iHeading, int iClass, java.lang.String pDescription) Description for a particular class in the specified heading.
void	setDisplayResolutionFactor(int pnFactor) Display resolution factor.
void	setDisplayTableByRef(ITable ppTable) The renderer display table.
void	setField(java.lang.String pField) Currently active renderer field.
void	setHeading(int iHeading, java.lang.String pHeading) One heading in the heading list based on its index.
void	setHeadingCount(int pCount) Number of headings used by the renderer.
void	setLabel(int iHeading, int iClass, java.lang.String pLabel) Label for a particular class in the specified heading.
void	setNoDataColorByRef(IColor ppColor) Nodata color for a raster.
void	setRasterByRef(IRaster raster) Raster to be rendered.
void	setResamplingType(int pResamplingType) Resampling method for displaying a raster.
void	setSymbol(int iHeading, int iClass, ISymbol pSymbol) Symbol for a particular class in the specified heading.
void	setSymbolsAreGraduated(boolean symbolsAreGraduated) Indicates if symbols are graduated.
void	setTransparencyValue(int pValue) Transparency value for a raster.
void	setUniqueValuesByRef(IUniqueValues ppUniqueValues) The list of unique values.
void	setUseDefaultSymbol(boolean pFlag) Indicates whether the default unique value renderer is currently active.
void	update() Updates the renderer for any changes that have been made.
void	update(IRasterLayer pRasterLayer) Updates this raster renderer using a given raster layer.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RasterUniqueValueRenderer

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

Constructs a RasterUniqueValueRenderer using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterUniqueValueRenderer

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

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

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

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

Specified by:

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

setUseDefaultSymbol

public void setUseDefaultSymbol(boolean pFlag)
                         throws java.io.IOException,
                                AutomationException

Indicates whether the default unique value renderer is currently active.

Specified by:

setUseDefaultSymbol in interface IRasterUniqueValueRenderer

Parameters:

pFlag - The pFlag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseDefaultSymbol

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

Indicates whether the default unique value renderer is currently active.

Specified by:

isUseDefaultSymbol in interface IRasterUniqueValueRenderer

Returns:

The pFlag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultSymbolByRef

public void setDefaultSymbolByRef(ISymbol ppSymbol)
                           throws java.io.IOException,
                                  AutomationException

Default unique value renderer.

Specified by:

setDefaultSymbolByRef in interface IRasterUniqueValueRenderer

Parameters:

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

getDefaultSymbol

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

Default unique value renderer.

Specified by:

getDefaultSymbol in interface IRasterUniqueValueRenderer

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.

setDefaultLabel

public void setDefaultLabel(java.lang.String pLabel)
                     throws java.io.IOException,
                            AutomationException

Default label for the unique value renderer.

Specified by:

setDefaultLabel in interface IRasterUniqueValueRenderer

Parameters:

pLabel - The pLabel (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultLabel

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

Default label for the unique value renderer.

Specified by:

getDefaultLabel in interface IRasterUniqueValueRenderer

Returns:

The pLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setField

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

Currently active renderer field.

Specified by:

setField in interface IRasterUniqueValueRenderer

Parameters:

pField - The pField (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

Currently active renderer field.

Specified by:

getField in interface IRasterUniqueValueRenderer

Returns:

The pField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColorScheme

public void setColorScheme(java.lang.String pName)
                    throws java.io.IOException,
                           AutomationException

Current renderer color scheme.

Specified by:

setColorScheme in interface IRasterRendererColorRamp

Specified by:

setColorScheme in interface IRasterUniqueValueRenderer

Parameters:

pName - The pName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColorScheme

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

Current renderer color scheme.

Specified by:

getColorScheme in interface IRasterRendererColorRamp

Specified by:

getColorScheme in interface IRasterUniqueValueRenderer

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeadingCount

public void setHeadingCount(int pCount)
                     throws java.io.IOException,
                            AutomationException

Number of headings used by the renderer.

Specified by:

setHeadingCount in interface IRasterUniqueValueRenderer

Parameters:

pCount - The pCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeadingCount

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

Number of headings used by the renderer.

Specified by:

getHeadingCount in interface IRasterUniqueValueRenderer

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHeading

public void setHeading(int iHeading,
                       java.lang.String pHeading)
                throws java.io.IOException,
                       AutomationException

One heading in the heading list based on its index.

Specified by:

setHeading in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

pHeading - The pHeading (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHeading

public java.lang.String getHeading(int iHeading)
                            throws java.io.IOException,
                                   AutomationException

One heading in the heading list based on its index.

Specified by:

getHeading in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

Returns:

The pHeading

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setClassCount

public void setClassCount(int iHeading,
                          int pCount)
                   throws java.io.IOException,
                          AutomationException

Number of classes in the specified heading.

Specified by:

setClassCount in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

pCount - The pCount (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassCount

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

Number of classes in the specified heading.

Specified by:

getClassCount in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSymbol

public void setSymbol(int iHeading,
                      int iClass,
                      ISymbol pSymbol)
               throws java.io.IOException,
                      AutomationException

Symbol for a particular class in the specified heading.

Specified by:

setSymbol in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

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

getSymbol

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

Symbol for a particular class in the specified heading.

Specified by:

getSymbol in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

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

setLabel

public void setLabel(int iHeading,
                     int iClass,
                     java.lang.String pLabel)
              throws java.io.IOException,
                     AutomationException

Label for a particular class in the specified heading.

Specified by:

setLabel in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

pLabel - The pLabel (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 iHeading,
                                 int iClass)
                          throws java.io.IOException,
                                 AutomationException

Label for a particular class in the specified heading.

Specified by:

getLabel in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

Returns:

The pLabel

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(int iHeading,
                           int iClass,
                           java.lang.String pDescription)
                    throws java.io.IOException,
                           AutomationException

Description for a particular class in the specified heading.

Specified by:

setDescription in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

pDescription - The pDescription (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 iHeading,
                                       int iClass)
                                throws java.io.IOException,
                                       AutomationException

Description for a particular class in the specified heading.

Specified by:

getDescription in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

Returns:

The pDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addValue

public void addValue(int iHeading,
                     int iClass,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

Adds a value to a particular class in the specified heading.

Specified by:

addValue in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeValues

public void removeValues(int iHeading,
                         int iClass)
                  throws java.io.IOException,
                         AutomationException

Removes a value from a particular class in the specified heading.

Specified by:

removeValues in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValueCount

public int getValueCount(int iHeading,
                         int iClass)
                  throws java.io.IOException,
                         AutomationException

Number of values in a particular class in the specified heading.

Specified by:

getValueCount in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

Returns:

The pCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public java.lang.Object getValue(int iHeading,
                                 int iClass,
                                 int iValue)
                          throws java.io.IOException,
                                 AutomationException

Value of a particular class in the specified heading based on its index.

Specified by:

getValue in interface IRasterUniqueValueRenderer

Parameters:

iHeading - The iHeading (in)

iClass - The iClass (in)

iValue - The iValue (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canRender

public boolean canRender(IRaster raster)
                  throws java.io.IOException,
                         AutomationException

Indicates if the raster can be rendered.

Specified by:

canRender in interface IRasterRenderer

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Returns:

The pCanRender

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(IRaster raster)
                    throws java.io.IOException,
                           AutomationException

Raster to be rendered.

Specified by:

setRasterByRef in interface IRasterRenderer

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRaster

public IRaster getRaster()
                  throws java.io.IOException,
                         AutomationException

Raster to be rendered.

Specified by:

getRaster in interface IRasterRenderer

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

draw

public void draw(IRaster raster,
                 int drawPhase,
                 IDisplay pDisplay,
                 ITrackCancel pTrackCancel)
          throws java.io.IOException,
                 AutomationException

Draws the raster on the display.

Specified by:

draw in interface IRasterRenderer

Parameters:

raster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

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

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

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

isUpdated

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

Indicates whether the renderer requires updating.

Specified by:

isUpdated in interface IRasterRenderer

Returns:

The pUpdated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

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

Updates the renderer for any changes that have been made.

Specified by:

update in interface IRasterRenderer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

copy

public void copy(IRasterRenderer pSource)
          throws java.io.IOException,
                 AutomationException

Selects a raster as the current copy object.

Specified by:

copy in interface IRasterRenderer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResamplingType

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

Resampling method for displaying a raster.

Specified by:

getResamplingType in interface IRasterRenderer

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResamplingType

public void setResamplingType(int pResamplingType)
                       throws java.io.IOException,
                              AutomationException

Resampling method for displaying a raster.

Specified by:

setResamplingType in interface IRasterRenderer

Parameters:

pResamplingType - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayResolutionFactor

public void setDisplayResolutionFactor(int pnFactor)
                                throws java.io.IOException,
                                       AutomationException

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Specified by:

setDisplayResolutionFactor in interface IRasterRenderer

Parameters:

pnFactor - The pnFactor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayResolutionFactor

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

Display resolution factor. Factor value is expressed as a percentage between 0 and 100.

Specified by:

getDisplayResolutionFactor in interface IRasterRenderer

Returns:

The pnFactor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

recreateRaster

public void recreateRaster(IRasterDataset pDataset,
                           IRaster pRaster)
                    throws java.io.IOException,
                           AutomationException

Recreates a raster, if necessary, from a given RasterDataset.

Specified by:

recreateRaster in interface IRasterRenderer2

Parameters:

pDataset - A reference to a com.esri.arcgis.geodatabase.IRasterDataset (in)

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

adaptRaster

public void adaptRaster(IRaster pRaster)
                 throws java.io.IOException,
                        AutomationException

Adapts to the new raster.

Specified by:

adaptRaster in interface IRasterRenderer2

Parameters:

pRaster - A reference to a com.esri.arcgis.geodatabase.IRaster (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the raster renderer.

Specified by:

getName in interface IRasterRendererInfo

Returns:

The pName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

The description of the raster renderer.

Specified by:

getDescription in interface IRasterRendererInfo

Returns:

The pDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

IRasterRendererColorRamp_getColorRamp

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

The color ramp of the color map.

Specified by:

IRasterRendererColorRamp_getColorRamp in interface IRasterRendererColorRamp

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.

setColorRamp

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

The color ramp of the color map.

Specified by:

setColorRamp in interface IRasterRendererColorRamp

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.

setContrastValue

public void setContrastValue(int iValue)
                      throws java.io.IOException,
                             AutomationException

Contrast value for a raster.

Specified by:

setContrastValue in interface IRasterDisplayProps

Parameters:

iValue - The iValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getContrastValue

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

Contrast value for a raster.

Specified by:

getContrastValue in interface IRasterDisplayProps

Returns:

The iValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBrightnessValue

public void setBrightnessValue(int pValue)
                        throws java.io.IOException,
                               AutomationException

Brightness value for a raster.

Specified by:

setBrightnessValue in interface IRasterDisplayProps

Parameters:

pValue - The pValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBrightnessValue

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

Brightness value for a raster.

Specified by:

getBrightnessValue in interface IRasterDisplayProps

Returns:

The pValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransparencyValue

public void setTransparencyValue(int pValue)
                          throws java.io.IOException,
                                 AutomationException

Transparency value for a raster.

Specified by:

setTransparencyValue in interface IRasterDisplayProps

Parameters:

pValue - The pValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransparencyValue

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

Transparency value for a raster.

Specified by:

getTransparencyValue in interface IRasterDisplayProps

Returns:

The pValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataColor

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

Nodata color for a raster.

Specified by:

getNoDataColor in interface IRasterDisplayProps

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataColorByRef

public void setNoDataColorByRef(IColor ppColor)
                         throws java.io.IOException,
                                AutomationException

Nodata color for a raster.

Specified by:

setNoDataColorByRef in interface IRasterDisplayProps

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

identify

public IArray identify(IGeometry pGeom)
                throws java.io.IOException,
                       AutomationException

Identifies objects at the specified location.

Remarks

When the IIdentify interface is on a map layer, the Identify method returns an array of FeatureIdentifyObject objects.

On a FeatureIdentifyObject, you can do a QI to the IIdentifyObj interface to get more information about the identified feature. The IIdentifyObj interface returns the window handle, layer, and name of the feature; it has methods to flash the feature in the display and to display a context menu at the Identify location.

This method performs an identify operation with the provided geometry. When identifying layers, typically a small envelope is passed in rather than a point to account for differences in the precision of the display and the feature geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

identify in interface IIdentify

Parameters:

pGeom - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

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

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.

isUsesFilter

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

Indicates if the current object draws using a filter.

Specified by:

isUsesFilter in interface IDisplayAdmin

Returns:

The usesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassificationField

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

Classification field name or an empty string if a table doesn't exist.

Specified by:

getClassificationField in interface IRasterRendererClassInfo

Returns:

The classFieldName

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 name or an empty string if none.

Specified by:

getNormalizationField in interface IRasterRendererClassInfo

Returns:

The normFieldName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isNumericClasses

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

Indicates if the classification field is numeric.

Specified by:

isNumericClasses in interface IRasterRendererClassInfo

Returns:

The bNumeric

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 in the renderer.

Specified by:

getClassCount in interface IRasterRendererClassInfo

Returns:

The classCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryNumberClass

public void queryNumberClass(int classIndex,
                             double[] minValue,
                             double[] maxValue,
                             int[] outValue)
                      throws java.io.IOException,
                             AutomationException

Information for a number class by index.

Specified by:

queryNumberClass in interface IRasterRendererClassInfo

Parameters:

classIndex - The classIndex (in)

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryStringClass

public void queryStringClass(int classIndex,
                             java.lang.String[] inValue,
                             int[] outValue)
                      throws java.io.IOException,
                             AutomationException

Information for a string class by index.

Specified by:

queryStringClass in interface IRasterRendererClassInfo

Parameters:

classIndex - The classIndex (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUniqueValuesByRef

public void setUniqueValuesByRef(IUniqueValues ppUniqueValues)
                          throws java.io.IOException,
                                 AutomationException

The list of unique values.

Specified by:

setUniqueValuesByRef in interface IRasterRendererUniqueValues

Parameters:

ppUniqueValues - A reference to a com.esri.arcgis.datasourcesraster.IUniqueValues (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUniqueValues

public IUniqueValues getUniqueValues()
                              throws java.io.IOException,
                                     AutomationException

The list of unique values.

Specified by:

getUniqueValues in interface IRasterRendererUniqueValues

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IUniqueValues

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayTableByRef

public void setDisplayTableByRef(ITable ppTable)
                          throws java.io.IOException,
                                 AutomationException

The renderer display table.

Specified by:

setDisplayTableByRef in interface IDisplayTableExchange

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayTable

public ITable getDisplayTable()
                       throws java.io.IOException,
                              AutomationException

The renderer display table.

Specified by:

getDisplayTable in interface IDisplayTableExchange

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

update

public void update(IRasterLayer pRasterLayer)
            throws java.io.IOException,
                   AutomationException

Updates this raster renderer using a given raster layer.

Specified by:

update in interface IRasterRendererUpdate

Parameters:

pRasterLayer - A reference to a com.esri.arcgis.carto.IRasterLayer (in)

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.

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.

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.

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