com.esri.arcgis.schematic
Class ISchematicDiagramProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.IRowBufferProxy
          com.esri.arcgis.geodatabase.IRowProxy
              com.esri.arcgis.geodatabase.IObjectProxy
                  com.esri.arcgis.schematic.ISchematicDiagramProxy

All Implemented Interfaces:

IObject, IRow, IRowBuffer, ISchematicDiagram, Externalizable, Serializable

public class ISchematicDiagramProxy
extends IObjectProxy
implements ISchematicDiagram, Serializable

Provides access to members that control the schematic diagram.

Description

A schematic diagram is a set of schematic features (nodes, links, nodes on links, and sublinks) that has been generated using the Generate New Diagram command in ArcMap, the Create Diagram GP tool, or the ArcGIS Schematics API. It is displayed in a schematic layer, which is a composite layer composed of feature layers based on the schematic feature classes associated with the schematic diagram template. The content, symbology, and the way the schematic diagram is generated and displayed is configured in its schematic diagram class. A schematic diagram is stored in a geodatabase in a schematic diagram container; that is, a schematic dataset or a schematic folder of the schematic dataset.

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

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

Method Summary

void	addListener(String iidStr, Object theListener, Object theSource)
void	alterBuilderPropertySet(IPropertySet propertySet) Changes the builder PropertySet related to the schematic diagram with the new specified builder PropertySet.
void	alterPropertySet(IPropertySet propertySet) Changes the Schematic diagram PropertySet with the new specified diagram PropertySet.
IPropertySet	getBuilderPropertySet() Builder PropertySet related to the schematic diagram.
Date	getCreationDate() Creation date of the schematic diagram.
String	getCreator() Name of the schematic diagram creator.
Date	getLastModificationDate() Last modification date of the schematic diagram.
Date	getLastUpdateDate() Last updating date of the schematic diagram.
String	getModifiedBy() Name of the user that modified the schematic diagram.
String	getName() Name of the schematic diagram.
IPropertySet	getPropertySet() PropertySet of the schematic diagram.
ISchematicDiagramClass	getSchematicDiagramClass() Schematic diagram class related to the schematic diagram.
ISchematicDiagramContainer	getSchematicDiagramContainer() Schematic diagram container related to the schematic diagram.
String	getUpdatedBy() Name of the last user that updated the schematic diagram.
String	getVersion() Version of the database used to create the schematic diagram.
void	removeListener(String iidStr, Object theListener)
void	setCreationDate(Date date) Creation date of the schematic diagram.
void	setCreator(String name) Name of the schematic diagram creator.
void	setLastModificationDate(Date date) Last modification date of the schematic diagram.
void	setLastUpdateDate(Date date) Last updating date of the schematic diagram.
void	setModifiedBy(String name) Name of the user that modified the schematic diagram.
void	setName(String name) Name of the schematic diagram.
void	setSchematicDiagramContainerByRef(ISchematicDiagramContainer diagramContainer) Schematic diagram container related to the schematic diagram.
void	setUpdatedBy(String name) Name of the last user that updated the schematic diagram.
void	setVersion(String versionName) Version of the database used to create the schematic diagram.

Methods inherited from class com.esri.arcgis.geodatabase.IObjectProxy

esri_getClass

Methods inherited from class com.esri.arcgis.geodatabase.IRowProxy

delete, getOID, getTable, isHasOID, store

Methods inherited from class com.esri.arcgis.geodatabase.IRowBufferProxy

getFields, getValue, setValue

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.geodatabase.IObject

esri_getClass

Methods inherited from interface com.esri.arcgis.geodatabase.IRow

delete, getOID, getTable, isHasOID, store

Methods inherited from interface com.esri.arcgis.geodatabase.IRowBuffer

getFields, getValue, setValue

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISchematicDiagramProxy

public ISchematicDiagramProxy()

ISchematicDiagramProxy

public ISchematicDiagramProxy(Object obj)
                       throws IOException

Throws:

IOException

ISchematicDiagramProxy

protected ISchematicDiagramProxy(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 IObjectProxy

Throws:

IOException

removeListener

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

Overrides:

removeListener in class IObjectProxy

Throws:

IOException

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException

Schematic diagram class related to the schematic diagram.

Product Availability

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

Specified by:

getSchematicDiagramClass in interface ISchematicDiagram

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramContainer

public ISchematicDiagramContainer getSchematicDiagramContainer()
                                                        throws IOException,
                                                               AutomationException

Schematic diagram container related to the schematic diagram. That is, the schematic folder or the schematic dataset for the schematic diagram storage.

Product Availability

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

Specified by:

getSchematicDiagramContainer in interface ISchematicDiagram

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramContainerByRef

public void setSchematicDiagramContainerByRef(ISchematicDiagramContainer diagramContainer)
                                       throws IOException,
                                              AutomationException

Schematic diagram container related to the schematic diagram. That is, the schematic folder or the schematic dataset for the schematic diagram storage.

Product Availability

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

Specified by:

setSchematicDiagramContainerByRef in interface ISchematicDiagram

Parameters:

diagramContainer - A reference to a com.esri.arcgis.schematic.ISchematicDiagramContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the schematic diagram.

Product Availability

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

Specified by:

getName in interface ISchematicDiagram

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException

Name of the schematic diagram.

Remarks

Schematics enforces the uniqueness of the schematic diagram name regarding:

• The name of its schematic dataset
• The names of all the schematic diagrams in its schematic dataset
• The names of all the schematic folders at the same level in the schematic dataset

Product Availability

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

Specified by:

setName in interface ISchematicDiagram

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCreationDate

public Date getCreationDate()
                     throws IOException,
                            AutomationException

Creation date of the schematic diagram.

Product Availability

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

Specified by:

getCreationDate in interface ISchematicDiagram

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreationDate

public void setCreationDate(Date date)
                     throws IOException,
                            AutomationException

Creation date of the schematic diagram.

Product Availability

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

Specified by:

setCreationDate in interface ISchematicDiagram

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastUpdateDate

public Date getLastUpdateDate()
                       throws IOException,
                              AutomationException

Last updating date of the schematic diagram.

Product Availability

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

Specified by:

getLastUpdateDate in interface ISchematicDiagram

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastUpdateDate

public void setLastUpdateDate(Date date)
                       throws IOException,
                              AutomationException

Last updating date of the schematic diagram.

Product Availability

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

Specified by:

setLastUpdateDate in interface ISchematicDiagram

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

public String getVersion()
                  throws IOException,
                         AutomationException

Version of the database used to create the schematic diagram.

Product Availability

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

Specified by:

getVersion in interface ISchematicDiagram

Returns:

The versionName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVersion

public void setVersion(String versionName)
                throws IOException,
                       AutomationException

Version of the database used to create the schematic diagram.

Product Availability

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

Specified by:

setVersion in interface ISchematicDiagram

Parameters:

versionName - The versionName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCreator

public String getCreator()
                  throws IOException,
                         AutomationException

Name of the schematic diagram creator.

Product Availability

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

Specified by:

getCreator in interface ISchematicDiagram

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCreator

public void setCreator(String name)
                throws IOException,
                       AutomationException

Name of the schematic diagram creator.

Product Availability

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

Specified by:

setCreator in interface ISchematicDiagram

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdatedBy

public String getUpdatedBy()
                    throws IOException,
                           AutomationException

Name of the last user that updated the schematic diagram.

Product Availability

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

Specified by:

getUpdatedBy in interface ISchematicDiagram

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdatedBy

public void setUpdatedBy(String name)
                  throws IOException,
                         AutomationException

Name of the last user that updated the schematic diagram.

Product Availability

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

Specified by:

setUpdatedBy in interface ISchematicDiagram

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBuilderPropertySet

public IPropertySet getBuilderPropertySet()
                                   throws IOException,
                                          AutomationException

Builder PropertySet related to the schematic diagram.

Product Availability

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

Specified by:

getBuilderPropertySet in interface ISchematicDiagram

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterBuilderPropertySet

public void alterBuilderPropertySet(IPropertySet propertySet)
                             throws IOException,
                                    AutomationException

Changes the builder PropertySet related to the schematic diagram with the new specified builder PropertySet.

Product Availability

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

Specified by:

alterBuilderPropertySet in interface ISchematicDiagram

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet of the schematic diagram.

Product Availability

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

Specified by:

getPropertySet in interface ISchematicDiagram

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterPropertySet

public void alterPropertySet(IPropertySet propertySet)
                      throws IOException,
                             AutomationException

Changes the Schematic diagram PropertySet with the new specified diagram PropertySet.

Product Availability

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

Specified by:

alterPropertySet in interface ISchematicDiagram

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLastModificationDate

public Date getLastModificationDate()
                             throws IOException,
                                    AutomationException

Last modification date of the schematic diagram.

Product Availability

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

Specified by:

getLastModificationDate in interface ISchematicDiagram

Returns:

The date

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLastModificationDate

public void setLastModificationDate(Date date)
                             throws IOException,
                                    AutomationException

Last modification date of the schematic diagram.

Product Availability

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

Specified by:

setLastModificationDate in interface ISchematicDiagram

Parameters:

date - The date (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getModifiedBy

public String getModifiedBy()
                     throws IOException,
                            AutomationException

Name of the user that modified the schematic diagram.

Product Availability

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

Specified by:

getModifiedBy in interface ISchematicDiagram

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setModifiedBy

public void setModifiedBy(String name)
                   throws IOException,
                          AutomationException

Name of the user that modified the schematic diagram.

Product Availability

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

Specified by:

setModifiedBy in interface ISchematicDiagram

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.