com.esri.arcgis.schematic
Class ISchematicElementClassProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.schematic.ISchematicObjectClassProxy
          com.esri.arcgis.schematic.ISchematicElementClassProxy

All Implemented Interfaces:

ISchematicElementClass, ISchematicObjectClass, Externalizable, Serializable

public class ISchematicElementClassProxy
extends ISchematicObjectClassProxy
implements ISchematicElementClass, Serializable

Provides access to members that manage the schematic element class.

Description

A schematic element class allows implementation of a particular type of schematic elements expected in diagrams implemented by a particular schematic diagram class. It is a collection of schematic elements that share the same type of schematic elements (nodes, links, and so on), the same geometry type (point, line, or polygon), and the same schematic attributes for a common area.

A schematic element class can be associated with one or several schematic diagram classes that implement schematic diagrams containing the schematic elements implemented by this schematic element class. It is assigned to one schematic dataset, although more than one schematic element class can be defined for the same schematic dataset. Schematic element classes always exist as physical feature classes in the schematic dataset and contain the schematic elements they implement.

Product Availability

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

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISchematicElementClassProxy()
	ISchematicElementClassProxy(Object obj)
protected	ISchematicElementClassProxy(Object obj, String iid)

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	alterAssociatedObjectClass(ISchematicDataSource schematicDataSource, int objectClassID) Changes the associated object class to the schematic element class.
ISchematicElement	createSchematicElement(String name, IGeometry geometry, ISchematicDiagram schematicDiagram) Creates a new schematic element in the specified schematic diagram.
ISchematicDataSource	getAssociatedObjectClassDataSource() The associated schematic data source to the schematic element class.
int	getAssociatedObjectClassDataSourceID() The associated object class data source ID to the schematic element class.
int	getAssociatedObjectClassID() The associated object class ID to the schematic element class.
IEnumSchematicDiagramClass	getAssociatedSchematicDiagramClasses() Associated diagram classes to the schematic element class.
int	getGeometryType() Geometry type of the schematic element class.
ISchematicElementClass	getParent() Parent to the schematic element class.
IUID	getRelationManagerCLSID() Relation manager CLSID of the schematic element class.
ISchematicElement	getSchematicElementByID(int iD, ISchematicDiagram schematicDiagram) Schematic element referenced by the specified ID that is contained in the specified schematic diagram.
ISchematicElement	getSchematicElementByName(String name, ISchematicDiagram schematicDiagram) Schematic element referenced by the specified Name that is contained in the specified schematic diagram.
IEnumSchematicElement	getSchematicElements(ISchematicDiagram schematicDiagram) List of the schematic elements related to the schematic element class within the specified schematic diagram.
int	getSchematicElementType() Schematic element type related to the schematic element class.
IField	getShapeField() Shape field of the schematic element class.
void	removeListener(String iidStr, Object theListener)
void	setGeometryType(int geometryType) Geometry type of the schematic element class.
void	setParentByRef(ISchematicElementClass parent) Parent to the schematic element class.
void	setRelationManagerCLSID(IUID uID) Relation manager CLSID of the schematic element class.
void	setShapeField(IField field) Shape field of the schematic element class.

Methods inherited from class com.esri.arcgis.schematic.ISchematicObjectClassProxy

createSchematicAttribute, delete, getExternalQueryEvaluationMode, getIdentifierFieldNames, getName, getPredefinedAttributeNames, getQueryString, getSchematicDataset, getSchematicDataSource, getSchematicQueryParameters, setExternalQueryEvaluationMode, setIdentifierFieldNames, setName, setQueryString, setSchematicDataSourceByRef, setSchematicQueryParameters

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.esri.arcgis.schematic.ISchematicObjectClass

createSchematicAttribute, delete, getExternalQueryEvaluationMode, getIdentifierFieldNames, getName, getPredefinedAttributeNames, getQueryString, getSchematicDataset, getSchematicDataSource, getSchematicQueryParameters, setExternalQueryEvaluationMode, setIdentifierFieldNames, setName, setQueryString, setSchematicDataSourceByRef, setSchematicQueryParameters

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISchematicElementClassProxy

public ISchematicElementClassProxy()

ISchematicElementClassProxy

public ISchematicElementClassProxy(Object obj)
                            throws IOException

Throws:

IOException

ISchematicElementClassProxy

protected ISchematicElementClassProxy(Object obj,
                                      String iid)
                               throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class ISchematicObjectClassProxy

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class ISchematicObjectClassProxy

Throws:

IOException

createSchematicElement

public ISchematicElement createSchematicElement(String name,
                                                IGeometry geometry,
                                                ISchematicDiagram schematicDiagram)
                                         throws IOException,
                                                AutomationException

Creates a new schematic element in the specified schematic diagram.

Product Availability

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

Specified by:

createSchematicElement in interface ISchematicElementClass

Parameters:

name - The name (in)

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElements

public IEnumSchematicElement getSchematicElements(ISchematicDiagram schematicDiagram)
                                           throws IOException,
                                                  AutomationException

List of the schematic elements related to the schematic element class within the specified schematic diagram.

Product Availability

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

Specified by:

getSchematicElements in interface ISchematicElementClass

Parameters:

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementByID

public ISchematicElement getSchematicElementByID(int iD,
                                                 ISchematicDiagram schematicDiagram)
                                          throws IOException,
                                                 AutomationException

Schematic element referenced by the specified ID that is contained in the specified schematic diagram.

Product Availability

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

Specified by:

getSchematicElementByID in interface ISchematicElementClass

Parameters:

iD - The iD (in)

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementByName

public ISchematicElement getSchematicElementByName(String name,
                                                   ISchematicDiagram schematicDiagram)
                                            throws IOException,
                                                   AutomationException

Schematic element referenced by the specified Name that is contained in the specified schematic diagram.

Product Availability

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

Specified by:

getSchematicElementByName in interface ISchematicElementClass

Parameters:

name - The name (in)

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in, optional, pass 0 if not required)

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementType

public int getSchematicElementType()
                            throws IOException,
                                   AutomationException

Schematic element type related to the schematic element class.

Product Availability

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

Specified by:

getSchematicElementType in interface ISchematicElementClass

Returns:

A com.esri.arcgis.schematic.esriSchematicElementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryType

public int getGeometryType()
                    throws IOException,
                           AutomationException

Geometry type of the schematic element class.

Product Availability

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

Specified by:

getGeometryType in interface ISchematicElementClass

Returns:

A com.esri.arcgis.geometry.esriGeometryType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryType

public void setGeometryType(int geometryType)
                     throws IOException,
                            AutomationException

Geometry type of the schematic element class.

Product Availability

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

Specified by:

setGeometryType in interface ISchematicElementClass

Parameters:

geometryType - A com.esri.arcgis.geometry.esriGeometryType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShapeField

public IField getShapeField()
                     throws IOException,
                            AutomationException

Shape field of the schematic element class.

Product Availability

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

Specified by:

getShapeField in interface ISchematicElementClass

Returns:

A reference to a com.esri.arcgis.geodatabase.IField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShapeField

public void setShapeField(IField field)
                   throws IOException,
                          AutomationException

Shape field of the schematic element class.

Product Availability

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

Specified by:

setShapeField in interface ISchematicElementClass

Parameters:

field - A reference to a com.esri.arcgis.geodatabase.IField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getParent

public ISchematicElementClass getParent()
                                 throws IOException,
                                        AutomationException

Parent to the schematic element class.

Product Availability

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

Specified by:

getParent in interface ISchematicElementClass

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElementClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentByRef

public void setParentByRef(ISchematicElementClass parent)
                    throws IOException,
                           AutomationException

Parent to the schematic element class.

Product Availability

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

Specified by:

setParentByRef in interface ISchematicElementClass

Parameters:

parent - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedSchematicDiagramClasses

public IEnumSchematicDiagramClass getAssociatedSchematicDiagramClasses()
                                                                throws IOException,
                                                                       AutomationException

Associated diagram classes to the schematic element class.

Product Availability

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

Specified by:

getAssociatedSchematicDiagramClasses in interface ISchematicElementClass

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicDiagramClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationManagerCLSID

public IUID getRelationManagerCLSID()
                             throws IOException,
                                    AutomationException

Relation manager CLSID of the schematic element class.

Product Availability

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

Specified by:

getRelationManagerCLSID in interface ISchematicElementClass

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationManagerCLSID

public void setRelationManagerCLSID(IUID uID)
                             throws IOException,
                                    AutomationException

Relation manager CLSID of the schematic element class.

Product Availability

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

Specified by:

setRelationManagerCLSID in interface ISchematicElementClass

Parameters:

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

getAssociatedObjectClassID

public int getAssociatedObjectClassID()
                               throws IOException,
                                      AutomationException

The associated object class ID to the schematic element class.

Product Availability

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

Specified by:

getAssociatedObjectClassID in interface ISchematicElementClass

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassDataSourceID

public int getAssociatedObjectClassDataSourceID()
                                         throws IOException,
                                                AutomationException

The associated object class data source ID to the schematic element class.

Product Availability

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

Specified by:

getAssociatedObjectClassDataSourceID in interface ISchematicElementClass

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedObjectClassDataSource

public ISchematicDataSource getAssociatedObjectClassDataSource()
                                                        throws IOException,
                                                               AutomationException

The associated schematic data source to the schematic element class.

Product Availability

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

Specified by:

getAssociatedObjectClassDataSource in interface ISchematicElementClass

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterAssociatedObjectClass

public void alterAssociatedObjectClass(ISchematicDataSource schematicDataSource,
                                       int objectClassID)
                                throws IOException,
                                       AutomationException

Changes the associated object class to the schematic element class.

Product Availability

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

Specified by:

alterAssociatedObjectClass in interface ISchematicElementClass

Parameters:

schematicDataSource - A reference to a com.esri.arcgis.schematic.ISchematicDataSource (in)

objectClassID - The objectClassID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.