com.esri.arcgis.datasourcesraster
Class FormatList

java.lang.Object
  extended by com.esri.arcgis.datasourcesraster.FormatList
All Implemented Interfaces:
IFormatData, IFormatList, IFormatTest, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FormatList
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFormatList, IFormatData, IFormatTest

A collection of information about supported raster formats.

Remarks

The FormatList object contains information about all available raster formats. It can be used to access this information or to check if a particular file is a raster and determine its format.

This object will provide information about all native formats and any formats that have been added to ArcMap by external developers. Formats that have multiple possible file extensions may appear more than once in this list.

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
FormatList()
          Constructs a FormatList using ArcGIS Engine.
FormatList(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FormatList theFormatList = (FormatList) obj;
 
Method Summary
 boolean equals(Object o)
          Compare this object with another
 IFormatData formatIdentify(String path)
          The title of the dataset's format, if supported.
 boolean formatVerify(String path, String title)
          Tests whether a dataset is a raster format given a title.
static String getClsid()
          getClsid.
 int getCount()
          Total number of formats.
 int getCurrentRecord()
          Index of currently accessed format information.
 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.
 int hashCode()
          the hashcode for this object
 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.
 IFormatData item(int index)
          Returns format information for a given index.
 void setCurrentRecord(int pVal)
          Index of currently accessed format information.
 
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

FormatList

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

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

FormatList

public FormatList(Object obj)
           throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
FormatList theFormatList = (FormatList) obj;

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

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

getCount

public int getCount()
             throws IOException,
                    AutomationException
Total number of formats.

Remarks

The number of count returned includes both external formats (such as IMG, GRID, or TIFF etc) and internal formats (such as RRD or AUX etc.). To get only the supported external raster formats, use IFormatData::UserFile = true to filter out the internal formats.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCount in interface IFormatList
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

item

public IFormatData item(int index)
                 throws IOException,
                        AutomationException
Returns format information for a given index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
item in interface IFormatList
Parameters:
index - The index (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IFormatData
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentRecord

public int getCurrentRecord()
                     throws IOException,
                            AutomationException
Index of currently accessed format information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getCurrentRecord in interface IFormatList
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentRecord

public void setCurrentRecord(int pVal)
                      throws IOException,
                             AutomationException
Index of currently accessed format information.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getTitle

public 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

Specified by:
getTitle in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUITitle

public 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

Specified by:
getUITitle in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOrder

public 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

Specified by:
getOrder in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTempl

public 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

Specified by:
getTempl in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPseudo

public 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

Specified by:
isPseudo in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getExtension

public 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

Specified by:
getExtension in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShortName

public 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

Specified by:
getShortName in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirectory

public 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

Specified by:
isDirectory in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCreatable

public 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

Specified by:
isCreatable in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUserFile

public 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

Specified by:
isUserFile in interface IFormatData
Returns:
The pVal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

formatVerify

public boolean formatVerify(String path,
                            String title)
                     throws IOException,
                            AutomationException
Tests whether a dataset is a raster format given a title.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
formatVerify in interface IFormatTest
Parameters:
path - The path (in)
title - The title (in)
Returns:
The itis1
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

formatIdentify

public IFormatData formatIdentify(String path)
                           throws IOException,
                                  AutomationException
The title of the dataset's format, if supported.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
formatIdentify in interface IFormatTest
Parameters:
path - The path (in)
Returns:
A reference to a com.esri.arcgis.datasourcesraster.IFormatData
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.