com.esri.arcgis.schematic
Class SchematicFeatureRemovalRule

java.lang.Object
  com.esri.arcgis.schematic.SchematicFeatureRemovalRule

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicFeatureRemovalRule, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, Serializable

public class SchematicFeatureRemovalRule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, ISchematicFeatureRemovalRule

Schematic feature removal rule object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicFeatureRemovalRule()
Constructs a SchematicFeatureRemovalRule using ArcGIS Engine.

SchematicFeatureRemovalRule(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicFeatureRemovalRule theSchematicFeatureRemovalRule = (SchematicFeatureRemovalRule) obj;

Method Summary

void	alter(ISchematicDiagramClass schematicDiagramClass, IPropertySet propertySet) Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.
void	apply(ISchematicInMemoryDiagram inMemoryDiagram, ITrackCancel cancelTracker) Applies the schematic rule on the specified schematic in memory diagram.
boolean	canApply(ISchematicBuilder schematicBuiler) Indicates if the rule can apply to the given builder.
void	detach() Detach rule from dataset.
boolean	equals(Object o) Compare this object with another
String	getAttributeName() Name of the attribute used to filter the feature to remove.
IUID	getClassID() ClassID of the schematic rule.
static String	getClsid() getClsid.
int	getCompareType() Type of comparaison of attribute value.
String	getDescription() Description of the schematic rule.
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	getName() Name of the schematic rule.
IPropertySet	getPropertySet() PropertySet related to the schematic rule.
ISchematicDiagramClass	getSchematicDiagramClass() Schematic diagram class related to the schematic rule.
String	getWhereClause() Where clause used on associated feature to filter the schematic elements to reduce.
int	hashCode() the hashcode for this object
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	setPropertySet(IPropertySet rhs1) PropertySet related to the schematic rule.
void	setRemoveOrphanNodes(boolean removeOrphanNodes) Indicates if the orphan nodes must be removed.
void	setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass) Schematic diagram class related to the schematic builder.
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SchematicFeatureRemovalRule

public SchematicFeatureRemovalRule()
                            throws IOException,
                                   UnknownHostException

Constructs a SchematicFeatureRemovalRule using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicFeatureRemovalRule

public SchematicFeatureRemovalRule(Object obj)
                            throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicFeatureRemovalRule theSchematicFeatureRemovalRule = (SchematicFeatureRemovalRule) obj;

Construct a SchematicFeatureRemovalRule using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SchematicFeatureRemovalRule.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getName

public String getName()
               throws IOException,
                      AutomationException

Name of the schematic rule.

Product Availability

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

Specified by:

getName in interface ISchematicRule

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDescription

public String getDescription()
                      throws IOException,
                             AutomationException

Description of the schematic rule.

Product Availability

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

Specified by:

getDescription in interface ISchematicRule

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

ClassID of the schematic rule.

Product Availability

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

Specified by:

getClassID in interface ISchematicRule

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

PropertySet related to the schematic rule.

Product Availability

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

Specified by:

getPropertySet in interface ISchematicRule

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws IOException,
                                                       AutomationException

Schematic diagram class related to the schematic rule.

Product Availability

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

Specified by:

getSchematicDiagramClass in interface ISchematicRule

Specified by:

getSchematicDiagramClass in interface ISchematicRuleDesign

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alter

public void alter(ISchematicDiagramClass schematicDiagramClass,
                  IPropertySet propertySet)
           throws IOException,
                  AutomationException

Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.

Product Availability

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

Specified by:

alter in interface ISchematicRule

Parameters:

schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

apply

public void apply(ISchematicInMemoryDiagram inMemoryDiagram,
                  ITrackCancel cancelTracker)
           throws IOException,
                  AutomationException

Applies the schematic rule on the specified schematic in memory diagram.

Product Availability

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

Specified by:

apply in interface ISchematicRule

Parameters:

inMemoryDiagram - A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram (in)

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet rhs1)
                    throws IOException,
                           AutomationException

PropertySet related to the schematic rule.

Product Availability

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

Specified by:

setPropertySet in interface ISchematicRuleDesign

Parameters:

rhs1 - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassByRef

public void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
                                   throws IOException,
                                          AutomationException

Schematic diagram class related to the schematic builder.

Product Availability

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

Specified by:

setSchematicDiagramClassByRef in interface ISchematicRuleDesign

Parameters:

schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws IOException,
                   AutomationException

Detach rule from dataset.

Product Availability

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

Specified by:

detach in interface ISchematicRuleDesign

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(ISchematicBuilder schematicBuiler)
                 throws IOException,
                        AutomationException

Indicates if the rule can apply to the given builder.

Product Availability

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

Specified by:

canApply in interface ISchematicRuleFilter

Parameters:

schematicBuiler - A reference to a com.esri.arcgis.schematic.ISchematicBuilder (in)

Returns:

The apply

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

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

Specified by:

setDescription in interface ISchematicFeatureRemovalRule

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElementClassName

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

Specified by:

getElementClassName in interface ISchematicFeatureRemovalRule

Returns:

The elementClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setElementClassName

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

Specified by:

setElementClassName in interface ISchematicFeatureRemovalRule

Parameters:

elementClassName - The elementClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

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

Specified by:

getWhereClause in interface ISchematicFeatureRemovalRule

Returns:

The whereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

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

Specified by:

setWhereClause in interface ISchematicFeatureRemovalRule

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isExtendedCriteriaUsed

public boolean isExtendedCriteriaUsed()
                               throws IOException,
                                      AutomationException

Indicates if additional extended criteria is used.

Product Availability

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

Specified by:

isExtendedCriteriaUsed in interface ISchematicFeatureRemovalRule

Returns:

The extendedCriteriaUsed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaUsed

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

Specified by:

setExtendedCriteriaUsed in interface ISchematicFeatureRemovalRule

Parameters:

extendedCriteriaUsed - The extendedCriteriaUsed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtendedCriteriaName

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

Specified by:

getExtendedCriteriaName in interface ISchematicFeatureRemovalRule

Returns:

The extendedCriteriaName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtendedCriteriaName

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

Specified by:

setExtendedCriteriaName in interface ISchematicFeatureRemovalRule

Parameters:

extendedCriteriaName - The extendedCriteriaName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRemoveOrphanNodes

public boolean isRemoveOrphanNodes()
                            throws IOException,
                                   AutomationException

Indicates if the orphan nodes must be removed.

Product Availability

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

Specified by:

isRemoveOrphanNodes in interface ISchematicFeatureRemovalRule

Returns:

The removeOrphanNodes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRemoveOrphanNodes

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

Specified by:

setRemoveOrphanNodes in interface ISchematicFeatureRemovalRule

Parameters:

removeOrphanNodes - The removeOrphanNodes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseWhereClause

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

Specified by:

isUseWhereClause in interface ISchematicFeatureRemovalRule

Returns:

The useWhereClause

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseWhereClause

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

Specified by:

setUseWhereClause in interface ISchematicFeatureRemovalRule

Parameters:

useWhereClause - The useWhereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseAttributeName

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

Specified by:

isUseAttributeName in interface ISchematicFeatureRemovalRule

Returns:

The useAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseAttributeName

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

Specified by:

setUseAttributeName in interface ISchematicFeatureRemovalRule

Parameters:

useAttributeName - The useAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAttributeName

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

Specified by:

getAttributeName in interface ISchematicFeatureRemovalRule

Returns:

The attributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAttributeName

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

Specified by:

setAttributeName in interface ISchematicFeatureRemovalRule

Parameters:

attributeName - The attributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCompareType

public int getCompareType()
                   throws IOException,
                          AutomationException

Type of comparaison of attribute value.

Product Availability

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

Specified by:

getCompareType in interface ISchematicFeatureRemovalRule

Returns:

The compareType

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCompareType

public void setCompareType(int compareType)
                    throws IOException,
                           AutomationException

Type of comparaison of attribute value.

Product Availability

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

Specified by:

setCompareType in interface ISchematicFeatureRemovalRule

Parameters:

compareType - The compareType (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.