com.esri.arcgis.schematic
Interface ISchematicStandardBuilder

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicStandardBuilderProxy

public interface ISchematicStandardBuilder
extends Serializable

Provides access to members that control the schematic Standard builder.

Description

The Standard builder works from any GIS feature class/layer or object table.

Because it is able to decode geometric network and network dataset topology, the Standard builder is especially dedicated to work with GIS feature classes organized into a geoemtric network or a network dataset. It allows you to quickly generate schematic diagrams in a minimum amount of time from any set of network features.

The Standard builder can also be used to generate schematic diagrams whose whole contents are built from custom queries. These custom queries can operate on any type of database.

Product Availability

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

Method Summary

int	getUpdateMode() Mode (rebuild/append) to use for updating a diagram.
int	getUpdateType() Update type (fromSelection, fromTracing, fromInitial, ...).
boolean	isAddConnectedNodes() Indicates if the extremity nodes for the links currently highlighted in the map must be automatically added by the schematic Standard builder even if they are not highlighted.
boolean	isAutoCreateElementClasses() Indicates if the schematic element classes are automatically created by the schematic Standard builder.
boolean	isInitializeLinksVertices() Indicates if the initial vertices list for the links must be retrieved and initialized by the schematic Standard builder.
boolean	isPersistManualOperations() Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.
void	setAddConnectedNodes(boolean addConnectedNodes) Indicates if the extremity nodes for the links currently highlighted in the map must be automatically added by the schematic Standard builder even if they are not highlighted.
void	setAutoCreateElementClasses(boolean autoCreate) Indicates if the schematic element classes are automatically created by the schematic Standard builder.
void	setInitializeLinksVertices(boolean initializeLinksVertices) Indicates if the initial vertices list for the links must be retrieved and initialized by the schematic Standard builder.
void	setPersistManualOperations(boolean persistManualOperations) Indicates if the manual operations (removed elements, reduction, reconnection) are replayed after the update.
void	setUpdateMode(int updateMode) Mode (rebuild/append) to use for updating a diagram.
void	setUpdateType(int updateType) Update type (fromSelection, fromTracing, fromInitial, ...).

Method Detail

setAutoCreateElementClasses

void setAutoCreateElementClasses(boolean autoCreate)
                                 throws IOException,
                                        AutomationException

Indicates if the schematic element classes are automatically created by the schematic Standard builder.

Description

When AutoCreateElementClasses is enabled, the Standard builder automatically creates schematic element classes that could be missing from the schematic diagram class when it operates.

Remarks

When AutoCreateElementClasses is disabled, no new schematic element classes are created when the Standard builder operates. This means that if, among the data in input, the Standard builder detects a feature/object based on a feature/object class for which there is no associated schematic element class for the schematic diagram class, no schematic element will be created in the schematic dataset for that feature/object, and no schematic element will be contained in the resulting diagram for that feature/object.

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

setAddConnectedNodes

void setAddConnectedNodes(boolean addConnectedNodes)
                          throws IOException,
                                 AutomationException

Indicates if the extremity nodes for the links currently highlighted in the map must be automatically added by the schematic Standard builder even if they are not highlighted.

Product Availability

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

Parameters:

addConnectedNodes - The addConnectedNodes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddConnectedNodes

boolean isAddConnectedNodes()
                            throws IOException,
                                   AutomationException

Indicates if the extremity nodes for the links currently highlighted in the map must be automatically added by the schematic Standard builder even if they are not highlighted.

Product Availability

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

Returns:

The addConnectedNodes

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 retrieved and initialized by the schematic Standard 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 retrieved and initialized by the schematic Standard 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.

setUpdateType

void setUpdateType(int updateType)
                   throws IOException,
                          AutomationException

Update type (fromSelection, fromTracing, fromInitial, ...).

Product Availability

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

Parameters:

updateType - A com.esri.arcgis.schematic.esriSchematicStandardBuilderUpdateType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdateType

int getUpdateType()
                  throws IOException,
                         AutomationException

Update type (fromSelection, fromTracing, fromInitial, ...).

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicStandardBuilderUpdateType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateMode

void setUpdateMode(int updateMode)
                   throws IOException,
                          AutomationException

Mode (rebuild/append) to use for updating a diagram.

Product Availability

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

Parameters:

updateMode - A com.esri.arcgis.schematic.esriSchematicStandardBuilderUpdateMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdateMode

int getUpdateMode()
                  throws IOException,
                         AutomationException

Mode (rebuild/append) to use for updating a diagram.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicStandardBuilderUpdateMode constant

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.