com.esri.arcgis.schematic
Interface ISchematicNodeReductionRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicNodeReductionRuleByFlow, SchematicNodeReductionRuleByPriority, SchematicRouteNodeReductionRule

public interface ISchematicNodeReductionRule
extends Serializable

Provides access to members that manage the generic Schematic Node Reduction rule.

Product Availability

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

Method Summary

String	getDescription() Description of the Schematic Node Reduction rule.
String	getIncidentLinkAttributeName() Name of the attribute field that use for the link attribute option.
String	getNodeClassName() Name of the schematic node element class related to the Schematic Node Reduction rule; that is, name of the schematic node element class to reduce.
String	getWhereClause() Where clause used on associated feature to filter the schematic elements to reduce.
boolean	isKeepVertices() Indicates if the Schematic Node Reduction rule keeps the links vertices.
boolean	isUseIncidentLinkAttribute() Indicates if the Schematic Node Reduction rule use the link attribute.
void	setDescription(String description) Description of the Schematic Node Reduction rule.
void	setIncidentLinkAttributeName(String incidentLinkAttributeName) Name of the attribute field that use for the link attribute option.
void	setKeepVertices(boolean keepVertices) Indicates if the Schematic Node Reduction rule keeps the links vertices.
void	setNodeClassName(String nodeClassName) Name of the schematic node element class related to the Schematic Node Reduction rule; that is, name of the schematic node element class to reduce.
void	setUseIncidentLinkAttribute(boolean useIncidentLinkAttribute) Indicates if the Schematic Node Reduction rule use the link attribute.
void	setWhereClause(String whereClause) Where clause used on associated feature to filter the schematic elements to reduce.

Method Detail

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the Schematic Node Reduction rule.

Product Availability

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

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException

Description of the Schematic Node Reduction rule.

Product Availability

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

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNodeClassName

String getNodeClassName()
                        throws IOException,
                               AutomationException

Name of the schematic node element class related to the Schematic Node Reduction rule; that is, name of the schematic node element class to reduce.

Product Availability

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

Returns:

The nodeClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNodeClassName

void setNodeClassName(String nodeClassName)
                      throws IOException,
                             AutomationException

Name of the schematic node element class related to the Schematic Node Reduction rule; that is, name of the schematic node element class to reduce.

Product Availability

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

Parameters:

nodeClassName - The nodeClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepVertices

boolean isKeepVertices()
                       throws IOException,
                              AutomationException

Indicates if the Schematic Node Reduction rule keeps the links vertices.

Product Availability

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

Returns:

The keepVertices

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepVertices

void setKeepVertices(boolean keepVertices)
                     throws IOException,
                            AutomationException

Indicates if the Schematic Node Reduction rule keeps the links vertices.

Product Availability

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

Parameters:

keepVertices - The keepVertices (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

String getWhereClause()
                      throws IOException,
                             AutomationException

Where clause used on associated feature to filter the schematic elements to reduce.

Product Availability

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

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

void setWhereClause(String whereClause)
                    throws IOException,
                           AutomationException

Where clause used on associated feature to filter the schematic elements to reduce.

Product Availability

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

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseIncidentLinkAttribute

boolean isUseIncidentLinkAttribute()
                                   throws IOException,
                                          AutomationException

Indicates if the Schematic Node Reduction rule use the link attribute.

Product Availability

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

Returns:

The useIncidentLinkAttribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseIncidentLinkAttribute

void setUseIncidentLinkAttribute(boolean useIncidentLinkAttribute)
                                 throws IOException,
                                        AutomationException

Indicates if the Schematic Node Reduction rule use the link attribute.

Product Availability

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

Parameters:

useIncidentLinkAttribute - The useIncidentLinkAttribute (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncidentLinkAttributeName

String getIncidentLinkAttributeName()
                                    throws IOException,
                                           AutomationException

Name of the attribute field that use for the link attribute option.

Product Availability

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

Returns:

The incidentLinkAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncidentLinkAttributeName

void setIncidentLinkAttributeName(String incidentLinkAttributeName)
                                  throws IOException,
                                         AutomationException

Name of the attribute field that use for the link attribute option.

Product Availability

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

Parameters:

incidentLinkAttributeName - The incidentLinkAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.