com.esri.arcgis.system
Class CategoryFactory

java.lang.Object
  extended by com.esri.arcgis.system.CategoryFactory
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ICategoryFactory, Serializable

public class CategoryFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ICategoryFactory

Component Category Factory.

Description

The CategoryFactory object is used to read the information in the registry to find out what classes are in a particular component category.

Remarks

The CategoryFactory object provides no facility to retrieve the classes in a component category without instantiating an object. To do this you could use the COM SDK interface ICatInformation though it can be difficult to use this interface from some development environments, for example Visual Basic 6.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
CategoryFactory()
          Constructs a CategoryFactory using ArcGIS Engine.
CategoryFactory(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
CategoryFactory theCategoryFactory = (CategoryFactory) obj;
 
Method Summary
 Object createNext()
          Creates the next component in the category.
 boolean equals(Object o)
          Compare this object with another
static String getClsid()
          getClsid.
 int hashCode()
          the hashcode for this object
 void setCategoryID(IUID rhs1)
          The ID of the category.
 
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

CategoryFactory

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

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

CategoryFactory

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

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

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

setCategoryID

public void setCategoryID(IUID rhs1)
                   throws IOException,
                          AutomationException
The ID of the category.

Description

Set the CategoryID to the GUID of the component category to be read.

Remarks

After the component category was specified with the CategoryID property, it points to the classes registered in that category. If more classes were added to that component category, and the CategoryID property is set second time to the same category to retrieve all registered classes including new ones, the CategoryID still points to the first state of the component category in the registry. No new classes could be retrieved in the same application runtime.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setCategoryID in interface ICategoryFactory
Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IUID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createNext

public Object createNext()
                  throws IOException,
                         AutomationException
Creates the next component in the category.

Description

The CreateNext method retrieves classes from the specified component category. Specify the category with the CategoryID property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createNext in interface ICategoryFactory
Returns:
A reference to another Object (IUnknown)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.