com.esri.arcgis.catalog
Class GxFileFactory

java.lang.Object
  com.esri.arcgis.catalog.GxFileFactory

All Implemented Interfaces:

IGxObjectFactory, IGxObjectFactoryFileExtensions, IGxObjectFactoryMetadata, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class GxFileFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObjectFactory, IGxObjectFactoryMetadata, IGxObjectFactoryFileExtensions

Esri GxFile object factory.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:

Serialized Form

Constructor Summary

GxFileFactory()
Constructs a GxFileFactory using ArcGIS Engine.

GxFileFactory(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFileFactory theGxFileFactory = (GxFileFactory) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
String	getActivationExtensions() The minimal set of file extensions which should cause the factory to be activated.
IEnumGxObject	getChildren(String parentDir, IFileNames fileNames) Returns an enumeration of objects corresponding to one or more of the given file names supported by the object factory.
static String	getClsid() getClsid.
IGxObject	getGxObjectFromMetadata(String metadataPath) Given a path to some metadata, constructs the corresponding GxObject.
String	getName() The name of the object factory.
String	getRelevantExtensions() The complete set of file extensions relevant to the factory.
boolean	hasChildren(String parentDir, IFileNames fileNames) Indicates if any of the specified files are supported by the object factory.
int	hashCode() the hashcode for this object
void	setCatalogByRef(IGxCatalog rhs1) Attach the catalog to the object factory.

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

GxFileFactory

public GxFileFactory()
              throws IOException,
                     UnknownHostException

Constructs a GxFileFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

GxFileFactory

public GxFileFactory(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFileFactory theGxFileFactory = (GxFileFactory) obj;

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

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

setCatalogByRef

public void setCatalogByRef(IGxCatalog rhs1)
                     throws IOException,
                            AutomationException

Attach the catalog to the object factory.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

setCatalogByRef in interface IGxObjectFactory

Parameters:

rhs1 - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the object factory.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getName in interface IGxObjectFactory

Returns:

The factoryName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasChildren

public boolean hasChildren(String parentDir,
                           IFileNames fileNames)
                    throws IOException,
                           AutomationException

Indicates if any of the specified files are supported by the object factory.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

hasChildren in interface IGxObjectFactory

Parameters:

parentDir - The parentDir (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

The hasChildren

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren(String parentDir,
                                 IFileNames fileNames)
                          throws IOException,
                                 AutomationException

Returns an enumeration of objects corresponding to one or more of the given file names supported by the object factory.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getChildren in interface IGxObjectFactory

Parameters:

parentDir - The parentDir (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

A reference to a com.esri.arcgis.catalog.IEnumGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGxObjectFromMetadata

public IGxObject getGxObjectFromMetadata(String metadataPath)
                                  throws IOException,
                                         AutomationException

Given a path to some metadata, constructs the corresponding GxObject.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getGxObjectFromMetadata in interface IGxObjectFactoryMetadata

Parameters:

metadataPath - The metadataPath (in)

Returns:

A reference to a com.esri.arcgis.catalog.IGxObject

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelevantExtensions

public String getRelevantExtensions()
                             throws IOException,
                                    AutomationException

The complete set of file extensions relevant to the factory.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getRelevantExtensions in interface IGxObjectFactoryFileExtensions

Returns:

The extSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivationExtensions

public String getActivationExtensions()
                               throws IOException,
                                      AutomationException

The minimal set of file extensions which should cause the factory to be activated.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:

getActivationExtensions in interface IGxObjectFactoryFileExtensions

Returns:

The extSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.