com.esri.arcgis.datasourcesraster

Interface IRasterKeyProperties

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

CachedRasterFunction, ComputeChangeFunction, ExtractBandFunction, FunctionRasterDatasetName, GeometricFunction, IdentityFunction, IRasterKeyPropertiesProxy, RasterInfoFunction, SimpleCollectionFunction, StretchFunction

public interface IRasterKeyProperties
extends java.io.Serializable

COM Interface 'IRasterKeyProperties'. Generated 9/21/2023 10:01:48 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description: 'Provides access to members that control raster key properties.' 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 =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID01002227_f833_40aa_a0c9_429ea383c51f
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
void	getAllBandProperties(int bandIndex, IStringArray[] ppNames, IVariantArray[] ppValues) Queries all available band-specific key properties.
void	getAllProperties(IStringArray[] ppNames, IVariantArray[] ppValues) Queries all available key properties.
java.lang.Object	getBandProperty(java.lang.String sName, int bandIndex) Returns the requested key property by name for a given band.
java.lang.Object	getProperty(java.lang.String sName) Returns the requested key property by name.
void	removeBandProperty(java.lang.String sName, int bandIndex) Removes all occurrences of the specified key property for a given band.
void	removeProperty(java.lang.String sName) Removes all occurrences of the specified key property.
void	setBandProperty(java.lang.String sName, int bandIndex, java.lang.Object vtValue) Updates the value of the specified key property by name for a given band.
void	setProperty(java.lang.String sName, java.lang.Object vtValue) Updates the value of the specified key property by name.

Field Detail

IID01002227_f833_40aa_a0c9_429ea383c51f

static final int IID01002227_f833_40aa_a0c9_429ea383c51f

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getProperty

java.lang.Object getProperty(java.lang.String sName)
                      throws java.io.IOException,
                             AutomationException

Returns the requested key property by name.

Parameters:

sName - The sName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProperty

void setProperty(java.lang.String sName,
                 java.lang.Object vtValue)
          throws java.io.IOException,
                 AutomationException

Updates the value of the specified key property by name.

Parameters:

sName - The sName (in)

vtValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeProperty

void removeProperty(java.lang.String sName)
             throws java.io.IOException,
                    AutomationException

Removes all occurrences of the specified key property.

Parameters:

sName - The sName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllProperties

void getAllProperties(IStringArray[] ppNames,
                      IVariantArray[] ppValues)
               throws java.io.IOException,
                      AutomationException

Queries all available key properties.

Parameters:

ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBandProperty

java.lang.Object getBandProperty(java.lang.String sName,
                                 int bandIndex)
                          throws java.io.IOException,
                                 AutomationException

Returns the requested key property by name for a given band.

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBandProperty

void setBandProperty(java.lang.String sName,
                     int bandIndex,
                     java.lang.Object vtValue)
              throws java.io.IOException,
                     AutomationException

Updates the value of the specified key property by name for a given band.

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

vtValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeBandProperty

void removeBandProperty(java.lang.String sName,
                        int bandIndex)
                 throws java.io.IOException,
                        AutomationException

Removes all occurrences of the specified key property for a given band.

Parameters:

sName - The sName (in)

bandIndex - The bandIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAllBandProperties

void getAllBandProperties(int bandIndex,
                          IStringArray[] ppNames,
                          IVariantArray[] ppValues)
                   throws java.io.IOException,
                          AutomationException

Queries all available band-specific key properties.

Parameters:

bandIndex - The bandIndex (in)

ppNames - A reference to a com.esri.arcgis.system.IStringArray (out: use single element array)

ppValues - A reference to a com.esri.arcgis.system.IVariantArray (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.