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, Externalizable, Serializable

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

A container for a colormap used to display a raster band.

Remarks

RasterColormap object defines the relationship of the pixels in the raster band and the color indices to be used in the display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterColormap()
Constructs a RasterColormap using ArcGIS Engine.

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

Method Summary

int	bin(double pixval) Translates pixel values into integers to index them into the colormap.
boolean	equals(Object o) Compare this object with another
IBinFunction	getBinFunction() The Bin function that maps pixel value into colormap index.
Object	getBlueValues() Array of blue ratios as doubles between 0.0 and 1.0.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getColors() Array of colors as OLE_COLORs.
Object	getGreenValues() Array of green ratios as doubles between 0.0 and 1.0.
Object	getRedValues() Array of red ratios as doubles between 0.0 and 1.0.
Object	getRemappedBlueValues() The remapped Blue color component values using LUT from index to value (OBJECTID, VALUE).
Object	getRemappedColors() The remapped colors using LUT from index to value (OBJECTID, VALUE).
Object	getRemappedGreenValues() The remapped Green color component values using LUT from index to value (OBJECTID, VALUE).
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
Object	getValues() The list of pixel values.
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	loadFrom(String colormapFileName) Loads colors from an Esri .clr file.
void	loadFromString(String colormapDefinition) Loads from a colormap definition string.
void	queryMinMax(int[] min, int[] max) Queries minimum and maximum pixel values.
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	saveTo(String colormapFileName) Saves colors to an Esri .clr file.
void	setBlueValues(Object val) Array of blue ratios as doubles between 0.0 and 1.0.
void	setColors(Object val) Array of colors as OLE_COLORs.
void	setGreenValues(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(Object val) Array of red ratios as doubles between 0.0 and 1.0.
void	setValues(Object pValues) The list of pixel values.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

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

getJintegraDispatch, release

Constructor Detail

RasterColormap

public RasterColormap()
               throws IOException,
                      UnknownHostException

Constructs a RasterColormap using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

RasterColormap

public RasterColormap(Object obj)
               throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getRedValues

public Object getRedValues()
                    throws IOException,
                           AutomationException

Array of red ratios as doubles between 0.0 and 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getRedValues in interface IRasterColormap

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRedValues

public void setRedValues(Object val)
                  throws IOException,
                         AutomationException

Array of red ratios as doubles between 0.0 and 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setRedValues in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGreenValues

public Object getGreenValues()
                      throws IOException,
                             AutomationException

Array of green ratios as doubles between 0.0 and 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getGreenValues in interface IRasterColormap

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGreenValues

public void setGreenValues(Object val)
                    throws IOException,
                           AutomationException

Array of green ratios as doubles between 0.0 and 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setGreenValues in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBlueValues

public Object getBlueValues()
                     throws IOException,
                            AutomationException

Array of blue ratios as doubles between 0.0 and 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getBlueValues in interface IRasterColormap

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBlueValues

public void setBlueValues(Object val)
                   throws IOException,
                          AutomationException

Array of blue ratios as doubles between 0.0 and 1.0.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setBlueValues in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColors

public Object getColors()
                 throws IOException,
                        AutomationException

Array of colors as OLE_COLORs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getColors in interface IRasterColormap

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setColors

public void setColors(Object val)
               throws IOException,
                      AutomationException

Array of colors as OLE_COLORs.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setColors in interface IRasterColormap

Parameters:

val - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bin

public int bin(double pixval)
        throws IOException,
               AutomationException

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

bin in interface IRasterColormap

Parameters:

pixval - The pixval (in)

Returns:

The bin

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLUT

public void setLUT(ITable rhs1)
            throws IOException,
                   AutomationException

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

Description

Set the lookup table to map index to raster pixel value.

Product Availability

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

Specified by:

setLUT in interface IRasterColormap2

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemappedColors

public Object getRemappedColors()
                         throws IOException,
                                AutomationException

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

Product Availability

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

Specified by:

getRemappedColors in interface IRasterColormap2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemappedRedValues

public Object getRemappedRedValues()
                            throws IOException,
                                   AutomationException

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

Product Availability

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

Specified by:

getRemappedRedValues in interface IRasterColormap2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemappedGreenValues

public Object getRemappedGreenValues()
                              throws IOException,
                                     AutomationException

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

Product Availability

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

Specified by:

getRemappedGreenValues in interface IRasterColormap2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRemappedBlueValues

public Object getRemappedBlueValues()
                             throws IOException,
                                    AutomationException

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

Product Availability

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

Specified by:

getRemappedBlueValues in interface IRasterColormap2

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBinFunction

public IBinFunction getBinFunction()
                            throws IOException,
                                   AutomationException

The Bin function that maps pixel value into colormap index.

Product Availability

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

Specified by:

getBinFunction in interface IRasterColormap2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFrom

public void loadFrom(String colormapFileName)
              throws IOException,
                     AutomationException

Loads colors from an Esri .clr file.

Product Availability

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

Specified by:

loadFrom in interface IRasterColormap3

Parameters:

colormapFileName - The colormapFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveTo

public void saveTo(String colormapFileName)
            throws IOException,
                   AutomationException

Saves colors to an Esri .clr file.

Product Availability

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

Specified by:

saveTo in interface IRasterColormap3

Parameters:

colormapFileName - The colormapFileName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getValues

public Object getValues()
                 throws IOException,
                        AutomationException

The list of pixel values.

Product Availability

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

Specified by:

getValues in interface IRasterColormap4

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setValues

public void setValues(Object pValues)
               throws IOException,
                      AutomationException

The list of pixel values.

Product Availability

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

Specified by:

setValues in interface IRasterColormap4

Parameters:

pValues - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryMinMax

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

Queries minimum and maximum pixel values.

Product Availability

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

Specified by:

queryMinMax in interface IRasterColormap4

Parameters:

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadFromString

public void loadFromString(String colormapDefinition)
                    throws IOException,
                           AutomationException

Loads from a colormap definition string.

Product Availability

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

Specified by:

loadFromString in interface IRasterColormap4

Parameters:

colormapDefinition - The colormapDefinition (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSize

public int getSize()
            throws IOException,
                   AutomationException

The number of colors in this colormap.

Product Availability

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

Specified by:

getSize in interface IRasterColormap4

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

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

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Description

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

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException