com.esri.arcgis.datasourcesraster

Class RasterColormap

java.lang.Object

com.esri.arcgis.datasourcesraster.RasterColormap

All Implemented Interfaces:

IRasterColormap2, IRasterColormap3, IRasterColormap4, IRasterColormap, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class RasterColormap
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterColormap, IRasterColormap2, IRasterColormap3, IRasterColormap4, IPersist, IPersistStream, java.io.Externalizable

COM Class 'RasterColormap'. Generated 4/9/2024 11:09:17 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A container for a colormap used to display a raster band.' 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

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterColormap4

IID, IID706f687a_ae96_416f_aeeb_bd234bbb7dc9, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterColormap3

IID0ead5a24_a135_46ee_acc2_2cb6181f1c2b

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterColormap2

IIDa4d0d354_b981_4088_9384_2f82a19783a6

Fields inherited from interface com.esri.arcgis.geodatabase.IRasterColormap

IID7e7e6105_fa34_11d1_8d22_0000f8780535

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

Constructor Summary

Constructors

Constructor and Description
RasterColormap() Constructs a RasterColormap using ArcGIS Engine.
RasterColormap(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. RasterColormap theRasterColormap = (RasterColormap) obj;

Method Summary

Modifier and Type	Method and Description
int	bin(double pixval) Translates pixel values into integers to index them into the colormap.
boolean	equals(java.lang.Object o) Compare this object with another
IBinFunction	getBinFunction() The Bin function that maps pixel value into colormap index.
java.lang.Object	getBlueValues() Array of blue ratios as doubles between 0.0 and 1.0.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getColors() Array of colors as OLE_COLORs.
java.lang.Object	getGreenValues() Array of green ratios as doubles between 0.0 and 1.0.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.Object	getRedValues() Array of red ratios as doubles between 0.0 and 1.0.
java.lang.Object	getRemappedBlueValues() The remapped Blue color component values using LUT from index to value (OBJECTID, VALUE).
java.lang.Object	getRemappedColors() The remapped colors using LUT from index to value (OBJECTID, VALUE).
java.lang.Object	getRemappedGreenValues() The remapped Green color component values using LUT from index to value (OBJECTID, VALUE).
java.lang.Object	getRemappedRedValues() The remapped Red color component values using LUT from index to value (OBJECTID, VALUE).
int	getSize() The number of colors in this colormap.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
java.lang.Object	getValues() The list of pixel values.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	loadFrom(java.lang.String colormapFileName) Loads colors from an Esri .clr file.
void	loadFromString(java.lang.String colormapDefinition) Loads from a colormap definition string.
void	queryMinMax(int[] min, int[] max) Queries minimum and maximum pixel values.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	save(IStream pstm, int fClearDirty) save
void	saveTo(java.lang.String colormapFileName) Saves colors to an Esri .clr file.
void	setBlueValues(java.lang.Object val) Array of blue ratios as doubles between 0.0 and 1.0.
void	setColors(java.lang.Object val) Array of colors as OLE_COLORs.
void	setGreenValues(java.lang.Object val) Array of green ratios as doubles between 0.0 and 1.0.
void	setLUT(ITable rhs1) The lookup table (OBJECTID, VALUE) for remaping from index to pixel value.
void	setRedValues(java.lang.Object val) Array of red ratios as doubles between 0.0 and 1.0.
void	setValues(java.lang.Object pValues) The list of pixel values.
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

RasterColormap

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

Constructs a RasterColormap using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterColormap

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getRedValues

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

Array of red ratios as doubles between 0.0 and 1.0.

Specified by:

getRedValues in interface IRasterColormap

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRedValues

public void setRedValues(java.lang.Object val)
                  throws java.io.IOException,
                         AutomationException

Array of red ratios as doubles between 0.0 and 1.0.

Specified by:

setRedValues in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGreenValues

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

Array of green ratios as doubles between 0.0 and 1.0.

Specified by:

getGreenValues in interface IRasterColormap

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGreenValues

public void setGreenValues(java.lang.Object val)
                    throws java.io.IOException,
                           AutomationException

Array of green ratios as doubles between 0.0 and 1.0.

Specified by:

setGreenValues in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBlueValues

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

Array of blue ratios as doubles between 0.0 and 1.0.

Specified by:

getBlueValues in interface IRasterColormap

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBlueValues

public void setBlueValues(java.lang.Object val)
                   throws java.io.IOException,
                          AutomationException

Array of blue ratios as doubles between 0.0 and 1.0.

Specified by:

setBlueValues in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getColors

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

Array of colors as OLE_COLORs.

Specified by:

getColors in interface IRasterColormap

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setColors

public void setColors(java.lang.Object val)
               throws java.io.IOException,
                      AutomationException

Array of colors as OLE_COLORs.

Specified by:

setColors in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

bin

public int bin(double pixval)
        throws java.io.IOException,
               AutomationException

Translates pixel values into integers to index them into the colormap.

Specified by:

bin in interface IRasterColormap

Parameters:

pixval - The pixval (in)

Returns:

The bin

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLUT

public void setLUT(ITable rhs1)
            throws java.io.IOException,
                   AutomationException

The lookup table (OBJECTID, VALUE) for remaping from index to pixel value.

Specified by:

setLUT in interface IRasterColormap2

Parameters:

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

getRemappedColors

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

The remapped colors using LUT from index to value (OBJECTID, VALUE).

Specified by:

getRemappedColors in interface IRasterColormap2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRemappedRedValues

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

The remapped Red color component values using LUT from index to value (OBJECTID, VALUE).

Specified by:

getRemappedRedValues in interface IRasterColormap2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRemappedGreenValues

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

The remapped Green color component values using LUT from index to value (OBJECTID, VALUE).

Specified by:

getRemappedGreenValues in interface IRasterColormap2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRemappedBlueValues

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

The remapped Blue color component values using LUT from index to value (OBJECTID, VALUE).

Specified by:

getRemappedBlueValues in interface IRasterColormap2

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBinFunction

public IBinFunction getBinFunction()
                            throws java.io.IOException,
                                   AutomationException

The Bin function that maps pixel value into colormap index.

Specified by:

getBinFunction in interface IRasterColormap2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadFrom

public void loadFrom(java.lang.String colormapFileName)
              throws java.io.IOException,
                     AutomationException

Loads colors from an Esri .clr file.

Specified by:

loadFrom in interface IRasterColormap3

Parameters:

colormapFileName - The colormapFileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

saveTo

public void saveTo(java.lang.String colormapFileName)
            throws java.io.IOException,
                   AutomationException

Saves colors to an Esri .clr file.

Specified by:

saveTo in interface IRasterColormap3

Parameters:

colormapFileName - The colormapFileName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValues

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

The list of pixel values.

Specified by:

getValues in interface IRasterColormap4

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setValues

public void setValues(java.lang.Object pValues)
               throws java.io.IOException,
                      AutomationException

The list of pixel values.

Specified by:

setValues in interface IRasterColormap4

Parameters:

pValues - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryMinMax

public void queryMinMax(int[] min,
                        int[] max)
                 throws java.io.IOException,
                        AutomationException

Queries minimum and maximum pixel values.

Specified by:

queryMinMax in interface IRasterColormap4

Parameters:

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadFromString

public void loadFromString(java.lang.String colormapDefinition)
                    throws java.io.IOException,
                           AutomationException

Loads from a colormap definition string.

Specified by:

loadFromString in interface IRasterColormap4

Parameters:

colormapDefinition - The colormapDefinition (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSize

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

The number of colors in this colormap.

Specified by:

getSize in interface IRasterColormap4

Returns:

The size

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.

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