com.esri.arcgis.datasourcesraster
Class ColormapFunctionArguments

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.ColormapFunctionArguments
All Implemented Interfaces:
IColormapFunctionArguments, IRasterFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class ColormapFunctionArguments
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IColormapFunctionArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable

A class for colormap raster function arguments.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
ColormapFunctionArguments()
          Constructs a ColormapFunctionArguments using ArcGIS Engine.
ColormapFunctionArguments(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ColormapFunctionArguments theColormapFunctionArguments = (ColormapFunctionArguments) obj;
 
Method Summary
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 IRasterColormap getColormap()
          The raster colormap.
 String getColormapName()
          The pre-defined colormap name, e.g.
 IColorRamp getColorRamp()
          The input color ramp.
 IStringArray getFileList()
          The list of all files associated with the arguments.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 IStringArray getNames()
          The list of all argument names.
 Object getRaster()
          The source raster object.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 Object getValue(String name)
          Gets a named argument value.
 IVariantArray getValues()
          The list of all arguments.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void loadFrom(String colormapFileName)
          Loads from a colormap file.
 void putValue(String name, Object value)
          Puts a named argument value.
 void readExternal(ObjectInput in)
           
 void remove(String name)
          Removes a named argument value.
 void removeAll()
          Removes all argument values.
 void resolve(IRow pRow, IPropertySet pPropertySet)
          Resolves function variables using a row and set of properties.
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setColormapByRef(IRasterColormap ppColormap)
          The raster colormap.
 void setColormapName(String pColormapName)
          The pre-defined colormap name, e.g.
 void setColorRampByRef(IColorRamp ppColorRamp)
          The input color ramp.
 void setRasterByRef(Object ppRaster)
          The source raster object.
 void update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments)
          Updates function variables using a row and set of properties.
 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

ColormapFunctionArguments

public ColormapFunctionArguments()
                          throws IOException,
                                 UnknownHostException
Constructs a ColormapFunctionArguments using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

ColormapFunctionArguments

public ColormapFunctionArguments(Object obj)
                          throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ColormapFunctionArguments theColormapFunctionArguments = (ColormapFunctionArguments) obj;

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

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

getValue

public Object getValue(String name)
                throws IOException,
                       AutomationException
Gets a named argument value.

Product Availability

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

Specified by:
getValue in interface IRasterFunctionArguments
Parameters:
name - The name (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(String name,
                     Object value)
              throws IOException,
                     AutomationException
Puts a named argument value.

Product Availability

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

Specified by:
putValue in interface IRasterFunctionArguments
Parameters:
name - The name (in)
value - A Variant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

public void remove(String name)
            throws IOException,
                   AutomationException
Removes a named argument value.

Product Availability

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

Specified by:
remove in interface IRasterFunctionArguments
Parameters:
name - The name (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all argument values.

Product Availability

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

Specified by:
removeAll in interface IRasterFunctionArguments
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws IOException,
                             AutomationException
The list of all argument names.

Product Availability

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

Specified by:
getNames in interface IRasterFunctionArguments
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws IOException,
                               AutomationException
The list of all arguments.

Product Availability

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

Specified by:
getValues in interface IRasterFunctionArguments
Returns:
A reference to a com.esri.arcgis.system.IVariantArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws IOException,
                                AutomationException
The list of all files associated with the arguments.

Product Availability

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

Specified by:
getFileList in interface IRasterFunctionArguments
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws IOException,
                    AutomationException
Resolves function variables using a row and set of properties.

Product Availability

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

Specified by:
resolve in interface IRasterFunctionArguments
Parameters:
pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

update

public void update(IRow pRow,
                   IPropertySet pPropertySet,
                   IRasterFunctionArguments pTemplateArguments)
            throws IOException,
                   AutomationException
Updates function variables using a row and set of properties.

Product Availability

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

Specified by:
update in interface IRasterFunctionArguments
Parameters:
pRow - A reference to a com.esri.arcgis.geodatabase.IRow (in)
pPropertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
pTemplateArguments - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionArguments (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRaster

public Object getRaster()
                 throws IOException,
                        AutomationException
The source raster object.

Product Availability

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

Specified by:
getRaster in interface IColormapFunctionArguments
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(Object ppRaster)
                    throws IOException,
                           AutomationException
The source raster object.

Product Availability

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

Specified by:
setRasterByRef in interface IColormapFunctionArguments
Parameters:
ppRaster - A reference to another Object (IUnknown) (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColormapName

public String getColormapName()
                       throws IOException,
                              AutomationException
The pre-defined colormap name, e.g. 'Random', 'NDVI', and etc.

Product Availability

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

Specified by:
getColormapName in interface IColormapFunctionArguments
Returns:
The pColormapName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColormapName

public void setColormapName(String pColormapName)
                     throws IOException,
                            AutomationException
The pre-defined colormap name, e.g. 'Random', 'NDVI', and etc.

Product Availability

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

Specified by:
setColormapName in interface IColormapFunctionArguments
Parameters:
pColormapName - The pColormapName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColormap

public IRasterColormap getColormap()
                            throws IOException,
                                   AutomationException
The raster colormap.

Product Availability

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

Specified by:
getColormap in interface IColormapFunctionArguments
Returns:
A reference to a com.esri.arcgis.geodatabase.IRasterColormap
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColormapByRef

public void setColormapByRef(IRasterColormap ppColormap)
                      throws IOException,
                             AutomationException
The raster colormap.

Product Availability

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

Specified by:
setColormapByRef in interface IColormapFunctionArguments
Parameters:
ppColormap - A reference to a com.esri.arcgis.geodatabase.IRasterColormap (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getColorRamp

public IColorRamp getColorRamp()
                        throws IOException,
                               AutomationException
The input color ramp.

Product Availability

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

Specified by:
getColorRamp in interface IColormapFunctionArguments
Returns:
A reference to a com.esri.arcgis.display.IColorRamp
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setColorRampByRef

public void setColorRampByRef(IColorRamp ppColorRamp)
                       throws IOException,
                              AutomationException
The input color ramp.

Product Availability

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

Specified by:
setColorRampByRef in interface IColormapFunctionArguments
Parameters:
ppColorRamp - A reference to a com.esri.arcgis.display.IColorRamp (in)
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 from a colormap file.

Product Availability

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

Specified by:
loadFrom in interface IColormapFunctionArguments
Parameters:
colormapFileName - The colormapFileName (in)
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.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
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