com.esri.arcgis.schematic
Class SchematicCollapseRelatedElementsRule

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicCollapseRelatedElementsRule
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicCollapseRelatedElementsRule, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, Serializable

public class SchematicCollapseRelatedElementsRule
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, ISchematicCollapseRelatedElementsRule

Schematic Collapse Related Elements rule object.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
SchematicCollapseRelatedElementsRule()
          Constructs a SchematicCollapseRelatedElementsRule using ArcGIS Engine.
SchematicCollapseRelatedElementsRule(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicCollapseRelatedElementsRule theSchematicCollapseRelatedElementsRule = (SchematicCollapseRelatedElementsRule) 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
 IUID getClassID()
          ClassID of the schematic rule.
static String getClsid()
          getClsid.
 String getDescription()
          Description of the schematic rule.
 String getExtendedCriteriaName()
          Name of the extended criteria.
 String getName()
          Name of the schematic rule.
 String getNodeClassName()
          Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.
 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 collapse.
 int hashCode()
          the hashcode for this object
 boolean isExtendedCriteriaUsed()
          Indicates if additional extended criteria is used.
 boolean isKeepVertices()
          Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.
 void setDescription(String description)
          Description of the Schematic Collapse Related Elements rule.
 void setExtendedCriteriaName(String extendedCriteriaName)
          Name of the extended criteria.
 void setExtendedCriteriaUsed(boolean extendedCriteriaUsed)
          Indicates if additional extended criteria is used.
 void setKeepVertices(boolean keepVertices)
          Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.
 void setNodeClassName(String nodeClassName)
          Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.
 void setPropertySet(IPropertySet rhs1)
          PropertySet related to the schematic rule.
 void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
          Schematic diagram class related to the schematic builder.
 void setWhereClause(String whereClause)
          Where clause used on associated feature to filter the schematic elements to collapse.
 
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

SchematicCollapseRelatedElementsRule

public SchematicCollapseRelatedElementsRule()
                                     throws IOException,
                                            UnknownHostException
Constructs a SchematicCollapseRelatedElementsRule using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

SchematicCollapseRelatedElementsRule

public SchematicCollapseRelatedElementsRule(Object obj)
                                     throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicCollapseRelatedElementsRule theSchematicCollapseRelatedElementsRule = (SchematicCollapseRelatedElementsRule) obj;

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

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 ISchematicCollapseRelatedElementsRule
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 description)
                    throws IOException,
                           AutomationException
Description of the Schematic Collapse Related Elements rule.

Product Availability

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

Specified by:
setDescription in interface ISchematicCollapseRelatedElementsRule
Parameters:
description - The description (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNodeClassName

public String getNodeClassName()
                        throws IOException,
                               AutomationException
Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.

Product Availability

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

Specified by:
getNodeClassName in interface ISchematicCollapseRelatedElementsRule
Returns:
The nodeClassName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setNodeClassName

public void setNodeClassName(String nodeClassName)
                      throws IOException,
                             AutomationException
Name of the schematic node element class related to the Schematic Collapse Related Elements rule; that is, name of the schematic node element class to collapse.

Product Availability

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

Specified by:
setNodeClassName in interface ISchematicCollapseRelatedElementsRule
Parameters:
nodeClassName - The nodeClassName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isKeepVertices

public boolean isKeepVertices()
                       throws IOException,
                              AutomationException
Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.

Product Availability

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

Specified by:
isKeepVertices in interface ISchematicCollapseRelatedElementsRule
Returns:
The keepVertices
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setKeepVertices

public void setKeepVertices(boolean keepVertices)
                     throws IOException,
                            AutomationException
Indicates if the Schematic Collapse Related Elements rule keeps the links vertices.

Product Availability

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

Specified by:
setKeepVertices in interface ISchematicCollapseRelatedElementsRule
Parameters:
keepVertices - The keepVertices (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 collapse.

Product Availability

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

Specified by:
getWhereClause in interface ISchematicCollapseRelatedElementsRule
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 collapse.

Product Availability

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

Specified by:
setWhereClause in interface ISchematicCollapseRelatedElementsRule
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 ISchematicCollapseRelatedElementsRule
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 ISchematicCollapseRelatedElementsRule
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
Name of the extended criteria.

Product Availability

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

Specified by:
getExtendedCriteriaName in interface ISchematicCollapseRelatedElementsRule
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
Name of the extended criteria.

Remarks

An extended criteria for the Collapse Related Features rule is a component that implements the ISchematicCollapseRelatedElementsExtended interface.

Product Availability

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

Specified by:
setExtendedCriteriaName in interface ISchematicCollapseRelatedElementsRule
Parameters:
extendedCriteriaName - The extendedCriteriaName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.