com.esri.arcgis.carto
Class RasterDefaultsEnv

java.lang.Object
  extended by com.esri.arcgis.carto.RasterDefaultsEnv
All Implemented Interfaces:
IRasterDefaultsEnv, IRasterDefaultsEnv2, IRasterDefaultsEnv3, IRasterDefaultsEnv4, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterDefaultsEnv
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterDefaultsEnv, IRasterDefaultsEnv2, IRasterDefaultsEnv3, IRasterDefaultsEnv4

A container for default raster environmental variables.

Description

The RasterDefaultsEnv object allows you to customize raster default behavior in the ArcGIS user interface.

 

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Singleton:

This type is a singleton.

See Also:
Serialized Form

Constructor Summary
RasterDefaultsEnv()
          Constructs a RasterDefaultsEnv using ArcGIS Engine.
RasterDefaultsEnv(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RasterDefaultsEnv theRasterDefaultsEnv = (RasterDefaultsEnv) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 IRasterFormatInfo getFormat(int i)
          Information about the format indicated by index i.
 int getMaximumBuildAttributeTableSize()
          The maximum attribute table size that can be built.
 int getMaximumRastersColorMatching()
          The maximum number of rasters for color matching.
 int getMaxTableSize()
          Default maximum table size.
 int getNumFormats()
          Number of supported raster formats.
 String getProxyFilePath()
          Default proxy file path.
 int getPyramidCreateOpt()
          Default pyramid creation option.
 int getRenderingMode()
          Default rendering mode.
 int getResampling()
          Default resampling for display.
 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 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 isUseExtChecking()
          Indicates if extension checking is on.
 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 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 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 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 setMaxTableSize(int pMaxTableSize)
          Default maximum table size.
 void setProxyFilePath(String pProxyFilePath)
          Default proxy file path.
 void setPyramidCreateOpt(int opt)
          Default pyramid creation option.
 void setRenderingMode(int pRenderingMode)
          Default rendering mode.
 void setResampling(int pDefaultResampling)
          Default resampling for display.
 void setUseExtChecking(boolean useExts)
          Indicates if extension checking is on.
 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
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

RasterDefaultsEnv

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

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

RasterDefaultsEnv

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

getPyramidCreateOpt

public int getPyramidCreateOpt()
                        throws IOException,
                               AutomationException
Default pyramid creation option.

Description

The PyramidCreateOpt property is used to set the pyramid options for displaying a large raster dataset, which has a dimension greater than 1024 and does not have pyramids, in ArcCatalog or ArcMap.
Pyramids is used to enhance display performance. For displaying raster datasets that do not have pyramids, ArcMap provides the following options: always build pyramids, never build pyramids, prompt a dialog box asking to build or not.
This method does not control pyramid building when you save as a raster dataset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPyramidCreateOpt in interface IRasterDefaultsEnv
Returns:
A com.esri.arcgis.carto.esriRasterPyramidOptEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPyramidCreateOpt

public void setPyramidCreateOpt(int opt)
                         throws IOException,
                                AutomationException
Default pyramid creation option.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setPyramidCreateOpt in interface IRasterDefaultsEnv
Parameters:
opt - A com.esri.arcgis.carto.esriRasterPyramidOptEnum constant (in)
Throws:
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 IOException,
                          AutomationException
Default zero indexed bands for a 3 band raster.

Remarks

The Query3BandRGB, Query4BandRGB, Set3BandRGB, and Set4BandRGB methods allow you to view or set the default band combinations used to display rasters with three or more bands. The indices set for these defaults will populate the red, green, and blue channels of the RGB renderer when a raster is initially displayed.

The Query3BandRGB and Set3BandRGB methods apply only to three band rasters, while the Query4BandRGB and Set4BandRGB methods apply to all rasters containing four or more bands.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                        AutomationException
Default zero indexed bands for a 3 band raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
set3BandRGB in interface IRasterDefaultsEnv
Parameters:
redIndex - The redIndex (in)
greenIndex - The greenIndex (in)
blueIndex - The blueIndex (in)
Throws:
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 IOException,
                          AutomationException
Default zero indexed bands for a 4 or more band raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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:
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 IOException,
                        AutomationException
Default zero indexed bands for a 4 or more band raster.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
set4BandRGB in interface IRasterDefaultsEnv
Parameters:
redIndex - The redIndex (in)
greenIndex - The greenIndex (in)
blueIndex - The blueIndex (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseExtChecking

public boolean isUseExtChecking()
                         throws IOException,
                                AutomationException
Indicates if extension checking is on.

Description

This method is used to specify whether using file extension checking or not when you browse file based raster data such as .img, .tif, and jp2 etc.

Using file extension checking (true) is faster in browsing raster datasets, and this is the default.

Remarks

The UseExtChecking property specifies how ArcCatalog and the GxBrowser search for raster datasets. A True value for extension checking means that files or folders will be identified as raster datasets only if their extension matches the list of supported raster format extensions. A False value means that all files and folders will be opened to determine whether they are a raster dataset in any of the supported raster formats. This is more reliable but is much slower than extension checking only. Extension checking only is the default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isUseExtChecking in interface IRasterDefaultsEnv
Returns:
The useExts
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseExtChecking

public void setUseExtChecking(boolean useExts)
                       throws IOException,
                              AutomationException
Indicates if extension checking is on.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getNumFormats

public int getNumFormats()
                  throws IOException,
                         AutomationException
Number of supported raster formats.

Remarks

The NumFormats property returns the number of supported raster formats, and the Format method returns a RasterFormatInfo object specific to one raster format, which can specify default properties for that format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getNumFormats in interface IRasterDefaultsEnv
Returns:
The pNumFormats
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFormat

public IRasterFormatInfo getFormat(int i)
                            throws IOException,
                                   AutomationException
Information about the format indicated by index i.

Product Availability

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

Specified by:
getFormat in interface IRasterDefaultsEnv
Parameters:
i - The i (in)
Returns:
A reference to a com.esri.arcgis.carto.IRasterFormatInfo
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRenderingMode

public void setRenderingMode(int pRenderingMode)
                      throws IOException,
                             AutomationException
Default rendering mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setRenderingMode in interface IRasterDefaultsEnv2
Parameters:
pRenderingMode - A com.esri.arcgis.carto.esriRasterRenderingModeEnum constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRenderingMode

public int getRenderingMode()
                     throws IOException,
                            AutomationException
Default rendering mode.

Description

The RenderingMode property specifies the drawing mode used when displaying a raster dataset. The full option waits until the entire raster has been drawn to a backing store, then displays it to the screen at once.

Block mode draws the raster one block at a time, starting at the upper left and progressing left to right and then down. Top-to-bottom mode begins at the top and draws a few lines at a time as it progresses down the screen.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getRenderingMode in interface IRasterDefaultsEnv2
Returns:
A com.esri.arcgis.carto.esriRasterRenderingModeEnum constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setResampling

public void setResampling(int pDefaultResampling)
                   throws IOException,
                          AutomationException
Default resampling for display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setResampling in interface IRasterDefaultsEnv2
Parameters:
pDefaultResampling - A com.esri.arcgis.geodatabase.rstResamplingTypes constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getResampling

public int getResampling()
                  throws IOException,
                         AutomationException
Default resampling for display.

Description

The Resampling property controls the default resampling technique used when a raster is first displayed. Single-band rasters are displayed using the stretched renderer or unique value renderer by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getResampling in interface IRasterDefaultsEnv2
Returns:
A com.esri.arcgis.geodatabase.rstResamplingTypes constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProxyFilePath

public void setProxyFilePath(String pProxyFilePath)
                      throws IOException,
                             AutomationException
Default proxy file path.

Remarks

The ProxyFilePath property controls the directory location where these proxy files, as well as any auxiliary or pyramid files for these datasets, are located. This property can only be set by users with Administrator access to their computer. The rest of these properties control the appearance of raster datasets when first viewed in ArcGIS.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getProxyFilePath

public String getProxyFilePath()
                        throws IOException,
                               AutomationException
Default proxy file path.

Remarks

This method is used to set the path for proxy files, e.g. files generated in the local proxy folder when accessing read only raster datasets. This applies to ArcGIS 9.1 and older version only.

ArcGIS 9.2 always use Windows system default temp folder for writting proxy files.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getProxyFilePath in interface IRasterDefaultsEnv2
Returns:
The pProxyFilePath
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxTableSize

public void setMaxTableSize(int pMaxTableSize)
                     throws IOException,
                            AutomationException
Default maximum table size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaxTableSize

public int getMaxTableSize()
                    throws IOException,
                           AutomationException
Default maximum table size.

Remarks

If a dataset has more entries in its table then the MaxTableSize property, it will be displayed by default using the stretched renderer. A dataset with fewer unique values than this threshold will display using the unique value renderer. This value is 25 by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaxTableSize in interface IRasterDefaultsEnv2
Returns:
The pMaxTableSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

updateAll

public void updateAll()
               throws IOException,
                      AutomationException
Updates the registry with all changes to the raster environment in the current session.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setMaximumBuildAttributeTableSize

public void setMaximumBuildAttributeTableSize(int pSize)
                                       throws IOException,
                                              AutomationException
The maximum attribute table size that can be built.

Product Availability

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

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

getMaximumBuildAttributeTableSize

public int getMaximumBuildAttributeTableSize()
                                      throws IOException,
                                             AutomationException
The maximum attribute table size that can be built.

Remarks

This property specifies the maximum limit for building a raster attribute table. The default is 65536.

Product Availability

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

Specified by:
getMaximumBuildAttributeTableSize in interface IRasterDefaultsEnv3
Returns:
The pSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFavorWorldFile

public void setFavorWorldFile(boolean pFavor)
                       throws IOException,
                              AutomationException
Indicates if the world file should overrides the raster dataset internal georeferencing.

Product Availability

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

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

isFavorWorldFile

public boolean isFavorWorldFile()
                         throws IOException,
                                AutomationException
Indicates if the world file should overrides the raster dataset internal georeferencing.

Remarks

By default (returns as false), ArcGIS will read the internal spatial reference (map extent or projection info) of a raster dataset. If you want ArcGIS reads the world file of the raster dataset, set it to be true.

Product Availability

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

Specified by:
isFavorWorldFile in interface IRasterDefaultsEnv3
Returns:
The pFavor
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAssumeHomogeneousCatalog

public boolean isAssumeHomogeneousCatalog()
                                   throws IOException,
                                          AutomationException
Indicates if raster catalogs can be assumed to be homogeneous.

Product Availability

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

Specified by:
isAssumeHomogeneousCatalog in interface IRasterDefaultsEnv3
Returns:
The pHomogeneous
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAssumeHomogeneousCatalog

public void setAssumeHomogeneousCatalog(boolean pHomogeneous)
                                 throws IOException,
                                        AutomationException
Indicates if raster catalogs can be assumed to be homogeneous.

Product Availability

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

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

setAskSubdatasetSelection

public void setAskSubdatasetSelection(boolean pAsk)
                               throws IOException,
                                      AutomationException
Indicates if the subdataset selection dialog should pop up.

Product Availability

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

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

isAskSubdatasetSelection

public boolean isAskSubdatasetSelection()
                                 throws IOException,
                                        AutomationException
Indicates if the subdataset selection dialog should pop up.

Product Availability

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

Specified by:
isAskSubdatasetSelection in interface IRasterDefaultsEnv4
Returns:
The pAsk
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayWithContrastStretch

public void setDisplayWithContrastStretch(boolean pStretch)
                                   throws IOException,
                                          AutomationException
Indicates if displaying raster datasets with contrast stretching as default.

Product Availability

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

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

isDisplayWithContrastStretch

public boolean isDisplayWithContrastStretch()
                                     throws IOException,
                                            AutomationException
Indicates if displaying raster datasets with contrast stretching as default.

Product Availability

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

Specified by:
isDisplayWithContrastStretch in interface IRasterDefaultsEnv4
Returns:
The pStretch
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumRastersColorMatching

public void setMaximumRastersColorMatching(int pSize)
                                    throws IOException,
                                           AutomationException
The maximum number of rasters for color matching.

Product Availability

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

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

getMaximumRastersColorMatching

public int getMaximumRastersColorMatching()
                                   throws IOException,
                                          AutomationException
The maximum number of rasters for color matching.

Product Availability

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

Specified by:
getMaximumRastersColorMatching in interface IRasterDefaultsEnv4
Returns:
The pSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.