com.esri.arcgis.datasourcesraster

Class FormatList

java.lang.Object

com.esri.arcgis.datasourcesraster.FormatList

All Implemented Interfaces:

IFormatData, IFormatList, IFormatTest, IRasterFormatControl, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

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

COM Class 'FormatList'. Generated 9/21/2023 10:01:44 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'A collection of information about supported raster formats.' 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.datasourcesraster.IFormatList

IID, IID34bd97e1_5ed8_11d3_80ea_00500462e955, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IFormatData

IID, IID43e890d1_5ed9_11d3_80ea_00500462e955, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IFormatTest

IID, IID3d3e5180_6c5d_11d3_80ee_00500462e955, xxDummy

Fields inherited from interface com.esri.arcgis.datasourcesraster.IRasterFormatControl

IID, IID07f9af37_9121_480b_82e9_760c96e16618, xxDummy

Constructor Summary

Constructors

Constructor and Description
FormatList() Constructs a FormatList using ArcGIS Engine.
FormatList(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. FormatList theFormatList = (FormatList) obj;

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o) Compare this object with another
IFormatData	formatIdentify(java.lang.String path) The title of the dataset's format, if supported.
boolean	formatVerify(java.lang.String path, java.lang.String title) Tests whether a dataset is a raster format given a title.
static java.lang.String	getClsid() getClsid.
int	getCount() Total number of formats.
int	getCurrentRecord() Index of currently accessed format information.
java.lang.String	getExtension() Default extension (without the dot).
int	getFormatSupportLevel() The current raster format support level.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	getOrder() Order to display in UI.
java.lang.String	getShortName() Name used for icon registration.
java.lang.String	getTempl() Wildcard string for file matching.
java.lang.String	getTitle() Implementor name of format.
java.lang.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	release() Release this COM object reference
void	setCurrentRecord(int pVal) Index of currently accessed format information.
void	setFormatSupportLevel(int pSupportLevel) The current raster format support level.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormatList

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

Constructs a FormatList using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

FormatList

public FormatList(java.lang.Object obj)
           throws java.io.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:

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

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getCount

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

Total number of formats.

Specified by:

getCount in interface IFormatList

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

item

public IFormatData item(int index)
                 throws java.io.IOException,
                        AutomationException

Returns format information for a given index.

Specified by:

item in interface IFormatList

Parameters:

index - The index (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IFormatData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCurrentRecord

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

Index of currently accessed format information.

Specified by:

getCurrentRecord in interface IFormatList

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setCurrentRecord

public void setCurrentRecord(int pVal)
                      throws java.io.IOException,
                             AutomationException

Index of currently accessed format information.

Specified by:

setCurrentRecord in interface IFormatList

Parameters:

pVal - The pVal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTitle

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

Implementor name of format.

Specified by:

getTitle in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getUITitle

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

User legible name of format.

Specified by:

getUITitle in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOrder

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

Order to display in UI.

Specified by:

getOrder in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTempl

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

Wildcard string for file matching.

Specified by:

getTempl in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPseudo

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

Indicates if wildcard match is enough for verification.

Specified by:

isPseudo in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getExtension

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

Default extension (without the dot).

Specified by:

getExtension in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getShortName

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

Name used for icon registration.

Specified by:

getShortName in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirectory

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

Indicates whether this format is directory based, as opposed to file based.

Specified by:

isDirectory in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCreatable

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

Indicates whether this format supports 'SaveAs'.

Specified by:

isCreatable in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUserFile

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

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

Specified by:

isUserFile in interface IFormatData

Returns:

The pVal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

formatVerify

public boolean formatVerify(java.lang.String path,
                            java.lang.String title)
                     throws java.io.IOException,
                            AutomationException

Tests whether a dataset is a raster format given a title.

Specified by:

formatVerify in interface IFormatTest

Parameters:

path - The path (in)

title - The title (in)

Returns:

The itis1

Throws:

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

AutomationException - If the ArcObject component throws an exception.

formatIdentify

public IFormatData formatIdentify(java.lang.String path)
                           throws java.io.IOException,
                                  AutomationException

The title of the dataset's format, if supported.

Specified by:

formatIdentify in interface IFormatTest

Parameters:

path - The path (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IFormatData

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFormatSupportLevel

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

The current raster format support level.

Specified by:

getFormatSupportLevel in interface IRasterFormatControl

Returns:

A com.esri.arcgis.datasourcesraster.esriRasterFormatSupportLevel constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFormatSupportLevel

public void setFormatSupportLevel(int pSupportLevel)
                           throws java.io.IOException,
                                  AutomationException

The current raster format support level.

Specified by:

setFormatSupportLevel in interface IRasterFormatControl

Parameters:

pSupportLevel - A com.esri.arcgis.datasourcesraster.esriRasterFormatSupportLevel constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.