com.esri.arcgis.schematic
Class SchematicRouteNodeReductionRule

java.lang.Object
  extended by com.esri.arcgis.schematic.SchematicRouteNodeReductionRule
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISchematicNodeReductionRule, ISchematicRouteNodeReductionRule, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, java.io.Serializable

public class SchematicRouteNodeReductionRule
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, ISchematicNodeReductionRule, ISchematicRouteNodeReductionRule

COM Class 'SchematicRouteNodeReductionRule'. Generated 3/19/2015 1:20:46 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description 'Schematic Route Node Reduction rule object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicRule
IID, IID0f611689_2c12_4e4d_80b9_cca2b3d5c7f4, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicRuleDesign
IID, IIDf11386df_d11d_4b5b_8d80_05cd6fb7d2e5, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicRuleFilter
IID, IID3baea23d_9486_4680_810d_c54ea50ea610, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicNodeReductionRule
IID, IID408e7ab3_d216_49ae_b683_017edb258d0f, xxDummy
 
Fields inherited from interface com.esri.arcgis.schematic.ISchematicRouteNodeReductionRule
IID, IIDc3ac385d_7157_489a_9d07_01e2c043ab71, xxDummy
 
Constructor Summary
SchematicRouteNodeReductionRule()
          Constructs a SchematicRouteNodeReductionRule using ArcGIS Engine.
SchematicRouteNodeReductionRule(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicRouteNodeReductionRule theSchematicRouteNodeReductionRule = (SchematicRouteNodeReductionRule) 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(java.lang.Object o)
          Compare this object with another
 IUID getClassID()
          ClassID of the schematic rule.
static java.lang.String getClsid()
          getClsid.
 java.lang.String getDescription()
          Description of the schematic rule.
 java.lang.String getIncidentLinkAttributeName()
          Name of the attribute field that use for the link attribute option.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 java.lang.String getName()
          Name of the schematic rule.
 java.lang.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.
 IPropertySet getPropertySet()
          PropertySet related to the schematic rule.
 int getReduceAngle()
          Reduction angle of the rule.
 ISchematicDiagramClass getSchematicDiagramClass()
          Schematic diagram class related to the schematic rule.
 java.lang.String getWhereClause()
          Where clause used on associated feature to filter the schematic elements to reduce.
 int hashCode()
          the hashcode for this object
 boolean isKeepVertices()
          Indicates if the Schematic Node Reduction rule keeps the links vertices.
 boolean isReduceByAngle()
          Indicates if the reduction reduces all the nodes.
 boolean isUseIncidentLinkAttribute()
          Indicates if the Schematic Node Reduction rule use the link attribute.
 void release()
          Release a SchematicRouteNodeReductionRule.
 void setDescription(java.lang.String description)
          Description of the Schematic Node Reduction rule.
 void setIncidentLinkAttributeName(java.lang.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(java.lang.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 setPropertySet(IPropertySet rhs1)
          PropertySet related to the schematic rule.
 void setReduceAngle(int reduceAngle)
          Reduction angle of the rule.
 void setReduceByAngle(boolean reduceByAngle)
          Indicates if the reduction reduces all the nodes.
 void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
          Schematic diagram class related to the schematic builder.
 void setUseIncidentLinkAttribute(boolean useIncidentLinkAttribute)
          Indicates if the Schematic Node Reduction rule use the link attribute.
 void setWhereClause(java.lang.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
 

Constructor Detail

SchematicRouteNodeReductionRule

public SchematicRouteNodeReductionRule()
                                throws java.io.IOException,
                                       java.net.UnknownHostException
Constructs a SchematicRouteNodeReductionRule using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

SchematicRouteNodeReductionRule

public SchematicRouteNodeReductionRule(java.lang.Object obj)
                                throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicRouteNodeReductionRule theSchematicRouteNodeReductionRule = (SchematicRouteNodeReductionRule) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a SchematicRouteNodeReductionRule.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Name of the schematic rule.

Specified by:
getName in interface ISchematicRule
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
Description of the schematic rule.

Specified by:
getDescription in interface ISchematicNodeReductionRule
Specified by:
getDescription in interface ISchematicRule
Returns:
The description
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException
ClassID of the schematic rule.

Specified by:
getClassID in interface ISchematicRule
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertySet

public IPropertySet getPropertySet()
                            throws java.io.IOException,
                                   AutomationException
PropertySet related to the schematic rule.

Specified by:
getPropertySet in interface ISchematicRule
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSchematicDiagramClass

public ISchematicDiagramClass getSchematicDiagramClass()
                                                throws java.io.IOException,
                                                       AutomationException
Schematic diagram class related to the schematic rule.

Specified by:
getSchematicDiagramClass in interface ISchematicRule
Specified by:
getSchematicDiagramClass in interface ISchematicRuleDesign
Returns:
A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

alter

public void alter(ISchematicDiagramClass schematicDiagramClass,
                  IPropertySet propertySet)
           throws java.io.IOException,
                  AutomationException
Changes the schematic rule for the specified schematic diagram class with the specified rule type PropertySet.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

apply

public void apply(ISchematicInMemoryDiagram inMemoryDiagram,
                  ITrackCancel cancelTracker)
           throws java.io.IOException,
                  AutomationException
Applies the schematic rule on the specified schematic in memory diagram.

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:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPropertySet

public void setPropertySet(IPropertySet rhs1)
                    throws java.io.IOException,
                           AutomationException
PropertySet related to the schematic rule.

Specified by:
setPropertySet in interface ISchematicRuleDesign
Parameters:
rhs1 - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSchematicDiagramClassByRef

public void setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass)
                                   throws java.io.IOException,
                                          AutomationException
Schematic diagram class related to the schematic builder.

Specified by:
setSchematicDiagramClassByRef in interface ISchematicRuleDesign
Parameters:
schematicDiagramClass - A reference to a com.esri.arcgis.schematic.ISchematicDiagramClass (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws java.io.IOException,
                   AutomationException
Detach rule from dataset.

Specified by:
detach in interface ISchematicRuleDesign
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canApply

public boolean canApply(ISchematicBuilder schematicBuiler)
                 throws java.io.IOException,
                        AutomationException
Indicates if the rule can apply to the given builder.

Specified by:
canApply in interface ISchematicRuleFilter
Parameters:
schematicBuiler - A reference to a com.esri.arcgis.schematic.ISchematicBuilder (in)
Returns:
The apply
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException
Description of the Schematic Node Reduction rule.

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

getNodeClassName

public java.lang.String getNodeClassName()
                                  throws java.io.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.

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

setNodeClassName

public void setNodeClassName(java.lang.String nodeClassName)
                      throws java.io.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.

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

isKeepVertices

public boolean isKeepVertices()
                       throws java.io.IOException,
                              AutomationException
Indicates if the Schematic Node Reduction rule keeps the links vertices.

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

setKeepVertices

public void setKeepVertices(boolean keepVertices)
                     throws java.io.IOException,
                            AutomationException
Indicates if the Schematic Node Reduction rule keeps the links vertices.

Specified by:
setKeepVertices in interface ISchematicNodeReductionRule
Parameters:
keepVertices - The keepVertices (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException
Where clause used on associated feature to filter the schematic elements to reduce.

Specified by:
getWhereClause in interface ISchematicNodeReductionRule
Returns:
The whereClause
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException
Where clause used on associated feature to filter the schematic elements to reduce.

Specified by:
setWhereClause in interface ISchematicNodeReductionRule
Parameters:
whereClause - The whereClause (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUseIncidentLinkAttribute

public boolean isUseIncidentLinkAttribute()
                                   throws java.io.IOException,
                                          AutomationException
Indicates if the Schematic Node Reduction rule use the link attribute.

Specified by:
isUseIncidentLinkAttribute in interface ISchematicNodeReductionRule
Returns:
The useIncidentLinkAttribute
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUseIncidentLinkAttribute

public void setUseIncidentLinkAttribute(boolean useIncidentLinkAttribute)
                                 throws java.io.IOException,
                                        AutomationException
Indicates if the Schematic Node Reduction rule use the link attribute.

Specified by:
setUseIncidentLinkAttribute in interface ISchematicNodeReductionRule
Parameters:
useIncidentLinkAttribute - The useIncidentLinkAttribute (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getIncidentLinkAttributeName

public java.lang.String getIncidentLinkAttributeName()
                                              throws java.io.IOException,
                                                     AutomationException
Name of the attribute field that use for the link attribute option.

Specified by:
getIncidentLinkAttributeName in interface ISchematicNodeReductionRule
Returns:
The incidentLinkAttributeName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIncidentLinkAttributeName

public void setIncidentLinkAttributeName(java.lang.String incidentLinkAttributeName)
                                  throws java.io.IOException,
                                         AutomationException
Name of the attribute field that use for the link attribute option.

Specified by:
setIncidentLinkAttributeName in interface ISchematicNodeReductionRule
Parameters:
incidentLinkAttributeName - The incidentLinkAttributeName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isReduceByAngle

public boolean isReduceByAngle()
                        throws java.io.IOException,
                               AutomationException
Indicates if the reduction reduces all the nodes.

Specified by:
isReduceByAngle in interface ISchematicRouteNodeReductionRule
Returns:
The reduceByAngle
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReduceByAngle

public void setReduceByAngle(boolean reduceByAngle)
                      throws java.io.IOException,
                             AutomationException
Indicates if the reduction reduces all the nodes.

Specified by:
setReduceByAngle in interface ISchematicRouteNodeReductionRule
Parameters:
reduceByAngle - The reduceByAngle (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getReduceAngle

public int getReduceAngle()
                   throws java.io.IOException,
                          AutomationException
Reduction angle of the rule.

Specified by:
getReduceAngle in interface ISchematicRouteNodeReductionRule
Returns:
The reduceAngle
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setReduceAngle

public void setReduceAngle(int reduceAngle)
                    throws java.io.IOException,
                           AutomationException
Reduction angle of the rule.

Specified by:
setReduceAngle in interface ISchematicRouteNodeReductionRule
Parameters:
reduceAngle - The reduceAngle (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.