com.esri.arcgis.carto
Class RasterFormatInfo

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

All Implemented Interfaces:

IRasterFormatInfo, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RasterFormatInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRasterFormatInfo

Information about raster file formats.

Description

The RasterFormatInfo object provides a way to view and set ArcMap and ArcCatalog browsing properties for specific raster formats.

The RasterFormatInfo object can be retrieved from IRasterDefaultsEnv::Format property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

RasterFormatInfo(Object obj)
Construct a RasterFormatInfo using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(Object o) Compare this object with another
String	getDefaultExts() Default format extensions.
String	getFormatName() Format name.
int	hashCode() the hashcode for this object
boolean	isActiveBrowse() Indicates whether all files are searched for valid raster formats.
void	setActiveBrowse(boolean pOpt) Indicates whether all files are searched for valid raster formats.
void	setDefaultExts(String ext) Default format extensions.
void	setFormatName(String name) Format name.

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

RasterFormatInfo

public RasterFormatInfo(Object obj)
                 throws IOException

Construct a RasterFormatInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to RasterFormatInfo.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
RasterFormatInfo o = (RasterFormatInfo)obj; // will not work

RasterFormatInfo o = new RasterFormatInfo(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems RasterFormatInfo theRasterFormatInfo = (RasterFormatInfo) obj;

Method Detail

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

isActiveBrowse

public boolean isActiveBrowse()
                       throws IOException,
                              AutomationException

Indicates whether all files are searched for valid raster formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isActiveBrowse in interface IRasterFormatInfo

Returns:

The pOpt

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActiveBrowse

public void setActiveBrowse(boolean pOpt)
                     throws IOException,
                            AutomationException

Indicates whether all files are searched for valid raster formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setActiveBrowse in interface IRasterFormatInfo

Parameters:

pOpt - The pOpt (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFormatName

public String getFormatName()
                     throws IOException,
                            AutomationException

Format name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getFormatName in interface IRasterFormatInfo

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFormatName

public void setFormatName(String name)
                   throws IOException,
                          AutomationException

Format name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setFormatName in interface IRasterFormatInfo

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultExts

public String getDefaultExts()
                      throws IOException,
                             AutomationException

Default format extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getDefaultExts in interface IRasterFormatInfo

Returns:

The ext

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultExts

public void setDefaultExts(String ext)
                    throws IOException,
                           AutomationException

Default format extensions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setDefaultExts in interface IRasterFormatInfo

Parameters:

ext - The ext (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.