com.esri.arcgis.datasourcesraster

Class RemapFunctionArguments

java.lang.Object

com.esri.arcgis.datasourcesraster.RemapFunctionArguments

All Implemented Interfaces:

IRasterFunctionArguments, IRasterFunctionArguments2, IRemapFunctionArguments, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class RemapFunctionArguments
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFunctionArguments, IRasterFunctionArguments2, IRemapFunctionArguments, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable

COM Class 'RemapFunctionArguments'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A class for remap raster function arguments.' 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.IRasterFunctionArguments2

IID, IIDfd4f0d2d_1f81_4b2d_8ae5_90cef59c3cfe, xxDummy

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

IID04aa081e_28b0_47e4_b375_f367046da924

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

IID, IID6997f806_48be_4f4b_afcc_f2d765541cdd, 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

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

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
void	fromJSON(IJSONObject pJSON, IRasterFunctionTemplateMapper pOptRFTMapper) Loads raster function arguments from JSON.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IStringArray	getFileList() The list of all files associated with the arguments.
java.lang.String	getInputField() The field in the Attribute table that contains (minimum) pixel values.
IDoubleArray	getInputRanges() The collection of min-max value pairs indicating input remap classes.
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.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IStringArray	getNames() The list of all argument names.
IDoubleArray	getNoDataRanges() The collection of min-max value pairs indicating NoData.
java.lang.String	getOutputField() The field in the attribute table containing the remapped values.
IDoubleArray	getOutputValues() The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.
java.lang.Object	getRaster() The source raster object.
java.lang.Object	getReplacementValue() The value that will replace unmatched / missing values.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
ITable	getTable() The table used to lookup pixel values.
java.lang.Object	getValue(java.lang.String name) Gets a named argument value.
IVariantArray	getValues() The list of all arguments.
int	hashCode() the hashcode for this object
boolean	isAllowUnmatched() Indicates if unmatched values should be passed through.
void	isDirty() isDirty
boolean	isUseTable() Indicates if the attribute table should be used for remapping.
void	load(IStream pstm) load
void	putValue(java.lang.String name, java.lang.Object value) Puts a named argument value.
void	readExternal(java.io.ObjectInput in)
void	release() Release this COM object reference
void	remove(java.lang.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	setAllowUnmatched(boolean pbAllowUnmatched) Indicates if unmatched values should be passed through.
void	setInputField(java.lang.String pInputField) The field in the Attribute table that contains (minimum) pixel values.
void	setInputRangesByRef(IDoubleArray ppInputRanges) The collection of min-max value pairs indicating input remap classes.
void	setNoDataRangesByRef(IDoubleArray ppNoDataRanges) The collection of min-max value pairs indicating NoData.
void	setOutputField(java.lang.String pOutputField) The field in the attribute table containing the remapped values.
void	setOutputValuesByRef(IDoubleArray ppOutputValues) The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.
void	setRasterByRef(java.lang.Object ppRaster) The source raster object.
void	setReplacementValue(java.lang.Object pReplacementValue) The value that will replace unmatched / missing values.
void	setTableByRef(ITable ppTable) The table used to lookup pixel values.
void	setUseTable(boolean pbUseTable) Indicates if the attribute table should be used for remapping.
IJSONObject	toJSON() Saves raster function arguments to JSON.
void	update(IRow pRow, IPropertySet pPropertySet, IRasterFunctionArguments pTemplateArguments) Updates function variables using a row and set of properties.
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

RemapFunctionArguments

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

Constructs a RemapFunctionArguments using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RemapFunctionArguments

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

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

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

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

getValue

public java.lang.Object getValue(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

Gets a named argument value.

Specified by:

getValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putValue

public void putValue(java.lang.String name,
                     java.lang.Object value)
              throws java.io.IOException,
                     AutomationException

Puts a named argument value.

Specified by:

putValue in interface IRasterFunctionArguments

Parameters:

name - The name (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(java.lang.String name)
            throws java.io.IOException,
                   AutomationException

Removes a named argument value.

Specified by:

remove in interface IRasterFunctionArguments

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Removes all argument values.

Specified by:

removeAll in interface IRasterFunctionArguments

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNames

public IStringArray getNames()
                      throws java.io.IOException,
                             AutomationException

The list of all argument names.

Specified by:

getNames in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValues

public IVariantArray getValues()
                        throws java.io.IOException,
                               AutomationException

The list of all arguments.

Specified by:

getValues in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileList

public IStringArray getFileList()
                         throws java.io.IOException,
                                AutomationException

The list of all files associated with the arguments.

Specified by:

getFileList in interface IRasterFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

resolve

public void resolve(IRow pRow,
                    IPropertySet pPropertySet)
             throws java.io.IOException,
                    AutomationException

Resolves function variables using a row and set of properties.

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:

java.io.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 java.io.IOException,
                   AutomationException

Updates function variables using a row and set of properties.

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:

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

AutomationException - If the ArcObject component throws an exception.

toJSON

public IJSONObject toJSON()
                   throws java.io.IOException,
                          AutomationException

Saves raster function arguments to JSON.

Specified by:

toJSON in interface IRasterFunctionArguments2

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

fromJSON

public void fromJSON(IJSONObject pJSON,
                     IRasterFunctionTemplateMapper pOptRFTMapper)
              throws java.io.IOException,
                     AutomationException

Loads raster function arguments from JSON.

Specified by:

fromJSON in interface IRasterFunctionArguments2

Parameters:

pJSON - A reference to a com.esri.arcgis.system.IJSONObject (in)

pOptRFTMapper - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplateMapper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRaster

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

The source raster object.

Specified by:

getRaster in interface IRemapFunctionArguments

Returns:

A reference to another Object (IUnknown)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRasterByRef

public void setRasterByRef(java.lang.Object ppRaster)
                    throws java.io.IOException,
                           AutomationException

The source raster object.

Specified by:

setRasterByRef in interface IRemapFunctionArguments

Parameters:

ppRaster - A reference to another Object (IUnknown) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAllowUnmatched

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

Indicates if unmatched values should be passed through.

Specified by:

isAllowUnmatched in interface IRemapFunctionArguments

Returns:

The pbAllowUnmatched

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllowUnmatched

public void setAllowUnmatched(boolean pbAllowUnmatched)
                       throws java.io.IOException,
                              AutomationException

Indicates if unmatched values should be passed through.

Specified by:

setAllowUnmatched in interface IRemapFunctionArguments

Parameters:

pbAllowUnmatched - The pbAllowUnmatched (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseTable

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

Indicates if the attribute table should be used for remapping.

Specified by:

isUseTable in interface IRemapFunctionArguments

Returns:

The pbUseTable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseTable

public void setUseTable(boolean pbUseTable)
                 throws java.io.IOException,
                        AutomationException

Indicates if the attribute table should be used for remapping.

Specified by:

setUseTable in interface IRemapFunctionArguments

Parameters:

pbUseTable - The pbUseTable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getInputField

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

The field in the Attribute table that contains (minimum) pixel values.

Specified by:

getInputField in interface IRemapFunctionArguments

Returns:

The pInputField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInputField

public void setInputField(java.lang.String pInputField)
                   throws java.io.IOException,
                          AutomationException

The field in the Attribute table that contains (minimum) pixel values.

Specified by:

setInputField in interface IRemapFunctionArguments

Parameters:

pInputField - The pInputField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputField

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

The field in the attribute table containing the remapped values.

Specified by:

getOutputField in interface IRemapFunctionArguments

Returns:

The pOutputField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputField

public void setOutputField(java.lang.String pOutputField)
                    throws java.io.IOException,
                           AutomationException

The field in the attribute table containing the remapped values.

Specified by:

setOutputField in interface IRemapFunctionArguments

Parameters:

pOutputField - The pOutputField (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTable

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

The table used to lookup pixel values.

Specified by:

getTable in interface IRemapFunctionArguments

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.

setTableByRef

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

The table used to lookup pixel values.

Specified by:

setTableByRef in interface IRemapFunctionArguments

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.

getInputRanges

public IDoubleArray getInputRanges()
                            throws java.io.IOException,
                                   AutomationException

The collection of min-max value pairs indicating input remap classes. Pixel values of the input raster in the range [min,max) are mapped to the corresponding value in the 'OutputValues' collection.

Specified by:

getInputRanges in interface IRemapFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setInputRangesByRef

public void setInputRangesByRef(IDoubleArray ppInputRanges)
                         throws java.io.IOException,
                                AutomationException

The collection of min-max value pairs indicating input remap classes. Pixel values of the input raster in the range [min,max) are mapped to the corresponding value in the 'OutputValues' collection.

Specified by:

setInputRangesByRef in interface IRemapFunctionArguments

Parameters:

ppInputRanges - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputValues

public IDoubleArray getOutputValues()
                             throws java.io.IOException,
                                    AutomationException

The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.

Specified by:

getOutputValues in interface IRemapFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputValuesByRef

public void setOutputValuesByRef(IDoubleArray ppOutputValues)
                          throws java.io.IOException,
                                 AutomationException

The collection of output values to which each input value pair in the 'InputRanges' collection is remapped.

Specified by:

setOutputValuesByRef in interface IRemapFunctionArguments

Parameters:

ppOutputValues - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataRanges

public IDoubleArray getNoDataRanges()
                             throws java.io.IOException,
                                    AutomationException

The collection of min-max value pairs indicating NoData. Pixel values of the input raster in the range [min,max) are set as NoData.

Specified by:

getNoDataRanges in interface IRemapFunctionArguments

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataRangesByRef

public void setNoDataRangesByRef(IDoubleArray ppNoDataRanges)
                          throws java.io.IOException,
                                 AutomationException

The collection of min-max value pairs indicating NoData. Pixel values of the input raster in the range [min,max) are set as NoData.

Specified by:

setNoDataRangesByRef in interface IRemapFunctionArguments

Parameters:

ppNoDataRanges - A reference to a com.esri.arcgis.system.IDoubleArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getReplacementValue

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

The value that will replace unmatched / missing values.

Specified by:

getReplacementValue in interface IRemapFunctionArguments

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReplacementValue

public void setReplacementValue(java.lang.Object pReplacementValue)
                         throws java.io.IOException,
                                AutomationException

The value that will replace unmatched / missing values.

Specified by:

setReplacementValue in interface IRemapFunctionArguments

Parameters:

pReplacementValue - A Variant (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.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

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