com.esri.arcgis.carto
Class RasterStretchColorRampRenderer

java.lang.Object
  extended by com.esri.arcgis.carto.RasterStretchColorRampRenderer
All Implemented Interfaces:
IColorChannelMapping, IDisplayTableExchange, IGlobeRasterStretch, IHillShadeInfo, IIdentify, ILegendInfo, IRasterDisplayProps, IRasterRenderer, IRasterRenderer2, IRasterRendererClassInfo, IRasterRendererColorRamp, IRasterRendererInfo, IRasterRendererUpdate, IRasterStretch, IRasterStretch2, IRasterStretch3, IRasterStretchAdvancedLabels, IRasterStretchColorRampRenderer, IRasterStretchMinMax, IDisplayAdmin, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class RasterStretchColorRampRenderer
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterStretchColorRampRenderer, IGlobeRasterStretch, IRasterStretch, IRasterStretch2, IRasterStretch3, IRasterStretchMinMax, IRasterRenderer, IRasterRenderer2, IRasterRendererInfo, IRasterRendererColorRamp, IRasterDisplayProps, IIdentify, ILegendInfo, IDisplayAdmin, IRasterRendererClassInfo, IColorChannelMapping, IHillShadeInfo, IDisplayTableExchange, IRasterStretchAdvancedLabels, IRasterRendererUpdate, IPersist, IPersistStream, IXMLSerialize, java.io.Externalizable

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

Description 'A renderer with a color ramp for rasters with continuous 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.IRasterStretchColorRampRenderer
IID, IIDa301a3b1_74d7_11d2_9f29_00c04f8ed1d7, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IGlobeRasterStretch
IID, IIDb055b13e_ceb8_406f_a179_1e838f51e30b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IRasterStretch
IID, IID48bb9988_8250_11d3_aba2_0008c73fca1c, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IRasterStretch2
IID, IID51ee1518_7261_4fdd_99c7_b4e35cfc7da0, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IRasterStretch3
IID, IID30f1c42e_4a45_4564_8f08_76a2cd42f661, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IRasterStretchMinMax
IID, IIDca38a249_94fe_45d0_9403_d3a8a3911943, 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.IColorChannelMapping
IID, IID8d12e222_2507_41b5_a21c_5a56a031705b, xxDummy
 
Fields inherited from interface com.esri.arcgis.carto.IHillShadeInfo
IID, IID0a6f1d1a_9a84_40c9_ba10_b5bf139f06ff, 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.IRasterStretchAdvancedLabels
IID, IID75a23444_cedf_4609_b92c_8d45617ebd3a, 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
RasterStretchColorRampRenderer()
          Constructs a RasterStretchColorRampRenderer using ArcGIS Engine.
RasterStretchColorRampRenderer(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterStretchColorRampRenderer theRasterStretchColorRampRenderer = (RasterStretchColorRampRenderer) obj;
 
Method Summary
 void adaptRaster(IRaster pRaster)
          Adapts to the new raster.
 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
 IColor getBackgroundColor()
          Background display color.
 java.lang.Object getBackgroundValue()
          The list of background value(s).
 double getBackgroundValues()
          Indicates whether an array of background values is being used.
 int getBandIndex()
          Index of the band to be rendered.
 java.lang.Object getBandIndices()
          The band indices being used in the mapping.
 int getBrightnessValue()
          Brightness value for a raster.
 int getClassCount()
          Number of classes in the renderer.
 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.
 IColorRamp getColorRamp()
          Color ramp.
 java.lang.String getColorScheme()
          ColorScheme name.
 int getContrastValue()
          Contrast value for a raster.
 double getCustomStretchMax()
          The custom maximum value for stretch renderer type "Minimum-Maximum".
 double getCustomStretchMin()
          The custom minimum value for stretch renderer type "Minimum-Maximum".
 java.lang.String getDescription()
          The description of the raster renderer.
 int getDisplayResolutionFactor()
          Display resolution factor.
 ITable getDisplayTable()
          The renderer display table.
 java.lang.Object getGammaValue()
          The list of Gamma value(s).
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getLabelHigh()
          Label for highest value.
 java.lang.String getLabelLow()
          Label for lowest value.
 java.lang.String getLabelMedium()
          Label for medium value.
 java.lang.String getLabelText(int index)
          Label Text.
 double getLabelValue(int index)
          Value.
 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.
 int getNumLabels()
          Number of labels.
 IRaster getRaster()
          Raster to be rendered.
 int getResamplingType()
          Resampling method for displaying a raster.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IArray getSpecificationHistogram()
          The statistics for histogram specification stretch.
 double getStandardDeviationsParam()
          Standard deviation parameter for the stretch renderer.
 double getStretchMax()
          The maximum value used for stretching cell values.
 double getStretchMin()
          The minimum value used for stretching cell values.
 IArray getStretchStats()
          The global raster stretch statistics.
 int getStretchStatsType()
          The current stretch statistics type.
 int getStretchType()
          Current stretch type.
 int getTransparencyValue()
          Transparency value for a raster.
 double getZScale()
          The Z factor multipled to z valuesg.
 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.
 boolean isBackground()
          Indicates if a background value is being used.
 void isDirty()
          isDirty
 boolean isGlobeLayerRenderer()
          Indicates whether it is a ArcGlobe layer renderer.
 boolean isInvert()
          Indicates if the stretch is inverted.
 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 isUseAdvancedLabeling()
          Indicates whether the advanced labeling is being used.
 boolean isUseCustomStretchMinMax()
          Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".
 boolean isUseDefaultMapping()
          Indicates whether the default mapping is being used.
 boolean isUseGamma()
          Indicates if Gamma stretch should be applied.
 boolean isUseHillShade()
          Indicates whether the hill shading is being used.
 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 RasterStretchColorRampRenderer.
 void resetLabels()
          Makes default labels.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setBackground(boolean b)
          Indicates if a background value is being used.
 void setBackgroundColorByRef(IColor ppColor)
          Background display color.
 void setBackgroundValue(java.lang.Object background)
          The list of background value(s).
 void setBackgroundValues(double[] pBkg)
          Indicates whether an array of background values is being used.
 void setBandIndex(int bandIndex)
          Index of the band to be rendered.
 void setBandIndices(java.lang.Object vIndex)
          The band indices being used in the mapping.
 void setBrightnessValue(int pValue)
          Brightness value for a raster.
 void setColorRamp(IColorRamp ppColorRamp)
          Color ramp.
 void setColorScheme(java.lang.String colorScheme)
          ColorScheme name.
 void setContrastValue(int iValue)
          Contrast value for a raster.
 void setCustomStretchMax(double param)
          The custom maximum value for stretch renderer type "Minimum-Maximum".
 void setCustomStretchMin(double param)
          The custom minimum value for stretch renderer type "Minimum-Maximum".
 void setDisplayResolutionFactor(int pnFactor)
          Display resolution factor.
 void setDisplayTableByRef(ITable ppTable)
          The renderer display table.
 void setGammaValue(java.lang.Object pGamma)
          The list of Gamma value(s).
 void setInvert(boolean pInvert)
          Indicates if the stretch is inverted.
 void setIsGlobeLayerRenderer(boolean flag)
          Indicates whether it is a ArcGlobe layer renderer.
 void setLabelHigh(java.lang.String label)
          Label for highest value.
 void setLabelLow(java.lang.String label)
          Label for lowest value.
 void setLabelMedium(java.lang.String label)
          Label for medium value.
 void setLabelText(int index, java.lang.String text)
          Label Text.
 void setLabelValue(int index, double value)
          Value.
 void setNoDataColorByRef(IColor ppColor)
          Nodata color for a raster.
 void setNumLabels(int numLabels)
          Number of labels.
 void setRasterByRef(IRaster raster)
          Raster to be rendered.
 void setResamplingType(int pResamplingType)
          Resampling method for displaying a raster.
 void setSpecificationHistogramByRef(IArray pRGBStats)
          The statistics for histogram specification stretch.
 void setStandardDeviationsParam(double param)
          Standard deviation parameter for the stretch renderer.
 void setStretchStatsByRef(IArray ppRGBStats)
          The global raster stretch statistics.
 void setStretchStatsType(int stats)
          The current stretch statistics type.
 void setStretchType(int en_stretch)
          Current stretch type.
 void setSymbolsAreGraduated(boolean symbolsAreGraduated)
          Indicates if symbols are graduated.
 void setTransparencyValue(int pValue)
          Transparency value for a raster.
 void setUseAdvancedLabeling(boolean bAdvanced)
          Indicates whether the advanced labeling is being used.
 void setUseCustomStretchMinMax(boolean pUse)
          Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".
 void setUseDefaultMapping(boolean bIsDefault)
          Indicates whether the default mapping is being used.
 void setUseGamma(boolean pUseGamma)
          Indicates if Gamma stretch should be applied.
 void setUseHillShade(boolean bUse)
          Indicates whether the hill shading is being used.
 void setZScale(double pZScale)
          The Z factor multipled to z valuesg.
 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

RasterStretchColorRampRenderer

public RasterStretchColorRampRenderer()
                               throws java.io.IOException,
                                      java.net.UnknownHostException
Constructs a RasterStretchColorRampRenderer using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

RasterStretchColorRampRenderer

public RasterStretchColorRampRenderer(java.lang.Object obj)
                               throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterStretchColorRampRenderer theRasterStretchColorRampRenderer = (RasterStretchColorRampRenderer) obj;

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

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

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

setBandIndex

public void setBandIndex(int bandIndex)
                  throws java.io.IOException,
                         AutomationException
Index of the band to be rendered.

Specified by:
setBandIndex in interface IRasterStretchColorRampRenderer
Parameters:
bandIndex - The bandIndex (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandIndex

public int getBandIndex()
                 throws java.io.IOException,
                        AutomationException
Index of the band to be rendered.

Specified by:
getBandIndex in interface IRasterStretchColorRampRenderer
Returns:
The bandIndex
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
ColorScheme name.

Specified by:
getColorScheme in interface IRasterRendererColorRamp
Specified by:
getColorScheme in interface IRasterStretchColorRampRenderer
Returns:
The colorScheme
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorScheme

public void setColorScheme(java.lang.String colorScheme)
                    throws java.io.IOException,
                           AutomationException
ColorScheme name.

Specified by:
setColorScheme in interface IRasterRendererColorRamp
Specified by:
setColorScheme in interface IRasterStretchColorRampRenderer
Parameters:
colorScheme - The colorScheme (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorRamp

public IColorRamp getColorRamp()
                        throws java.io.IOException,
                               AutomationException
Color ramp.

Specified by:
getColorRamp in interface IRasterStretchColorRampRenderer
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
Color ramp.

Specified by:
setColorRamp in interface IRasterRendererColorRamp
Specified by:
setColorRamp in interface IRasterStretchColorRampRenderer
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.

getLabelLow

public java.lang.String getLabelLow()
                             throws java.io.IOException,
                                    AutomationException
Label for lowest value.

Specified by:
getLabelLow in interface IRasterStretchColorRampRenderer
Returns:
The label
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelLow

public void setLabelLow(java.lang.String label)
                 throws java.io.IOException,
                        AutomationException
Label for lowest value.

Specified by:
setLabelLow in interface IRasterStretchColorRampRenderer
Parameters:
label - The label (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelMedium

public java.lang.String getLabelMedium()
                                throws java.io.IOException,
                                       AutomationException
Label for medium value.

Specified by:
getLabelMedium in interface IRasterStretchColorRampRenderer
Returns:
The label
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelMedium

public void setLabelMedium(java.lang.String label)
                    throws java.io.IOException,
                           AutomationException
Label for medium value.

Specified by:
setLabelMedium in interface IRasterStretchColorRampRenderer
Parameters:
label - The label (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelHigh

public java.lang.String getLabelHigh()
                              throws java.io.IOException,
                                     AutomationException
Label for highest value.

Specified by:
getLabelHigh in interface IRasterStretchColorRampRenderer
Returns:
The label
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelHigh

public void setLabelHigh(java.lang.String label)
                  throws java.io.IOException,
                         AutomationException
Label for highest value.

Specified by:
setLabelHigh in interface IRasterStretchColorRampRenderer
Parameters:
label - The label (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resetLabels

public void resetLabels()
                 throws java.io.IOException,
                        AutomationException
Makes default labels.

Specified by:
resetLabels in interface IRasterStretchColorRampRenderer
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGlobeLayerRenderer

public boolean isGlobeLayerRenderer()
                             throws java.io.IOException,
                                    AutomationException
Indicates whether it is a ArcGlobe layer renderer.

Specified by:
isGlobeLayerRenderer in interface IGlobeRasterStretch
Returns:
The flag
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIsGlobeLayerRenderer

public void setIsGlobeLayerRenderer(boolean flag)
                             throws java.io.IOException,
                                    AutomationException
Indicates whether it is a ArcGlobe layer renderer.

Specified by:
setIsGlobeLayerRenderer in interface IGlobeRasterStretch
Parameters:
flag - The flag (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchType

public void setStretchType(int en_stretch)
                    throws java.io.IOException,
                           AutomationException
Current stretch type.

Specified by:
setStretchType in interface IRasterStretch
Specified by:
setStretchType in interface IRasterStretch2
Parameters:
en_stretch - A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchType

public int getStretchType()
                   throws java.io.IOException,
                          AutomationException
Current stretch type.

Specified by:
getStretchType in interface IRasterStretch
Specified by:
getStretchType in interface IRasterStretch2
Returns:
A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStandardDeviationsParam

public void setStandardDeviationsParam(double param)
                                throws java.io.IOException,
                                       AutomationException
Standard deviation parameter for the stretch renderer.

Specified by:
setStandardDeviationsParam in interface IRasterStretch
Specified by:
setStandardDeviationsParam in interface IRasterStretch2
Parameters:
param - The param (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStandardDeviationsParam

public double getStandardDeviationsParam()
                                  throws java.io.IOException,
                                         AutomationException
Standard deviation parameter for the stretch renderer.

Specified by:
getStandardDeviationsParam in interface IRasterStretch
Specified by:
getStandardDeviationsParam in interface IRasterStretch2
Returns:
The param
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInvert

public void setInvert(boolean pInvert)
               throws java.io.IOException,
                      AutomationException
Indicates if the stretch is inverted.

Specified by:
setInvert in interface IRasterStretch
Specified by:
setInvert in interface IRasterStretch2
Parameters:
pInvert - The pInvert (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInvert

public boolean isInvert()
                 throws java.io.IOException,
                        AutomationException
Indicates if the stretch is inverted.

Specified by:
isInvert in interface IRasterStretch
Specified by:
isInvert in interface IRasterStretch2
Returns:
The pInvert
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackground

public void setBackground(boolean b)
                   throws java.io.IOException,
                          AutomationException
Indicates if a background value is being used.

Specified by:
setBackground in interface IRasterStretch
Specified by:
setBackground in interface IRasterStretch2
Parameters:
b - The b (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBackground

public boolean isBackground()
                     throws java.io.IOException,
                            AutomationException
Indicates if a background value is being used.

Specified by:
isBackground in interface IRasterStretch
Specified by:
isBackground in interface IRasterStretch2
Returns:
The b
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundValues

public double getBackgroundValues()
                           throws java.io.IOException,
                                  AutomationException
Indicates whether an array of background values is being used.

Specified by:
getBackgroundValues in interface IRasterStretch
Returns:
The pBkg
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

public void setBackgroundValues(double[] pBkg)
                         throws java.io.IOException,
                                AutomationException
Indicates whether an array of background values is being used.

Specified by:
setBackgroundValues in interface IRasterStretch
Parameters:
pBkg - The pBkg (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException
Background display color.

Specified by:
getBackgroundColor in interface IRasterStretch
Specified by:
getBackgroundColor in interface IRasterStretch2
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.

setBackgroundColorByRef

public void setBackgroundColorByRef(IColor ppColor)
                             throws java.io.IOException,
                                    AutomationException
Background display color.

Specified by:
setBackgroundColorByRef in interface IRasterStretch
Specified by:
setBackgroundColorByRef in interface IRasterStretch2
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.

getBackgroundValue

public java.lang.Object getBackgroundValue()
                                    throws java.io.IOException,
                                           AutomationException
The list of background value(s).

Specified by:
getBackgroundValue in interface IRasterStretch2
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBackgroundValue

public void setBackgroundValue(java.lang.Object background)
                        throws java.io.IOException,
                               AutomationException
The list of background value(s).

Specified by:
setBackgroundValue in interface IRasterStretch2
Parameters:
background - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchStatsType

public void setStretchStatsType(int stats)
                         throws java.io.IOException,
                                AutomationException
The current stretch statistics type.

Specified by:
setStretchStatsType in interface IRasterStretch2
Parameters:
stats - A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchStatsType

public int getStretchStatsType()
                        throws java.io.IOException,
                               AutomationException
The current stretch statistics type.

Specified by:
getStretchStatsType in interface IRasterStretch2
Returns:
A com.esri.arcgis.carto.esriRasterStretchStatsTypeEnum constant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStretchStatsByRef

public void setStretchStatsByRef(IArray ppRGBStats)
                          throws java.io.IOException,
                                 AutomationException
The global raster stretch statistics.

Specified by:
setStretchStatsByRef in interface IRasterStretch2
Parameters:
ppRGBStats - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchStats

public IArray getStretchStats()
                       throws java.io.IOException,
                              AutomationException
The global raster stretch statistics.

Specified by:
getStretchStats in interface IRasterStretch2
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.

setSpecificationHistogramByRef

public void setSpecificationHistogramByRef(IArray pRGBStats)
                                    throws java.io.IOException,
                                           AutomationException
The statistics for histogram specification stretch.

Specified by:
setSpecificationHistogramByRef in interface IRasterStretch2
Parameters:
pRGBStats - A reference to a com.esri.arcgis.system.IArray (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSpecificationHistogram

public IArray getSpecificationHistogram()
                                 throws java.io.IOException,
                                        AutomationException
The statistics for histogram specification stretch.

Specified by:
getSpecificationHistogram in interface IRasterStretch2
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.

setUseGamma

public void setUseGamma(boolean pUseGamma)
                 throws java.io.IOException,
                        AutomationException
Indicates if Gamma stretch should be applied.

Specified by:
setUseGamma in interface IRasterStretch3
Parameters:
pUseGamma - The pUseGamma (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseGamma

public boolean isUseGamma()
                   throws java.io.IOException,
                          AutomationException
Indicates if Gamma stretch should be applied.

Specified by:
isUseGamma in interface IRasterStretch3
Returns:
The pUseGamma
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGammaValue

public void setGammaValue(java.lang.Object pGamma)
                   throws java.io.IOException,
                          AutomationException
The list of Gamma value(s).

Specified by:
setGammaValue in interface IRasterStretch3
Parameters:
pGamma - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGammaValue

public java.lang.Object getGammaValue()
                               throws java.io.IOException,
                                      AutomationException
The list of Gamma value(s).

Specified by:
getGammaValue in interface IRasterStretch3
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchMin

public double getStretchMin()
                     throws java.io.IOException,
                            AutomationException
The minimum value used for stretching cell values.

Specified by:
getStretchMin in interface IRasterStretchMinMax
Returns:
The param
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStretchMax

public double getStretchMax()
                     throws java.io.IOException,
                            AutomationException
The maximum value used for stretching cell values.

Specified by:
getStretchMax in interface IRasterStretchMinMax
Returns:
The param
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomStretchMin

public void setCustomStretchMin(double param)
                         throws java.io.IOException,
                                AutomationException
The custom minimum value for stretch renderer type "Minimum-Maximum".

Specified by:
setCustomStretchMin in interface IRasterStretchMinMax
Parameters:
param - The param (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomStretchMin

public double getCustomStretchMin()
                           throws java.io.IOException,
                                  AutomationException
The custom minimum value for stretch renderer type "Minimum-Maximum".

Specified by:
getCustomStretchMin in interface IRasterStretchMinMax
Returns:
The param
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCustomStretchMax

public void setCustomStretchMax(double param)
                         throws java.io.IOException,
                                AutomationException
The custom maximum value for stretch renderer type "Minimum-Maximum".

Specified by:
setCustomStretchMax in interface IRasterStretchMinMax
Parameters:
param - The param (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCustomStretchMax

public double getCustomStretchMax()
                           throws java.io.IOException,
                                  AutomationException
The custom maximum value for stretch renderer type "Minimum-Maximum".

Specified by:
getCustomStretchMax in interface IRasterStretchMinMax
Returns:
The param
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseCustomStretchMinMax

public void setUseCustomStretchMinMax(boolean pUse)
                               throws java.io.IOException,
                                      AutomationException
Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".

Specified by:
setUseCustomStretchMinMax in interface IRasterStretchMinMax
Parameters:
pUse - The pUse (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseCustomStretchMinMax

public boolean isUseCustomStretchMinMax()
                                 throws java.io.IOException,
                                        AutomationException
Indicates whether to use the custom minimum/maximum values for stretch renderer type "Minimum-Maximum".

Specified by:
isUseCustomStretchMinMax in interface IRasterStretchMinMax
Returns:
The pUse
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.

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.

isUseDefaultMapping

public boolean isUseDefaultMapping()
                            throws java.io.IOException,
                                   AutomationException
Indicates whether the default mapping is being used.

Specified by:
isUseDefaultMapping in interface IColorChannelMapping
Returns:
The bIsDefault
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseDefaultMapping

public void setUseDefaultMapping(boolean bIsDefault)
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the default mapping is being used.

Specified by:
setUseDefaultMapping in interface IColorChannelMapping
Parameters:
bIsDefault - The bIsDefault (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBandIndices

public java.lang.Object getBandIndices()
                                throws java.io.IOException,
                                       AutomationException
The band indices being used in the mapping.

Specified by:
getBandIndices in interface IColorChannelMapping
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBandIndices

public void setBandIndices(java.lang.Object vIndex)
                    throws java.io.IOException,
                           AutomationException
The band indices being used in the mapping.

Specified by:
setBandIndices in interface IColorChannelMapping
Parameters:
vIndex - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseHillShade

public boolean isUseHillShade()
                       throws java.io.IOException,
                              AutomationException
Indicates whether the hill shading is being used.

Specified by:
isUseHillShade in interface IHillShadeInfo
Returns:
The bUse
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseHillShade

public void setUseHillShade(boolean bUse)
                     throws java.io.IOException,
                            AutomationException
Indicates whether the hill shading is being used.

Specified by:
setUseHillShade in interface IHillShadeInfo
Parameters:
bUse - The bUse (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getZScale

public double getZScale()
                 throws java.io.IOException,
                        AutomationException
The Z factor multipled to z valuesg.

Specified by:
getZScale in interface IHillShadeInfo
Returns:
The pZScale
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setZScale

public void setZScale(double pZScale)
               throws java.io.IOException,
                      AutomationException
The Z factor multipled to z valuesg.

Specified by:
setZScale in interface IHillShadeInfo
Parameters:
pZScale - The pZScale (in)
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.

setNumLabels

public void setNumLabels(int numLabels)
                  throws java.io.IOException,
                         AutomationException
Number of labels.

Specified by:
setNumLabels in interface IRasterStretchAdvancedLabels
Parameters:
numLabels - The numLabels (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumLabels

public int getNumLabels()
                 throws java.io.IOException,
                        AutomationException
Number of labels.

Specified by:
getNumLabels in interface IRasterStretchAdvancedLabels
Returns:
The numLabels
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelText

public java.lang.String getLabelText(int index)
                              throws java.io.IOException,
                                     AutomationException
Label Text.

Specified by:
getLabelText in interface IRasterStretchAdvancedLabels
Parameters:
index - The index (in)
Returns:
The text
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelText

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

Specified by:
setLabelText in interface IRasterStretchAdvancedLabels
Parameters:
index - The index (in)
text - The text (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelValue

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

Specified by:
getLabelValue in interface IRasterStretchAdvancedLabels
Parameters:
index - The index (in)
Returns:
The value
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLabelValue

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

Specified by:
setLabelValue in interface IRasterStretchAdvancedLabels
Parameters:
index - The index (in)
value - The value (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseAdvancedLabeling

public boolean isUseAdvancedLabeling()
                              throws java.io.IOException,
                                     AutomationException
Indicates whether the advanced labeling is being used.

Specified by:
isUseAdvancedLabeling in interface IRasterStretchAdvancedLabels
Returns:
The bAdvanced
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseAdvancedLabeling

public void setUseAdvancedLabeling(boolean bAdvanced)
                            throws java.io.IOException,
                                   AutomationException
Indicates whether the advanced labeling is being used.

Specified by:
setUseAdvancedLabeling in interface IRasterStretchAdvancedLabels
Parameters:
bAdvanced - The bAdvanced (in)
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