com.esri.arcgis.carto
Class RasterDefaultsEnv

java.lang.Object
  com.esri.arcgis.carto.RasterDefaultsEnv

All Implemented Interfaces:

IRasterDefaultsEnv, IRasterDefaultsEnv2, IRasterDefaultsEnv3, IRasterDefaultsEnv4, IRasterDefaultsEnv5, IRasterDefaultsEnv6, IRasterDefaultsEnv7, IRasterDefaultsEnv8, IRasterDefaultsEnv9, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class RasterDefaultsEnv
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterDefaultsEnv, IRasterDefaultsEnv2, IRasterDefaultsEnv3, IRasterDefaultsEnv4, IRasterDefaultsEnv5, IRasterDefaultsEnv6, IRasterDefaultsEnv7, IRasterDefaultsEnv8, IRasterDefaultsEnv9

COM Class 'RasterDefaultsEnv'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'A container for default raster environmental variables.' 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 inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv9

IID, IID55141934_2352_4fa1_9a42_5f13c0b4d9c4, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv8

IIDbcbed4b5_354f_4b65_811e_91d322b2ede7

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv7

IIDd6071d40_e01c_453e_8f3b_a84e0bda0192

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv6

IIDfd9acc55_6a35_4888_b3c8_9604887b2fc3

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv5

IIDaf3085cd_39d4_45e3_93d0_1071cb4527cb

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv4

IID4dcd6e47_90a1_4341_a90b_52ab6df2ffa4

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv3

IIDbbce4f14_f0da_4cbf_8196_0e380b34ccbb

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv2

IIDe5191e5e_4d03_45d9_94a4_9e2d8c5c9aed

Fields inherited from interface com.esri.arcgis.carto.IRasterDefaultsEnv

IIDfb89a39b_c08e_11d2_9f43_00c04f8ed21a

Constructor Summary

RasterDefaultsEnv()
Constructs a RasterDefaultsEnv using ArcGIS Engine.

RasterDefaultsEnv(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterDefaultsEnv theRasterDefaultsEnv = (RasterDefaultsEnv) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
IColor	getBackgroundColor() The color of background.
static java.lang.String	getClsid() getClsid.
IRasterFormatInfo	getFormat(int i) Information about the format indicated by index i.
double	getGammaBlueValue() Gamma blue value.
double	getGammaGreenValue() Gamma green value.
double	getGammaRedValue() Gamma red value.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getMaximumBuildAttributeTableSize() The maximum attribute table size that can be built.
int	getMaximumRastersColorMatching() The maximum number of rasters for color matching.
double	getMaxPercent() The maximum (high) percent value.
int	getMaxTableSize() Default maximum table size.
double	getMinPercent() The minimum (low) percent value.
IColor	getNoDataColor() Nodata color for a raster layer.
int	getNumFormats() Number of supported raster formats.
java.lang.String	getProxyFilePath() Default proxy file path.
int	getPyramidCompressionQuality() pyramid compression quality.
int	getPyramidCompressionType() Pyramid compression type.
int	getPyramidCreateOpt() Default pyramid creation option.
int	getPyramidResamplingMethod() Pyramid resampling method.
int	getRenderingMode() Default rendering mode.
int	getResampling() Default resampling for display.
double	getStandardDeviationsParam() Standard deviation parameter for the stretch renderer.
int	getStretchType() Indicate stretch type.
int	hashCode() the hashcode for this object
boolean	isAskSubdatasetSelection() Indicates if the subdataset selection dialog should pop up.
boolean	isAssumeHomogeneousCatalog() Indicates if raster catalogs can be assumed to be homogeneous.
boolean	isBoundarySubLayerIsVisible() Indicates if the boundary sub-layer of a mosaic layer is visible by default.
boolean	isCreateTiledTIFF() Indicates if newly created TIFF images should be tiled.
boolean	isDisplayBackground() Indicates if a background value is being used.
boolean	isDisplayServiceCacheByDefault() Indicates if raster type service layers is to draw using the service cache by default (if available) when added to an application.
boolean	isDisplayWithContrastStretch() Indicates if displaying raster datasets with contrast stretching as default.
boolean	isFavorWorldFile() Indicates if the world file should overrides the raster dataset internal georeferencing.
boolean	isFootprintSubLayerIsVisible() Indicates if the footprint sub-layer of a mosaic layer is visible by default.
boolean	isMosaicLayerIsExpanded() Indicates if a mosaic layer should be expanded or collapsed by default.
boolean	isPreviewSubLayerIsVisible() Indicates if the preview sub-layer of a mosaic layer is visible by default.
boolean	isRenderingDefaultsEnabled() Indicates if the user specified default settings are to be used for rendering.
boolean	isSeamlineSubLayerIsVisible() Indicates if the seamline sub-layer of a mosaic layer is visible by default.
boolean	isUseBandSpectralInfoForRGBMapping() Indicates if the band's spectral information (if available) is to be used to determine the RGB mapping for rendering multi-band raster datasets.
boolean	isUseExtChecking() Indicates if extension checking is on.
boolean	isUseGamma() Indicates if Gamma stretch should be applied.
void	query3BandRGB(int[] redIndex, int[] greenIndex, int[] blueIndex) Default zero indexed bands for a 3 band raster.
void	query4BandRGB(int[] redIndex, int[] greenIndex, int[] blueIndex) Default zero indexed bands for a 4 or more band raster.
void	queryBackgroundValues(double[] pRed, double[] pGreen, double[] pBlue) background value.
void	release() Release a RasterDefaultsEnv.
void	set3BandRGB(int redIndex, int greenIndex, int blueIndex) Default zero indexed bands for a 3 band raster.
void	set4BandRGB(int redIndex, int greenIndex, int blueIndex) Default zero indexed bands for a 4 or more band raster.
void	setAskSubdatasetSelection(boolean pAsk) Indicates if the subdataset selection dialog should pop up.
void	setAssumeHomogeneousCatalog(boolean pHomogeneous) Indicates if raster catalogs can be assumed to be homogeneous.
void	setBackgroundColor(IColor ppColor) The color of background.
void	setBackgroundValues(double red, double green, double blue) background value.
void	setBoundarySubLayerIsVisible(boolean pIsVisible) Indicates if the boundary sub-layer of a mosaic layer is visible by default.
void	setCreateTiledTIFF(boolean pTiled) Indicates if newly created TIFF images should be tiled.
void	setDisplayBackground(boolean b) Indicates if a background value is being used.
void	setDisplayServiceCacheByDefault(boolean pYes) Indicates if raster type service layers is to draw using the service cache by default (if available) when added to an application.
void	setDisplayWithContrastStretch(boolean pStretch) Indicates if displaying raster datasets with contrast stretching as default.
void	setFavorWorldFile(boolean pFavor) Indicates if the world file should overrides the raster dataset internal georeferencing.
void	setFootprintSubLayerIsVisible(boolean pIsVisible) Indicates if the footprint sub-layer of a mosaic layer is visible by default.
void	setGammaBlueValue(double pBlueGamma) Gamma blue value.
void	setGammaGreenValue(double pGreenGamma) Gamma green value.
void	setGammaRedValue(double pRedGamma) Gamma red value.
void	setMaximumBuildAttributeTableSize(int pSize) The maximum attribute table size that can be built.
void	setMaximumRastersColorMatching(int pSize) The maximum number of rasters for color matching.
void	setMaxPercent(double pPercent) The maximum (high) percent value.
void	setMaxTableSize(int pMaxTableSize) Default maximum table size.
void	setMinPercent(double pPercent) The minimum (low) percent value.
void	setMosaicLayerIsExpanded(boolean pIsExpanded) Indicates if a mosaic layer should be expanded or collapsed by default.
void	setNoDataColor(IColor ppColor) Nodata color for a raster layer.
void	setPreviewSubLayerIsVisible(boolean pIsVisible) Indicates if the preview sub-layer of a mosaic layer is visible by default.
void	setProxyFilePath(java.lang.String pProxyFilePath) Default proxy file path.
void	setPyramidCompressionQuality(int quality) pyramid compression quality.
void	setPyramidCompressionType(int compressionType) Pyramid compression type.
void	setPyramidCreateOpt(int opt) Default pyramid creation option.
void	setPyramidResamplingMethod(int pYes) Pyramid resampling method.
void	setRenderingDefaultsEnabled(boolean pYes) Indicates if the user specified default settings are to be used for rendering.
void	setRenderingMode(int pRenderingMode) Default rendering mode.
void	setResampling(int pDefaultResampling) Default resampling for display.
void	setSeamlineSubLayerIsVisible(boolean pIsVisible) Indicates if the seamline sub-layer of a mosaic layer is visible by default.
void	setStandardDeviationsParam(double param) Standard deviation parameter for the stretch renderer.
void	setStretchType(int en_stretch) Indicate stretch type.
void	setUseBandSpectralInfoForRGBMapping(boolean pYes) Indicates if the band's spectral information (if available) is to be used to determine the RGB mapping for rendering multi-band raster datasets.
void	setUseExtChecking(boolean useExts) Indicates if extension checking is on.
void	setUseGamma(boolean pUseGamma) Indicates if Gamma stretch should be applied.
void	updateAll() Updates the registry with all changes to the raster environment in the current session.

Methods inherited from class java.lang.Object

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

Constructor Detail

RasterDefaultsEnv

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

Constructs a RasterDefaultsEnv using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

RasterDefaultsEnv

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

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

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

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

Deprecated. Internal use only.

Specified by:

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

release

public void release()

Release a RasterDefaultsEnv.

Specified by:

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

getPyramidCreateOpt

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

Default pyramid creation option.

Specified by:

getPyramidCreateOpt in interface IRasterDefaultsEnv

Returns:

A com.esri.arcgis.carto.esriRasterPyramidOptEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidCreateOpt

public void setPyramidCreateOpt(int opt)
                         throws java.io.IOException,
                                AutomationException

Default pyramid creation option.

Specified by:

setPyramidCreateOpt in interface IRasterDefaultsEnv

Parameters:

opt - A com.esri.arcgis.carto.esriRasterPyramidOptEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

query3BandRGB

public void query3BandRGB(int[] redIndex,
                          int[] greenIndex,
                          int[] blueIndex)
                   throws java.io.IOException,
                          AutomationException

Default zero indexed bands for a 3 band raster.

Specified by:

query3BandRGB in interface IRasterDefaultsEnv

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

set3BandRGB

public void set3BandRGB(int redIndex,
                        int greenIndex,
                        int blueIndex)
                 throws java.io.IOException,
                        AutomationException

Default zero indexed bands for a 3 band raster.

Specified by:

set3BandRGB in interface IRasterDefaultsEnv

Parameters:

redIndex - The redIndex (in)

greenIndex - The greenIndex (in)

blueIndex - The blueIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

query4BandRGB

public void query4BandRGB(int[] redIndex,
                          int[] greenIndex,
                          int[] blueIndex)
                   throws java.io.IOException,
                          AutomationException

Default zero indexed bands for a 4 or more band raster.

Specified by:

query4BandRGB in interface IRasterDefaultsEnv

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

set4BandRGB

public void set4BandRGB(int redIndex,
                        int greenIndex,
                        int blueIndex)
                 throws java.io.IOException,
                        AutomationException

Default zero indexed bands for a 4 or more band raster.

Specified by:

set4BandRGB in interface IRasterDefaultsEnv

Parameters:

redIndex - The redIndex (in)

greenIndex - The greenIndex (in)

blueIndex - The blueIndex (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseExtChecking

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

Indicates if extension checking is on.

Specified by:

isUseExtChecking in interface IRasterDefaultsEnv

Returns:

The useExts

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseExtChecking

public void setUseExtChecking(boolean useExts)
                       throws java.io.IOException,
                              AutomationException

Indicates if extension checking is on.

Specified by:

setUseExtChecking in interface IRasterDefaultsEnv

Parameters:

useExts - The useExts (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumFormats

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

Number of supported raster formats.

Specified by:

getNumFormats in interface IRasterDefaultsEnv

Returns:

The pNumFormats

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormat

public IRasterFormatInfo getFormat(int i)
                            throws java.io.IOException,
                                   AutomationException

Information about the format indicated by index i.

Specified by:

getFormat in interface IRasterDefaultsEnv

Parameters:

i - The i (in)

Returns:

A reference to a com.esri.arcgis.carto.IRasterFormatInfo

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRenderingMode

public void setRenderingMode(int pRenderingMode)
                      throws java.io.IOException,
                             AutomationException

Default rendering mode.

Specified by:

setRenderingMode in interface IRasterDefaultsEnv2

Parameters:

pRenderingMode - A com.esri.arcgis.carto.esriRasterRenderingModeEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRenderingMode

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

Default rendering mode.

Specified by:

getRenderingMode in interface IRasterDefaultsEnv2

Returns:

A com.esri.arcgis.carto.esriRasterRenderingModeEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResampling

public void setResampling(int pDefaultResampling)
                   throws java.io.IOException,
                          AutomationException

Default resampling for display.

Specified by:

setResampling in interface IRasterDefaultsEnv2

Parameters:

pDefaultResampling - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getResampling

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

Default resampling for display.

Specified by:

getResampling in interface IRasterDefaultsEnv2

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProxyFilePath

public void setProxyFilePath(java.lang.String pProxyFilePath)
                      throws java.io.IOException,
                             AutomationException

Default proxy file path.

Specified by:

setProxyFilePath in interface IRasterDefaultsEnv2

Parameters:

pProxyFilePath - The pProxyFilePath (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProxyFilePath

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

Default proxy file path.

Specified by:

getProxyFilePath in interface IRasterDefaultsEnv2

Returns:

The pProxyFilePath

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxTableSize

public void setMaxTableSize(int pMaxTableSize)
                     throws java.io.IOException,
                            AutomationException

Default maximum table size.

Specified by:

setMaxTableSize in interface IRasterDefaultsEnv2

Parameters:

pMaxTableSize - The pMaxTableSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxTableSize

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

Default maximum table size.

Specified by:

getMaxTableSize in interface IRasterDefaultsEnv2

Returns:

The pMaxTableSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateAll

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

Updates the registry with all changes to the raster environment in the current session.

Specified by:

updateAll in interface IRasterDefaultsEnv2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumBuildAttributeTableSize

public void setMaximumBuildAttributeTableSize(int pSize)
                                       throws java.io.IOException,
                                              AutomationException

The maximum attribute table size that can be built.

Specified by:

setMaximumBuildAttributeTableSize in interface IRasterDefaultsEnv3

Parameters:

pSize - The pSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumBuildAttributeTableSize

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

The maximum attribute table size that can be built.

Specified by:

getMaximumBuildAttributeTableSize in interface IRasterDefaultsEnv3

Returns:

The pSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFavorWorldFile

public void setFavorWorldFile(boolean pFavor)
                       throws java.io.IOException,
                              AutomationException

Indicates if the world file should overrides the raster dataset internal georeferencing.

Specified by:

setFavorWorldFile in interface IRasterDefaultsEnv3

Parameters:

pFavor - The pFavor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFavorWorldFile

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

Indicates if the world file should overrides the raster dataset internal georeferencing.

Specified by:

isFavorWorldFile in interface IRasterDefaultsEnv3

Returns:

The pFavor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAssumeHomogeneousCatalog

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

Indicates if raster catalogs can be assumed to be homogeneous.

Specified by:

isAssumeHomogeneousCatalog in interface IRasterDefaultsEnv3

Returns:

The pHomogeneous

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAssumeHomogeneousCatalog

public void setAssumeHomogeneousCatalog(boolean pHomogeneous)
                                 throws java.io.IOException,
                                        AutomationException

Indicates if raster catalogs can be assumed to be homogeneous.

Specified by:

setAssumeHomogeneousCatalog in interface IRasterDefaultsEnv3

Parameters:

pHomogeneous - The pHomogeneous (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAskSubdatasetSelection

public void setAskSubdatasetSelection(boolean pAsk)
                               throws java.io.IOException,
                                      AutomationException

Indicates if the subdataset selection dialog should pop up.

Specified by:

setAskSubdatasetSelection in interface IRasterDefaultsEnv4

Parameters:

pAsk - The pAsk (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAskSubdatasetSelection

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

Indicates if the subdataset selection dialog should pop up.

Specified by:

isAskSubdatasetSelection in interface IRasterDefaultsEnv4

Returns:

The pAsk

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayWithContrastStretch

public void setDisplayWithContrastStretch(boolean pStretch)
                                   throws java.io.IOException,
                                          AutomationException

Indicates if displaying raster datasets with contrast stretching as default.

Specified by:

setDisplayWithContrastStretch in interface IRasterDefaultsEnv4

Parameters:

pStretch - The pStretch (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayWithContrastStretch

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

Indicates if displaying raster datasets with contrast stretching as default.

Specified by:

isDisplayWithContrastStretch in interface IRasterDefaultsEnv4

Returns:

The pStretch

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaximumRastersColorMatching

public void setMaximumRastersColorMatching(int pSize)
                                    throws java.io.IOException,
                                           AutomationException

The maximum number of rasters for color matching.

Specified by:

setMaximumRastersColorMatching in interface IRasterDefaultsEnv4

Parameters:

pSize - The pSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaximumRastersColorMatching

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

The maximum number of rasters for color matching.

Specified by:

getMaximumRastersColorMatching in interface IRasterDefaultsEnv4

Returns:

The pSize

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayBackground

public void setDisplayBackground(boolean b)
                          throws java.io.IOException,
                                 AutomationException

Indicates if a background value is being used.

Specified by:

setDisplayBackground in interface IRasterDefaultsEnv5

Parameters:

b - The b (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayBackground

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

Indicates if a background value is being used.

Specified by:

isDisplayBackground in interface IRasterDefaultsEnv5

Returns:

The b

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryBackgroundValues

public void queryBackgroundValues(double[] pRed,
                                  double[] pGreen,
                                  double[] pBlue)
                           throws java.io.IOException,
                                  AutomationException

background value.

Specified by:

queryBackgroundValues in interface IRasterDefaultsEnv5

Parameters:

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundValues

public void setBackgroundValues(double red,
                                double green,
                                double blue)
                         throws java.io.IOException,
                                AutomationException

background value.

Specified by:

setBackgroundValues in interface IRasterDefaultsEnv5

Parameters:

red - The red (in)

green - The green (in)

blue - The blue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBackgroundColor

public IColor getBackgroundColor()
                          throws java.io.IOException,
                                 AutomationException

The color of background.

Specified by:

getBackgroundColor in interface IRasterDefaultsEnv5

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBackgroundColor

public void setBackgroundColor(IColor ppColor)
                        throws java.io.IOException,
                               AutomationException

The color of background.

Specified by:

setBackgroundColor in interface IRasterDefaultsEnv5

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNoDataColor

public IColor getNoDataColor()
                      throws java.io.IOException,
                             AutomationException

Nodata color for a raster layer.

Specified by:

getNoDataColor in interface IRasterDefaultsEnv5

Returns:

A reference to a com.esri.arcgis.display.IColor

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNoDataColor

public void setNoDataColor(IColor ppColor)
                    throws java.io.IOException,
                           AutomationException

Nodata color for a raster layer.

Specified by:

setNoDataColor in interface IRasterDefaultsEnv5

Parameters:

ppColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCreateTiledTIFF

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

Indicates if newly created TIFF images should be tiled.

Specified by:

isCreateTiledTIFF in interface IRasterDefaultsEnv5

Returns:

The pTiled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCreateTiledTIFF

public void setCreateTiledTIFF(boolean pTiled)
                        throws java.io.IOException,
                               AutomationException

Indicates if newly created TIFF images should be tiled.

Specified by:

setCreateTiledTIFF in interface IRasterDefaultsEnv5

Parameters:

pTiled - The pTiled (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMosaicLayerIsExpanded

public void setMosaicLayerIsExpanded(boolean pIsExpanded)
                              throws java.io.IOException,
                                     AutomationException

Indicates if a mosaic layer should be expanded or collapsed by default.

Specified by:

setMosaicLayerIsExpanded in interface IRasterDefaultsEnv6

Parameters:

pIsExpanded - The pIsExpanded (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isMosaicLayerIsExpanded

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

Indicates if a mosaic layer should be expanded or collapsed by default.

Specified by:

isMosaicLayerIsExpanded in interface IRasterDefaultsEnv6

Returns:

The pIsExpanded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBoundarySubLayerIsVisible

public void setBoundarySubLayerIsVisible(boolean pIsVisible)
                                  throws java.io.IOException,
                                         AutomationException

Indicates if the boundary sub-layer of a mosaic layer is visible by default.

Specified by:

setBoundarySubLayerIsVisible in interface IRasterDefaultsEnv6

Parameters:

pIsVisible - The pIsVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBoundarySubLayerIsVisible

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

Indicates if the boundary sub-layer of a mosaic layer is visible by default.

Specified by:

isBoundarySubLayerIsVisible in interface IRasterDefaultsEnv6

Returns:

The pIsVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFootprintSubLayerIsVisible

public void setFootprintSubLayerIsVisible(boolean pIsVisible)
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the footprint sub-layer of a mosaic layer is visible by default.

Specified by:

setFootprintSubLayerIsVisible in interface IRasterDefaultsEnv6

Parameters:

pIsVisible - The pIsVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFootprintSubLayerIsVisible

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

Indicates if the footprint sub-layer of a mosaic layer is visible by default.

Specified by:

isFootprintSubLayerIsVisible in interface IRasterDefaultsEnv6

Returns:

The pIsVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPreviewSubLayerIsVisible

public void setPreviewSubLayerIsVisible(boolean pIsVisible)
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the preview sub-layer of a mosaic layer is visible by default.

Specified by:

setPreviewSubLayerIsVisible in interface IRasterDefaultsEnv6

Parameters:

pIsVisible - The pIsVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPreviewSubLayerIsVisible

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

Indicates if the preview sub-layer of a mosaic layer is visible by default.

Specified by:

isPreviewSubLayerIsVisible in interface IRasterDefaultsEnv6

Returns:

The pIsVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSeamlineSubLayerIsVisible

public void setSeamlineSubLayerIsVisible(boolean pIsVisible)
                                  throws java.io.IOException,
                                         AutomationException

Indicates if the seamline sub-layer of a mosaic layer is visible by default.

Specified by:

setSeamlineSubLayerIsVisible in interface IRasterDefaultsEnv6

Parameters:

pIsVisible - The pIsVisible (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSeamlineSubLayerIsVisible

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

Indicates if the seamline sub-layer of a mosaic layer is visible by default.

Specified by:

isSeamlineSubLayerIsVisible in interface IRasterDefaultsEnv6

Returns:

The pIsVisible

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStretchType

public void setStretchType(int en_stretch)
                    throws java.io.IOException,
                           AutomationException

Indicate stretch type.

Specified by:

setStretchType in interface IRasterDefaultsEnv7

Parameters:

en_stretch - A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStretchType

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

Indicate stretch type.

Specified by:

getStretchType in interface IRasterDefaultsEnv7

Returns:

A com.esri.arcgis.carto.esriRasterStretchTypesEnum constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setStandardDeviationsParam

public void setStandardDeviationsParam(double param)
                                throws java.io.IOException,
                                       AutomationException

Standard deviation parameter for the stretch renderer.

Specified by:

setStandardDeviationsParam in interface IRasterDefaultsEnv7

Parameters:

param - The param (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getStandardDeviationsParam

public double getStandardDeviationsParam()
                                  throws java.io.IOException,
                                         AutomationException

Standard deviation parameter for the stretch renderer.

Specified by:

getStandardDeviationsParam in interface IRasterDefaultsEnv7

Returns:

The param

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseGamma

public void setUseGamma(boolean pUseGamma)
                 throws java.io.IOException,
                        AutomationException

Indicates if Gamma stretch should be applied.

Specified by:

setUseGamma in interface IRasterDefaultsEnv7

Parameters:

pUseGamma - The pUseGamma (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseGamma

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

Indicates if Gamma stretch should be applied.

Specified by:

isUseGamma in interface IRasterDefaultsEnv7

Returns:

The pUseGamma

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGammaRedValue

public void setGammaRedValue(double pRedGamma)
                      throws java.io.IOException,
                             AutomationException

Gamma red value.

Specified by:

setGammaRedValue in interface IRasterDefaultsEnv7

Parameters:

pRedGamma - The pRedGamma (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGammaRedValue

public double getGammaRedValue()
                        throws java.io.IOException,
                               AutomationException

Gamma red value.

Specified by:

getGammaRedValue in interface IRasterDefaultsEnv7

Returns:

The pRedGamma

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGammaGreenValue

public void setGammaGreenValue(double pGreenGamma)
                        throws java.io.IOException,
                               AutomationException

Gamma green value.

Specified by:

setGammaGreenValue in interface IRasterDefaultsEnv7

Parameters:

pGreenGamma - The pGreenGamma (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGammaGreenValue

public double getGammaGreenValue()
                          throws java.io.IOException,
                                 AutomationException

Gamma green value.

Specified by:

getGammaGreenValue in interface IRasterDefaultsEnv7

Returns:

The pGreenGamma

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setGammaBlueValue

public void setGammaBlueValue(double pBlueGamma)
                       throws java.io.IOException,
                              AutomationException

Gamma blue value.

Specified by:

setGammaBlueValue in interface IRasterDefaultsEnv7

Parameters:

pBlueGamma - The pBlueGamma (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getGammaBlueValue

public double getGammaBlueValue()
                         throws java.io.IOException,
                                AutomationException

Gamma blue value.

Specified by:

getGammaBlueValue in interface IRasterDefaultsEnv7

Returns:

The pBlueGamma

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMinPercent

public void setMinPercent(double pPercent)
                   throws java.io.IOException,
                          AutomationException

The minimum (low) percent value.

Specified by:

setMinPercent in interface IRasterDefaultsEnv7

Parameters:

pPercent - The pPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinPercent

public double getMinPercent()
                     throws java.io.IOException,
                            AutomationException

The minimum (low) percent value.

Specified by:

getMinPercent in interface IRasterDefaultsEnv7

Returns:

The pPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxPercent

public void setMaxPercent(double pPercent)
                   throws java.io.IOException,
                          AutomationException

The maximum (high) percent value.

Specified by:

setMaxPercent in interface IRasterDefaultsEnv7

Parameters:

pPercent - The pPercent (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxPercent

public double getMaxPercent()
                     throws java.io.IOException,
                            AutomationException

The maximum (high) percent value.

Specified by:

getMaxPercent in interface IRasterDefaultsEnv7

Returns:

The pPercent

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRenderingDefaultsEnabled

public void setRenderingDefaultsEnabled(boolean pYes)
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the user specified default settings are to be used for rendering.

Specified by:

setRenderingDefaultsEnabled in interface IRasterDefaultsEnv8

Parameters:

pYes - The pYes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRenderingDefaultsEnabled

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

Indicates if the user specified default settings are to be used for rendering.

Specified by:

isRenderingDefaultsEnabled in interface IRasterDefaultsEnv8

Returns:

The pYes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseBandSpectralInfoForRGBMapping

public void setUseBandSpectralInfoForRGBMapping(boolean pYes)
                                         throws java.io.IOException,
                                                AutomationException

Indicates if the band's spectral information (if available) is to be used to determine the RGB mapping for rendering multi-band raster datasets.

Specified by:

setUseBandSpectralInfoForRGBMapping in interface IRasterDefaultsEnv8

Parameters:

pYes - The pYes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseBandSpectralInfoForRGBMapping

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

Indicates if the band's spectral information (if available) is to be used to determine the RGB mapping for rendering multi-band raster datasets.

Specified by:

isUseBandSpectralInfoForRGBMapping in interface IRasterDefaultsEnv8

Returns:

The pYes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDisplayServiceCacheByDefault

public void setDisplayServiceCacheByDefault(boolean pYes)
                                     throws java.io.IOException,
                                            AutomationException

Indicates if raster type service layers is to draw using the service cache by default (if available) when added to an application.

Specified by:

setDisplayServiceCacheByDefault in interface IRasterDefaultsEnv8

Parameters:

pYes - The pYes (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDisplayServiceCacheByDefault

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

Indicates if raster type service layers is to draw using the service cache by default (if available) when added to an application.

Specified by:

isDisplayServiceCacheByDefault in interface IRasterDefaultsEnv8

Returns:

The pYes

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidResamplingMethod

public void setPyramidResamplingMethod(int pYes)
                                throws java.io.IOException,
                                       AutomationException

Pyramid resampling method.

Specified by:

setPyramidResamplingMethod in interface IRasterDefaultsEnv9

Parameters:

pYes - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPyramidResamplingMethod

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

Pyramid resampling method.

Specified by:

getPyramidResamplingMethod in interface IRasterDefaultsEnv9

Returns:

A com.esri.arcgis.geodatabase.rstResamplingTypes constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidCompressionType

public void setPyramidCompressionType(int compressionType)
                               throws java.io.IOException,
                                      AutomationException

Pyramid compression type.

Specified by:

setPyramidCompressionType in interface IRasterDefaultsEnv9

Parameters:

compressionType - A com.esri.arcgis.geodatabase.esriRasterCompressionType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPyramidCompressionType

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

Pyramid compression type.

Specified by:

getPyramidCompressionType in interface IRasterDefaultsEnv9

Returns:

A com.esri.arcgis.geodatabase.esriRasterCompressionType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPyramidCompressionQuality

public void setPyramidCompressionQuality(int quality)
                                  throws java.io.IOException,
                                         AutomationException

pyramid compression quality.

Specified by:

setPyramidCompressionQuality in interface IRasterDefaultsEnv9

Parameters:

quality - The quality (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPyramidCompressionQuality

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

pyramid compression quality.

Specified by:

getPyramidCompressionQuality in interface IRasterDefaultsEnv9

Returns:

The quality

Throws:

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

AutomationException - If the ArcObject component throws an exception.