com.esri.arcgis.catalog
Class GxMetadataFactory

java.lang.Object
  extended by com.esri.arcgis.catalog.GxMetadataFactory
All Implemented Interfaces:
IGxObjectFactory, IGxObjectFactoryFileExtensions, IGxObjectFactoryMetadata, IGxObjectFactoryPriority, com.esri.arcgis.interop.RemoteObjRef, Serializable

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

A factory for creating GxMetadata objects to show XML files in the Catalog.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GxMetadataFactory()
          Constructs a GxMetadataFactory using ArcGIS Engine.
GxMetadataFactory(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxMetadataFactory theGxMetadataFactory = (GxMetadataFactory) 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.
 int getPriority()
          The priority 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.
 void setPriority(int priority)
          The priority of 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

GxMetadataFactory

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

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

GxMetadataFactory

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

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

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.

getPriority

public int getPriority()
                throws IOException,
                       AutomationException
The priority of the object factory. The higher the priority, the sooner the object factory is used to discover GxObjects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getPriority in interface IGxObjectFactoryPriority
Returns:
The priority
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPriority

public void setPriority(int priority)
                 throws IOException,
                        AutomationException
The priority of the object factory. The higher the priority, the sooner the object factory is used to discover GxObjects.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
setPriority in interface IGxObjectFactoryPriority
Parameters:
priority - The priority (in)
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.