com.esri.arcgis.schematic
Interface ISchematicNodeReductionRuleByPriority

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicNodeReductionRuleByPriority

public interface ISchematicNodeReductionRuleByPriority
extends Serializable

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

Description

The Node Reduction By Priority rule allows you to generate schematic diagrams after all nodes or some particular nodes implemented by a given node schematic element class have been removed and after the links that connected these removed nodes have been reconnected to a target node so the topology is preserved.

Product Availability

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

Method Summary

int	getActivePriority() Indicates if the element class priority is activated.
Object	getElementClassPrioritiesToReduceAlways() List of the element class names the Schematic Node Reduction By Priority rule must always reduce ordered by their decreasing priority.
String	getExtendedCriteriaName() Name of the extended criteria.
Object	getOrderedElementClassPriorities() List of the element class names ordered by their decreasing priority for the Schematic Node Reduction By Priority rule.
boolean	isExtendedCriteriaUsed() Indicates if additional extended criteria is used.
boolean	isNodeDegreeConstraint() Indicates if the degree of the nodes is a constraint for the Schematic Node Reduction By Priority rule.
boolean	isReduceIfOnlyTwoChoicesWithSamePriority() Indicates if the Schematic Node Reduction By Priority rule occurs if there are only two possibilities to apply the rule and if these solutions have the same priority.
boolean	isReduceNodeDegree0() Indicates if the disconnected nodes (that is, the nodes with degree 0) must be automatically reduced by the Schematic Node Reduction By Priority rule.
boolean	isReduceNodeDegree1() Indicates if the leaves nodes (that is, the nodes with degree 1) must be automatically reduced by the Schematic Node Reduction By Priority rule.
boolean	isReduceNodeDegree2() Indicates if the nodes with degree 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.
boolean	isReduceNodeDegreeSup3() Indicates if the nodes with a degree upper than 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.
void	setActivePriority(int priority) Indicates if the element class priority is activated.
void	setElementClassPrioritiesToReduceAlways(Object names) List of the element class names the Schematic Node Reduction By Priority rule must always reduce ordered by their decreasing priority.
void	setExtendedCriteriaName(String extendedCriteriaName) Name of the extended criteria.
void	setExtendedCriteriaUsed(boolean extendedCriteriaUsed) Indicates if additional extended criteria is used.
void	setNodeDegreeConstraint(boolean degreeConstraint) Indicates if the degree of the nodes is a constraint for the Schematic Node Reduction By Priority rule.
void	setOrderedElementClassPriorities(Object names) List of the element class names ordered by their decreasing priority for the Schematic Node Reduction By Priority rule.
void	setReduceIfOnlyTwoChoicesWithSamePriority(boolean reduce) Indicates if the Schematic Node Reduction By Priority rule occurs if there are only two possibilities to apply the rule and if these solutions have the same priority.
void	setReduceNodeDegree0(boolean reduce) Indicates if the disconnected nodes (that is, the nodes with degree 0) must be automatically reduced by the Schematic Node Reduction By Priority rule.
void	setReduceNodeDegree1(boolean reduce) Indicates if the leaves nodes (that is, the nodes with degree 1) must be automatically reduced by the Schematic Node Reduction By Priority rule.
void	setReduceNodeDegree2(boolean reduce) Indicates if the nodes with degree 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.
void	setReduceNodeDegreeSup3(boolean reduce) Indicates if the nodes with a degree upper than 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.

Method Detail

isNodeDegreeConstraint

boolean isNodeDegreeConstraint()
                               throws IOException,
                                      AutomationException

Indicates if the degree of the nodes is a constraint for the Schematic Node Reduction By Priority rule.

Product Availability

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

Returns:

The degreeConstraint

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNodeDegreeConstraint

void setNodeDegreeConstraint(boolean degreeConstraint)
                             throws IOException,
                                    AutomationException

Indicates if the degree of the nodes is a constraint for the Schematic Node Reduction By Priority rule.

Product Availability

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

Parameters:

degreeConstraint - The degreeConstraint (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReduceNodeDegree0

boolean isReduceNodeDegree0()
                            throws IOException,
                                   AutomationException

Indicates if the disconnected nodes (that is, the nodes with degree 0) must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Returns:

The reduce

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReduceNodeDegree0

void setReduceNodeDegree0(boolean reduce)
                          throws IOException,
                                 AutomationException

Indicates if the disconnected nodes (that is, the nodes with degree 0) must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Parameters:

reduce - The reduce (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReduceNodeDegree1

boolean isReduceNodeDegree1()
                            throws IOException,
                                   AutomationException

Indicates if the leaves nodes (that is, the nodes with degree 1) must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Returns:

The reduce

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReduceNodeDegree1

void setReduceNodeDegree1(boolean reduce)
                          throws IOException,
                                 AutomationException

Indicates if the leaves nodes (that is, the nodes with degree 1) must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Parameters:

reduce - The reduce (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReduceNodeDegree2

boolean isReduceNodeDegree2()
                            throws IOException,
                                   AutomationException

Indicates if the nodes with degree 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Returns:

The reduce

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReduceNodeDegree2

void setReduceNodeDegree2(boolean reduce)
                          throws IOException,
                                 AutomationException

Indicates if the nodes with degree 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Parameters:

reduce - The reduce (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReduceNodeDegreeSup3

boolean isReduceNodeDegreeSup3()
                               throws IOException,
                                      AutomationException

Indicates if the nodes with a degree upper than 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Returns:

The reduce

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReduceNodeDegreeSup3

void setReduceNodeDegreeSup3(boolean reduce)
                             throws IOException,
                                    AutomationException

Indicates if the nodes with a degree upper than 2 must be automatically reduced by the Schematic Node Reduction By Priority rule.

Product Availability

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

Parameters:

reduce - The reduce (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getActivePriority

int getActivePriority()
                      throws IOException,
                             AutomationException

Indicates if the element class priority is activated.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicReductionPriority constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setActivePriority

void setActivePriority(int priority)
                       throws IOException,
                              AutomationException

Indicates if the element class priority is activated.

Product Availability

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

Parameters:

priority - A com.esri.arcgis.schematic.esriSchematicReductionPriority constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOrderedElementClassPriorities

Object getOrderedElementClassPriorities()
                                        throws IOException,
                                               AutomationException

List of the element class names ordered by their decreasing priority for the Schematic Node Reduction By Priority rule.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOrderedElementClassPriorities

void setOrderedElementClassPriorities(Object names)
                                      throws IOException,
                                             AutomationException

List of the element class names ordered by their decreasing priority for the Schematic Node Reduction By Priority rule.

Product Availability

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

Parameters:

names - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReduceIfOnlyTwoChoicesWithSamePriority

boolean isReduceIfOnlyTwoChoicesWithSamePriority()
                                                 throws IOException,
                                                        AutomationException

Indicates if the Schematic Node Reduction By Priority rule occurs if there are only two possibilities to apply the rule and if these solutions have the same priority.

Product Availability

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

Returns:

The reduce

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReduceIfOnlyTwoChoicesWithSamePriority

void setReduceIfOnlyTwoChoicesWithSamePriority(boolean reduce)
                                               throws IOException,
                                                      AutomationException

Indicates if the Schematic Node Reduction By Priority rule occurs if there are only two possibilities to apply the rule and if these solutions have the same priority.

Product Availability

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

Parameters:

reduce - The reduce (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementClassPrioritiesToReduceAlways

Object getElementClassPrioritiesToReduceAlways()
                                               throws IOException,
                                                      AutomationException

List of the element class names the Schematic Node Reduction By Priority rule must always reduce ordered by their decreasing priority.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setElementClassPrioritiesToReduceAlways

void setElementClassPrioritiesToReduceAlways(Object names)
                                             throws IOException,
                                                    AutomationException

List of the element class names the Schematic Node Reduction By Priority rule must always reduce ordered by their decreasing priority.

Product Availability

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

Parameters:

names - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExtendedCriteriaUsed

boolean isExtendedCriteriaUsed()
                               throws IOException,
                                      AutomationException

Indicates if additional extended criteria is used.

Product Availability

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

Returns:

The extendedCriteriaUsed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaUsed

void setExtendedCriteriaUsed(boolean extendedCriteriaUsed)
                             throws IOException,
                                    AutomationException

Indicates if additional extended criteria is used.

Product Availability

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

Parameters:

extendedCriteriaUsed - The extendedCriteriaUsed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedCriteriaName

String getExtendedCriteriaName()
                               throws IOException,
                                      AutomationException

Name of the extended criteria.

Product Availability

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

Returns:

The extendedCriteriaName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaName

void setExtendedCriteriaName(String extendedCriteriaName)
                             throws IOException,
                                    AutomationException

Name of the extended criteria.

Remarks

An extended criteria for the Node Reduction By Priority rule is a component that implements the ISchematicNodeReductionExtended interface.

Product Availability

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

Parameters:

extendedCriteriaName - The extendedCriteriaName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.