com.esri.arcgis.schematic
Interface ISchematicXmlBuilder

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicXmlBuilderProxy

public interface ISchematicXmlBuilder
extends 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.

Method Summary

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

Method Detail

setGeneratingComponentCLSID

void setGeneratingComponentCLSID(String cLSID)
                                 throws IOException,
                                        AutomationException

External Component classID for generating diagrams.

Product Availability

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

Parameters:

cLSID - The cLSID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeneratingComponentCLSID

String getGeneratingComponentCLSID()
                                   throws IOException,
                                          AutomationException

External Component classID for generating diagrams.

Product Availability

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

Returns:

The cLSID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdatingComponentCLSID

void setUpdatingComponentCLSID(String cLSID)
                               throws IOException,
                                      AutomationException

External Component classID for updating diagrams.

Product Availability

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

Parameters:

cLSID - The cLSID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdatingComponentCLSID

String getUpdatingComponentCLSID()
                                 throws IOException,
                                        AutomationException

External Component classID for updating diagrams.

Product Availability

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

Returns:

The cLSID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAutoCreateElementClasses

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.

Parameters:

autoCreate - The autoCreate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAutoCreateElementClasses

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.

Returns:

The autoCreate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitializeLinksVertices

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.

Parameters:

initializeLinksVertices - The initializeLinksVertices (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInitializeLinksVertices

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.

Returns:

The initializeLinksVertices

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPersistManualOperations

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.

Parameters:

persistManualOperations - The persistManualOperations (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isPersistManualOperations

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.

Returns:

The persistManualOperations

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setObjectTypeMapping

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.

Parameters:

objectTypeMapping - The objectTypeMapping (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getObjectTypeMapping

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.

Returns:

The objectTypeMapping

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.