com.esri.arcgis.carto
Class EngineCoverageAnnotationLayerFactory

java.lang.Object
  extended by com.esri.arcgis.carto.EngineCoverageAnnotationLayerFactory
All Implemented Interfaces:
ICoverageAnnotationLayerFactory, ILayerFactory, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class EngineCoverageAnnotationLayerFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ILayerFactory, ICoverageAnnotationLayerFactory

A factory for creating coverage annotation layers.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
EngineCoverageAnnotationLayerFactory()
          Constructs a EngineCoverageAnnotationLayerFactory using ArcGIS Engine.
EngineCoverageAnnotationLayerFactory(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EngineCoverageAnnotationLayerFactory theEngineCoverageAnnotationLayerFactory = (EngineCoverageAnnotationLayerFactory) obj;
 
Method Summary
 IEnumLayer create(Object inputObject)
          Creates layer(s) based on the specified object.
 ILayer createAnnotationLayer(IFeatureWorkspace pAnnotationWorkspace, IFeatureDataset pFeatureDataset, String annotationLayerName)
          Create an annotation class (on disk), and returns a layer for it.
 boolean equals(Object o)
          Compare this object with another
 IEnumBSTR findAnnotationLayerNames(IFeatureWorkspace pAnnotationWorkspace)
          Finds an annotation classes.
static String getClsid()
          getClsid.
 String getLayerCategory()
          Category name.
 String getPublicName()
          Public name of the factory.
 int hashCode()
          the hashcode for this object
 boolean isCanCreate(Object inputObject)
          Indicates if the factory can create a layer based upon the specified object.
 IEnumLayer loadLayers()
          Loads a set of layers.
 ILayer openAnnotationLayer(IFeatureWorkspace pAnnotationWorkspace, IFeatureDataset pFeatureDataset, String annotationLayerName)
          Loads an annotation class (on disk), and returns a layer for it.
 
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

EngineCoverageAnnotationLayerFactory

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

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

EngineCoverageAnnotationLayerFactory

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

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

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

getPublicName

public String getPublicName()
                     throws IOException,
                            AutomationException
Public name of the factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getPublicName in interface ILayerFactory
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayerCategory

public String getLayerCategory()
                        throws IOException,
                               AutomationException
Category name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getLayerCategory in interface ILayerFactory
Returns:
The category
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

loadLayers

public IEnumLayer loadLayers()
                      throws IOException,
                             AutomationException
Loads a set of layers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
loadLayers in interface ILayerFactory
Returns:
A reference to a com.esri.arcgis.carto.IEnumLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanCreate

public boolean isCanCreate(Object inputObject)
                    throws IOException,
                           AutomationException
Indicates if the factory can create a layer based upon the specified object.

Product Availability

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

Specified by:
isCanCreate in interface ILayerFactory
Parameters:
inputObject - A reference to another Object (IUnknown) (in)
Returns:
The ok
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

create

public IEnumLayer create(Object inputObject)
                  throws IOException,
                         AutomationException
Creates layer(s) based on the specified object.

Description

Creates a layer using the factory defined by the implementing coclass and the supplied object. This object can be a name object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
create in interface ILayerFactory
Parameters:
inputObject - A reference to another Object (IUnknown) (in)
Returns:
A reference to a com.esri.arcgis.carto.IEnumLayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

createAnnotationLayer

public ILayer createAnnotationLayer(IFeatureWorkspace pAnnotationWorkspace,
                                    IFeatureDataset pFeatureDataset,
                                    String annotationLayerName)
                             throws IOException,
                                    AutomationException
Create an annotation class (on disk), and returns a layer for it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
createAnnotationLayer in interface ICoverageAnnotationLayerFactory
Parameters:
pAnnotationWorkspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)
pFeatureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)
annotationLayerName - The annotationLayerName (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

openAnnotationLayer

public ILayer openAnnotationLayer(IFeatureWorkspace pAnnotationWorkspace,
                                  IFeatureDataset pFeatureDataset,
                                  String annotationLayerName)
                           throws IOException,
                                  AutomationException
Loads an annotation class (on disk), and returns a layer for it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
openAnnotationLayer in interface ICoverageAnnotationLayerFactory
Parameters:
pAnnotationWorkspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)
pFeatureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)
annotationLayerName - The annotationLayerName (in)
Returns:
A reference to a com.esri.arcgis.carto.ILayer
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findAnnotationLayerNames

public IEnumBSTR findAnnotationLayerNames(IFeatureWorkspace pAnnotationWorkspace)
                                   throws IOException,
                                          AutomationException
Finds an annotation classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
findAnnotationLayerNames in interface ICoverageAnnotationLayerFactory
Parameters:
pAnnotationWorkspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)
Returns:
A reference to a com.esri.arcgis.system.IEnumBSTR
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.