com.esri.arcgis.carto
Class FDOGraphicsLayerFactory

java.lang.Object
  com.esri.arcgis.carto.FDOGraphicsLayerFactory

All Implemented Interfaces:

IAnnotationLayerFactory, IFDOGraphicsLayerFactory, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class FDOGraphicsLayerFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFDOGraphicsLayerFactory, IAnnotationLayerFactory

A graphics layer factory.

Remarks

An FDOGraphicsLayerFactory is a dispenser of annotation layers and allows a client to open and create annotation layers specified by a set of parameters. An annotation layer represents a feature class in a geodatabse that stores graphic features, such as an annotation feature class. An FDOGraphicsLayerFactory is a cocreatable, singleton object. An FDOGraphicsLayerFactory also supports methods that can be used to browse graphics layers in a workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

FDOGraphicsLayerFactory()
Constructs a FDOGraphicsLayerFactory using ArcGIS Engine.

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

Method Summary

IAnnotationLayer	createAnnotationLayer(IFeatureWorkspace workspace, IFeatureDataset featureDataset, String annotationClassName, IGeometryDef pGeometryDef, IFeatureClass pAssociatedFeatureClass, IAnnotateLayerPropertiesCollection annoLayerProps, IGraphicsLayerScale referenceScale, ISymbolCollection symbolCollection, boolean autoCreate, boolean updateOnShapeChange, boolean requireSymbolID, boolean allowSymbolOverrides, IOverposterProperties overposterProperties, String configKeyword) Creates a new annotation feature class and returns a layer for it.
ILayer	createGraphicsLayer(IFeatureWorkspace graphicWorkspace, IFeatureDataset featureDataset, String graphicsLayerName, IGeometryDef pGeometryDef, IFeatureClass pAssociatedFeatureClass, IAnnotateLayerPropertiesCollection annoLayerProps, IGraphicsLayerScale referenceScale, ISymbolCollection symbolCollection, boolean autoCreate) Creates a new annotation feature class and returns a layer for it.
boolean	equals(Object o) Compare this object with another
IEnumBSTR	findAnnotationFeatureClassNames(IFeatureWorkspace workspace) Returns the names of existing annotation feature classes.
IEnumBSTR	findGraphicsLayerNames(IFeatureWorkspace graphicWorkspace) Returns the names of existing annotation feature classes.
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
IAnnotationLayer	openAnnotationLayer(IFeatureWorkspace workspace, IFeatureDataset featureDataset, String annotationClassName) Opens an annotation feature class and returns a layer for it.
ILayer	openGraphicsLayer(IFeatureWorkspace graphicWorkspace, IFeatureDataset featureDataset, String graphicsLayerName) Creates a new annotation feature class 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

FDOGraphicsLayerFactory

public FDOGraphicsLayerFactory()
                        throws IOException,
                               UnknownHostException

Constructs a FDOGraphicsLayerFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FDOGraphicsLayerFactory

public FDOGraphicsLayerFactory(Object obj)
                        throws IOException

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

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

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

createGraphicsLayer

public ILayer createGraphicsLayer(IFeatureWorkspace graphicWorkspace,
                                  IFeatureDataset featureDataset,
                                  String graphicsLayerName,
                                  IGeometryDef pGeometryDef,
                                  IFeatureClass pAssociatedFeatureClass,
                                  IAnnotateLayerPropertiesCollection annoLayerProps,
                                  IGraphicsLayerScale referenceScale,
                                  ISymbolCollection symbolCollection,
                                  boolean autoCreate)
                           throws IOException,
                                  AutomationException

Creates a new annotation feature class and returns a layer for it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

createGraphicsLayer in interface IFDOGraphicsLayerFactory

Parameters:

graphicWorkspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

featureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)

graphicsLayerName - The graphicsLayerName (in)

pGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

pAssociatedFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

annoLayerProps - A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)

referenceScale - A reference to a com.esri.arcgis.carto.IGraphicsLayerScale (in)

symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)

autoCreate - The autoCreate (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.

openGraphicsLayer

public ILayer openGraphicsLayer(IFeatureWorkspace graphicWorkspace,
                                IFeatureDataset featureDataset,
                                String graphicsLayerName)
                         throws IOException,
                                AutomationException

Creates a new annotation feature class and returns a layer for it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

openGraphicsLayer in interface IFDOGraphicsLayerFactory

Parameters:

graphicWorkspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

featureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)

graphicsLayerName - The graphicsLayerName (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.

findGraphicsLayerNames

public IEnumBSTR findGraphicsLayerNames(IFeatureWorkspace graphicWorkspace)
                                 throws IOException,
                                        AutomationException

Returns the names of existing annotation feature classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findGraphicsLayerNames in interface IFDOGraphicsLayerFactory

Parameters:

graphicWorkspace - 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.

createAnnotationLayer

public IAnnotationLayer createAnnotationLayer(IFeatureWorkspace workspace,
                                              IFeatureDataset featureDataset,
                                              String annotationClassName,
                                              IGeometryDef pGeometryDef,
                                              IFeatureClass pAssociatedFeatureClass,
                                              IAnnotateLayerPropertiesCollection annoLayerProps,
                                              IGraphicsLayerScale referenceScale,
                                              ISymbolCollection symbolCollection,
                                              boolean autoCreate,
                                              boolean updateOnShapeChange,
                                              boolean requireSymbolID,
                                              boolean allowSymbolOverrides,
                                              IOverposterProperties overposterProperties,
                                              String configKeyword)
                                       throws IOException,
                                              AutomationException

Creates a new annotation feature class 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 IAnnotationLayerFactory

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

featureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)

annotationClassName - The annotationClassName (in)

pGeometryDef - A reference to a com.esri.arcgis.geodatabase.IGeometryDef (in)

pAssociatedFeatureClass - A reference to a com.esri.arcgis.geodatabase.IFeatureClass (in)

annoLayerProps - A reference to a com.esri.arcgis.carto.IAnnotateLayerPropertiesCollection (in)

referenceScale - A reference to a com.esri.arcgis.carto.IGraphicsLayerScale (in)

symbolCollection - A reference to a com.esri.arcgis.display.ISymbolCollection (in)

autoCreate - The autoCreate (in)

updateOnShapeChange - The updateOnShapeChange (in)

requireSymbolID - The requireSymbolID (in)

allowSymbolOverrides - The allowSymbolOverrides (in)

overposterProperties - A reference to a com.esri.arcgis.carto.IOverposterProperties (in)

configKeyword - The configKeyword (in)

Returns:

A reference to a com.esri.arcgis.carto.IAnnotationLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openAnnotationLayer

public IAnnotationLayer openAnnotationLayer(IFeatureWorkspace workspace,
                                            IFeatureDataset featureDataset,
                                            String annotationClassName)
                                     throws IOException,
                                            AutomationException

Opens an annotation feature class 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 IAnnotationLayerFactory

Parameters:

workspace - A reference to a com.esri.arcgis.geodatabase.IFeatureWorkspace (in)

featureDataset - A reference to a com.esri.arcgis.geodatabase.IFeatureDataset (in)

annotationClassName - The annotationClassName (in)

Returns:

A reference to a com.esri.arcgis.carto.IAnnotationLayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findAnnotationFeatureClassNames

public IEnumBSTR findAnnotationFeatureClassNames(IFeatureWorkspace workspace)
                                          throws IOException,
                                                 AutomationException

Returns the names of existing annotation feature classes.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

findAnnotationFeatureClassNames in interface IAnnotationLayerFactory

Parameters:

workspace - 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.