com.esri.arcgis.schematic
Interface ISchematicFeatureRemovalRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicFeatureRemovalRule

public interface ISchematicFeatureRemovalRule
extends Serializable

Provides access to members that manage the rule removing features.

Description

The Feature Removal rule allows you to remove all or particular schematic elements implemented by a given schematic element class from the schematic diagrams.

Remarks

This rule doesn't preserve the network topology during its execution. For example, if schematic nodes are configured for removal, the rule will not try to reconnect their connected links to any target node like the reduction rules do; any node removal will cause its connected links to also be removed from the resulting diagram.

Product Availability

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

Method Summary

String	getAttributeName() Name of the attribute used to filter the feature to remove.
int	getCompareType() Type of comparaison of attribute value.
String	getElementClassName() Name of the schematic link element class related to the Feature removal rule; that is, name of the schematic link element class to reduce.
String	getExtendedCriteriaName() Extended criteria name used to filter the features to remove.
String	getWhereClause() Where clause used on associated feature to filter the schematic elements to reduce.
boolean	isExtendedCriteriaUsed() Indicates if additional extended criteria is used.
boolean	isRemoveOrphanNodes() Indicates if the orphan nodes must be removed.
boolean	isUseAttributeName() Indicates if an attribute is used to filter the feature to remove.
boolean	isUseWhereClause() Indicates if there is an SQL where clause to filter the features to remove.
void	setAttributeName(String attributeName) Name of the attribute used to filter the feature to remove.
void	setCompareType(int compareType) Type of comparaison of attribute value.
void	setDescription(String rhs1) Description of the schematic feature removal rule.
void	setElementClassName(String elementClassName) Name of the schematic link element class related to the Feature removal rule; that is, name of the schematic link element class to reduce.
void	setExtendedCriteriaName(String extendedCriteriaName) Extended criteria name used to filter the features to remove.
void	setExtendedCriteriaUsed(boolean extendedCriteriaUsed) Indicates if additional extended criteria is used.
void	setRemoveOrphanNodes(boolean removeOrphanNodes) Indicates if the orphan nodes must be removed.
void	setUseAttributeName(boolean useAttributeName) Indicates if an attribute is used to filter the feature to remove.
void	setUseWhereClause(boolean useWhereClause) Indicates if there is an SQL where clause to filter the features to remove.
void	setWhereClause(String whereClause) Where clause used on associated feature to filter the schematic elements to reduce.

Method Detail

setDescription

void setDescription(String rhs1)
                    throws IOException,
                           AutomationException

Description of the schematic feature removal rule.

Product Availability

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

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementClassName

String getElementClassName()
                           throws IOException,
                                  AutomationException

Name of the schematic link element class related to the Feature removal rule; that is, name of the schematic link element class to reduce.

Product Availability

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

Returns:

The elementClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setElementClassName

void setElementClassName(String elementClassName)
                         throws IOException,
                                AutomationException

Name of the schematic link element class related to the Feature removal rule; that is, name of the schematic link element class to reduce.

Product Availability

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

Parameters:

elementClassName - The elementClassName (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.

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

Extended criteria name used to filter the features to remove.

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

Extended criteria name used to filter the features to remove.

Remarks

An extended criteria for the Feature Removal rule is a component that implements the ISchematicFeatureRemovalExtended 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.

isRemoveOrphanNodes

boolean isRemoveOrphanNodes()
                            throws IOException,
                                   AutomationException

Indicates if the orphan nodes must be removed.

Product Availability

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

Returns:

The removeOrphanNodes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveOrphanNodes

void setRemoveOrphanNodes(boolean removeOrphanNodes)
                          throws IOException,
                                 AutomationException

Indicates if the orphan nodes must be removed.

Product Availability

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

Parameters:

removeOrphanNodes - The removeOrphanNodes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseWhereClause

boolean isUseWhereClause()
                         throws IOException,
                                AutomationException

Indicates if there is an SQL where clause to filter the features to remove.

Product Availability

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

Returns:

The useWhereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseWhereClause

void setUseWhereClause(boolean useWhereClause)
                       throws IOException,
                              AutomationException

Indicates if there is an SQL where clause to filter the features to remove.

Product Availability

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

Parameters:

useWhereClause - The useWhereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseAttributeName

boolean isUseAttributeName()
                           throws IOException,
                                  AutomationException

Indicates if an attribute is used to filter the feature to remove.

Product Availability

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

Returns:

The useAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseAttributeName

void setUseAttributeName(boolean useAttributeName)
                         throws IOException,
                                AutomationException

Indicates if an attribute is used to filter the feature to remove.

Product Availability

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

Parameters:

useAttributeName - The useAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeName

String getAttributeName()
                        throws IOException,
                               AutomationException

Name of the attribute used to filter the feature to remove.

Product Availability

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

Returns:

The attributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttributeName

void setAttributeName(String attributeName)
                      throws IOException,
                             AutomationException

Name of the attribute used to filter the feature to remove.

Product Availability

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

Parameters:

attributeName - The attributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompareType

int getCompareType()
                   throws IOException,
                          AutomationException

Type of comparaison of attribute value.

Product Availability

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

Returns:

The compareType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompareType

void setCompareType(int compareType)
                    throws IOException,
                           AutomationException

Type of comparaison of attribute value.

Product Availability

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

Parameters:

compareType - The compareType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.