com.esri.arcgis.datasourcesraster
Interface IFormatData

All Superinterfaces:
Serializable
All Known Implementing Classes:
FormatList

public interface IFormatData
extends Serializable

Provides access to members that provide access to information about specific raster formats.

Description

The Creatable property indicates whether or not new raster datasets in
this format can be created. GRID, TIFF, and IMAGINE are creatable raster formats.

The Directory property returns whether raster datasets in this format are directory-based (like GRID) or file-based.

The Pseudo property determines whether the file extension can be reliably used to detect raster datasets of this format. Any format that has Pseudo set to True will not be viewable in ArcGIS.

The format name and default extension, if any, associated with the format and the title of the format in the ArcMap and ArcCatalog interface are also accessible through this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getExtension()
          Default extension (without the dot).
 int getOrder()
          Order to display in UI.
 String getShortName()
          Name used for icon registration.
 String getTempl()
          Wildcard string for file matching.
 String getTitle()
          Implementor name of format.
 String getUITitle()
          User legible name of format.
 boolean isCreatable()
          Indicates whether this format supports 'SaveAs'.
 boolean isDirectory()
          Indicates whether this format is directory based, as opposed to file based.
 boolean isPseudo()
          Indicates if wildcard match is enough for verification.
 boolean isUserFile()
          Indicates whether this format is intended for display to user (eg.
 

Method Detail

getTitle

String getTitle()
                throws IOException,
                       AutomationException
Implementor name of format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUITitle

String getUITitle()
                  throws IOException,
                         AutomationException
User legible name of format.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrder

int getOrder()
             throws IOException,
                    AutomationException
Order to display in UI.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTempl

String getTempl()
                throws IOException,
                       AutomationException
Wildcard string for file matching.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPseudo

boolean isPseudo()
                 throws IOException,
                        AutomationException
Indicates if wildcard match is enough for verification.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

String getExtension()
                    throws IOException,
                           AutomationException
Default extension (without the dot).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShortName

String getShortName()
                    throws IOException,
                           AutomationException
Name used for icon registration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirectory

boolean isDirectory()
                    throws IOException,
                           AutomationException
Indicates whether this format is directory based, as opposed to file based.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCreatable

boolean isCreatable()
                    throws IOException,
                           AutomationException
Indicates whether this format supports 'SaveAs'.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUserFile

boolean isUserFile()
                   throws IOException,
                          AutomationException
Indicates whether this format is intended for display to user (eg. NOT *.rrd, or *.aux).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.