com.esri.arcgis.schematic
Class ISchematicXmlBuilderProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.schematic.ISchematicXmlBuilderProxy
All Implemented Interfaces:
ISchematicXmlBuilder, Externalizable, Serializable

public class ISchematicXmlBuilderProxy
extends com.esri.arcgis.interop.Dispatch
implements ISchematicXmlBuilder, Serializable

Provides access to members that control the Xml builder.

Description

The XML builder works from XML data based on the XMLBuilderDiagram XML Schematic Definition file. It is the builder to use if you work with external applications such as industry applications (for example, Network Engineer), ERPs (for example, SAP), PLMs (for example, Matrix One), or analysis packages (for example, CYME). It allows you to avoid developing specific interfaces that are costing a lot and not easy to maintain.

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
  ISchematicXmlBuilderProxy()
           
  ISchematicXmlBuilderProxy(Object obj)
           
protected ISchematicXmlBuilderProxy(Object obj, String iid)
           
 
Method Summary
 void addListener(String iidStr, Object theListener, Object theSource)
           
 String getGeneratingComponentCLSID()
          External Component classID for generating diagrams.
 String getObjectTypeMapping()
          Optional mapping between the schematic feature type in the XML file and the schematic feature type in the schematic dataset.
 String getUpdatingComponentCLSID()
          External Component classID for updating diagrams.
 boolean isAutoCreateElementClasses()
          Indicates if the schematic element classes are automatically created by the schematic Xml builder.
 boolean isInitializeLinksVertices()
          Indicates if the initial vertices list for the links must be initialized by the schematic Xml builder.
 boolean isPersistManualOperations()
          Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.
 void removeListener(String iidStr, Object theListener)
           
 void setAutoCreateElementClasses(boolean autoCreate)
          Indicates if the schematic element classes are automatically created by the schematic Xml builder.
 void setGeneratingComponentCLSID(String cLSID)
          External Component classID for generating diagrams.
 void setInitializeLinksVertices(boolean initializeLinksVertices)
          Indicates if the initial vertices list for the links must be initialized by the schematic Xml builder.
 void setObjectTypeMapping(String objectTypeMapping)
          Optional mapping between the schematic feature type in the XML file and the schematic feature type in the schematic dataset.
 void setPersistManualOperations(boolean persistManualOperations)
          Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.
 void setUpdatingComponentCLSID(String cLSID)
          External Component classID for updating diagrams.
 
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
 

Field Detail

noncastable

public boolean noncastable
Constructor Detail

ISchematicXmlBuilderProxy

public ISchematicXmlBuilderProxy()

ISchematicXmlBuilderProxy

public ISchematicXmlBuilderProxy(Object obj)
                          throws IOException
Throws:
IOException

ISchematicXmlBuilderProxy

protected ISchematicXmlBuilderProxy(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 com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

setGeneratingComponentCLSID

public void setGeneratingComponentCLSID(String cLSID)
                                 throws IOException,
                                        AutomationException
External Component classID for generating diagrams.

Product Availability

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

Specified by:
setGeneratingComponentCLSID in interface ISchematicXmlBuilder
Parameters:
cLSID - The cLSID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGeneratingComponentCLSID

public String getGeneratingComponentCLSID()
                                   throws IOException,
                                          AutomationException
External Component classID for generating diagrams.

Product Availability

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

Specified by:
getGeneratingComponentCLSID in interface ISchematicXmlBuilder
Returns:
The cLSID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUpdatingComponentCLSID

public void setUpdatingComponentCLSID(String cLSID)
                               throws IOException,
                                      AutomationException
External Component classID for updating diagrams.

Product Availability

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

Specified by:
setUpdatingComponentCLSID in interface ISchematicXmlBuilder
Parameters:
cLSID - The cLSID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUpdatingComponentCLSID

public String getUpdatingComponentCLSID()
                                 throws IOException,
                                        AutomationException
External Component classID for updating diagrams.

Product Availability

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

Specified by:
getUpdatingComponentCLSID in interface ISchematicXmlBuilder
Returns:
The cLSID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAutoCreateElementClasses

public void setAutoCreateElementClasses(boolean autoCreate)
                                 throws IOException,
                                        AutomationException
Indicates if the schematic element classes are automatically created by the schematic Xml builder.

Description

When AutoCreateElementClasses is enabled, the XML builder automatically creates a schematic element class for managing the different SchematicFeatureClass items found in the input XML data when such a schematic element class doesn't already exist for the schematic diagram class.

Remarks

When AutoCreateElementClasses is disabled, no new schematic element class is created when the XML builder operates. For example, if in the input XML data there are SchematicFeatureClass items whose value is Stations, and there is no schematic element class for the schematic diagram class to manage these SchematicFeatureClass items, no schematic elements will be included in the generated diagram for these XML items.

Product Availability

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

Specified by:
setAutoCreateElementClasses in interface ISchematicXmlBuilder
Parameters:
autoCreate - The autoCreate (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAutoCreateElementClasses

public boolean isAutoCreateElementClasses()
                                   throws IOException,
                                          AutomationException
Indicates if the schematic element classes are automatically created by the schematic Xml builder.

Product Availability

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

Specified by:
isAutoCreateElementClasses in interface ISchematicXmlBuilder
Returns:
The autoCreate
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInitializeLinksVertices

public void setInitializeLinksVertices(boolean initializeLinksVertices)
                                throws IOException,
                                       AutomationException
Indicates if the initial vertices list for the links must be initialized by the schematic Xml builder.

Product Availability

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

Specified by:
setInitializeLinksVertices in interface ISchematicXmlBuilder
Parameters:
initializeLinksVertices - The initializeLinksVertices (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isInitializeLinksVertices

public boolean isInitializeLinksVertices()
                                  throws IOException,
                                         AutomationException
Indicates if the initial vertices list for the links must be initialized by the schematic Xml builder.

Product Availability

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

Specified by:
isInitializeLinksVertices in interface ISchematicXmlBuilder
Returns:
The initializeLinksVertices
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPersistManualOperations

public void setPersistManualOperations(boolean persistManualOperations)
                                throws IOException,
                                       AutomationException
Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.

Product Availability

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

Specified by:
setPersistManualOperations in interface ISchematicXmlBuilder
Parameters:
persistManualOperations - The persistManualOperations (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPersistManualOperations

public boolean isPersistManualOperations()
                                  throws IOException,
                                         AutomationException
Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.

Product Availability

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

Specified by:
isPersistManualOperations in interface ISchematicXmlBuilder
Returns:
The persistManualOperations
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setObjectTypeMapping

public void setObjectTypeMapping(String objectTypeMapping)
                          throws IOException,
                                 AutomationException
Optional mapping between the schematic feature type in the XML file and the schematic feature type in the schematic dataset.

Description

ObjectTypeMapping must be specified when the FeatureClassName items in the input XML data don't match the names of the schematic element classes associated with the diagram class.

Product Availability

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

Specified by:
setObjectTypeMapping in interface ISchematicXmlBuilder
Parameters:
objectTypeMapping - The objectTypeMapping (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getObjectTypeMapping

public String getObjectTypeMapping()
                            throws IOException,
                                   AutomationException
Optional mapping between the schematic feature type in the XML file and the schematic feature type in the schematic dataset.

Product Availability

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

Specified by:
getObjectTypeMapping in interface ISchematicXmlBuilder
Returns:
The objectTypeMapping
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.