com.esri.arcgis.schematic
Class SchematicNodeReductionRuleByFlow

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, ISchematicNodeReductionRule, ISchematicNodeReductionRuleByFlow, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, Serializable

public class SchematicNodeReductionRuleByFlow
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISchematicRule, ISchematicRuleDesign, ISchematicRuleFilter, ISchematicNodeReductionRule, ISchematicNodeReductionRuleByFlow

Schematic Node Reduction By Flow rule object.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

SchematicNodeReductionRuleByFlow()
Constructs a SchematicNodeReductionRuleByFlow using ArcGIS Engine.

SchematicNodeReductionRuleByFlow(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SchematicNodeReductionRuleByFlow theSchematicNodeReductionRuleByFlow = (SchematicNodeReductionRuleByFlow) 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	getIncidentLinkAttributeName() Name of the attribute field that use for the link attribute option.
String	getName() Name of the schematic rule.
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.
ISchematicDiagramClass	getSchematicDiagramClass() Schematic diagram class related to the schematic rule.
String	getSuperSpanClassName() Schematic Super Span element class name related to the Schematic Node Reduction By Flow rule.
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	isReduceSinks() Indicates if the reduction reduces the sinks.
boolean	isReduceSources() Indicates if the reduction reduces the sources.
boolean	isUseFromLinkClass() Indicates if the Schematic Node Reduction By Flow rule must keep the from link schematic element class for the link created during the reduction.
boolean	isUseIncidentLinkAttribute() Indicates if the Schematic Node Reduction rule use the link attribute.
boolean	isUseSuperSpanClass() Indicates if the Schematic Node Reduction By Flow rule must work with the super span class.
void	setDescription(String description) Description of the Schematic Node Reduction rule.
void	setIncidentLinkAttributeName(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(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	setReduceSinks(boolean reduceSinks) Indicates if the reduction reduces the sinks.
void	setReduceSources(boolean reduceSources) Indicates if the reduction reduces the sources.
void	setSchematicDiagramClassByRef(ISchematicDiagramClass schematicDiagramClass) Schematic diagram class related to the schematic builder.
void	setSuperSpanClassName(String superSpanClassName) Schematic Super Span element class name related to the Schematic Node Reduction By Flow rule.
void	setUseFromLinkClass(boolean useFromLinkClass) Indicates if the Schematic Node Reduction By Flow rule must keep the from link schematic element class for the link created during the reduction.
void	setUseIncidentLinkAttribute(boolean useIncidentLinkAttribute) Indicates if the Schematic Node Reduction rule use the link attribute.
void	setUseSuperSpanClass(boolean useSuperSpanClass) Indicates if the Schematic Node Reduction By Flow rule must work with the super span class.
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

SchematicNodeReductionRuleByFlow

public SchematicNodeReductionRuleByFlow()
                                 throws IOException,
                                        UnknownHostException

Constructs a SchematicNodeReductionRuleByFlow using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SchematicNodeReductionRuleByFlow

public SchematicNodeReductionRuleByFlow(Object obj)
                                 throws IOException

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

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

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.

See Also:

ISchematicRule.getClassID()

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 ISchematicNodeReductionRule

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.

See Also:

ISchematicRule.getName()

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 Node Reduction rule.

Product Availability

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

Specified by:

setDescription in interface ISchematicNodeReductionRule

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 Node Reduction rule; that is, name of the schematic node element class to reduce.

Product Availability

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

Specified by:

getNodeClassName in interface ISchematicNodeReductionRule

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 Node Reduction rule; that is, name of the schematic node element class to reduce.

Product Availability

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

Specified by:

setNodeClassName in interface ISchematicNodeReductionRule

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 Node Reduction rule keeps the links vertices.

Product Availability

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

Specified by:

isKeepVertices in interface ISchematicNodeReductionRule

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 Node Reduction rule keeps the links vertices.

Product Availability

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

Specified by:

setKeepVertices in interface ISchematicNodeReductionRule

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

Product Availability

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

Specified by:

getWhereClause in interface ISchematicNodeReductionRule

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 ISchematicNodeReductionRule

Parameters:

whereClause - The whereClause (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseIncidentLinkAttribute

public boolean isUseIncidentLinkAttribute()
                                   throws IOException,
                                          AutomationException

Indicates if the Schematic Node Reduction rule use the link attribute.

Product Availability

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

Specified by:

isUseIncidentLinkAttribute in interface ISchematicNodeReductionRule

Returns:

The useIncidentLinkAttribute

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseIncidentLinkAttribute

public void setUseIncidentLinkAttribute(boolean useIncidentLinkAttribute)
                                 throws IOException,
                                        AutomationException

Indicates if the Schematic Node Reduction rule use the link attribute.

Product Availability

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

Specified by:

setUseIncidentLinkAttribute in interface ISchematicNodeReductionRule

Parameters:

useIncidentLinkAttribute - The useIncidentLinkAttribute (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIncidentLinkAttributeName

public String getIncidentLinkAttributeName()
                                    throws IOException,
                                           AutomationException

Name of the attribute field that use for the link attribute option.

Product Availability

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

Specified by:

getIncidentLinkAttributeName in interface ISchematicNodeReductionRule

Returns:

The incidentLinkAttributeName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIncidentLinkAttributeName

public void setIncidentLinkAttributeName(String incidentLinkAttributeName)
                                  throws IOException,
                                         AutomationException

Name of the attribute field that use for the link attribute option.

Product Availability

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

Specified by:

setIncidentLinkAttributeName in interface ISchematicNodeReductionRule

Parameters:

incidentLinkAttributeName - The incidentLinkAttributeName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSuperSpanClassName

public String getSuperSpanClassName()
                             throws IOException,
                                    AutomationException

Schematic Super Span element class name related to the Schematic Node Reduction By Flow rule.

Product Availability

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

Specified by:

getSuperSpanClassName in interface ISchematicNodeReductionRuleByFlow

Returns:

The superSpanClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSuperSpanClassName

public void setSuperSpanClassName(String superSpanClassName)
                           throws IOException,
                                  AutomationException

Schematic Super Span element class name related to the Schematic Node Reduction By Flow rule.

Product Availability

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

Specified by:

setSuperSpanClassName in interface ISchematicNodeReductionRuleByFlow

Parameters:

superSpanClassName - The superSpanClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseSuperSpanClass

public boolean isUseSuperSpanClass()
                            throws IOException,
                                   AutomationException

Indicates if the Schematic Node Reduction By Flow rule must work with the super span class.

Product Availability

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

Specified by:

isUseSuperSpanClass in interface ISchematicNodeReductionRuleByFlow

Returns:

The useSuperSpanClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseSuperSpanClass

public void setUseSuperSpanClass(boolean useSuperSpanClass)
                          throws IOException,
                                 AutomationException

Indicates if the Schematic Node Reduction By Flow rule must work with the super span class.

Product Availability

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

Specified by:

setUseSuperSpanClass in interface ISchematicNodeReductionRuleByFlow

Parameters:

useSuperSpanClass - The useSuperSpanClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isUseFromLinkClass

public boolean isUseFromLinkClass()
                           throws IOException,
                                  AutomationException

Indicates if the Schematic Node Reduction By Flow rule must keep the from link schematic element class for the link created during the reduction.

Product Availability

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

Specified by:

isUseFromLinkClass in interface ISchematicNodeReductionRuleByFlow

Returns:

The useFromLinkClass

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUseFromLinkClass

public void setUseFromLinkClass(boolean useFromLinkClass)
                         throws IOException,
                                AutomationException

Indicates if the Schematic Node Reduction By Flow rule must keep the from link schematic element class for the link created during the reduction.

Product Availability

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

Specified by:

setUseFromLinkClass in interface ISchematicNodeReductionRuleByFlow

Parameters:

useFromLinkClass - The useFromLinkClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReduceSources

public boolean isReduceSources()
                        throws IOException,
                               AutomationException

Indicates if the reduction reduces the sources.

Product Availability

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

Specified by:

isReduceSources in interface ISchematicNodeReductionRuleByFlow

Returns:

The reduceSources

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReduceSources

public void setReduceSources(boolean reduceSources)
                      throws IOException,
                             AutomationException

Indicates if the reduction reduces the sources.

Product Availability

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

Specified by:

setReduceSources in interface ISchematicNodeReductionRuleByFlow

Parameters:

reduceSources - The reduceSources (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReduceSinks

public boolean isReduceSinks()
                      throws IOException,
                             AutomationException

Indicates if the reduction reduces the sinks.

Product Availability

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

Specified by:

isReduceSinks in interface ISchematicNodeReductionRuleByFlow

Returns:

The reduceSinks

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReduceSinks

public void setReduceSinks(boolean reduceSinks)
                    throws IOException,
                           AutomationException

Indicates if the reduction reduces the sinks.

Product Availability

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

Specified by:

setReduceSinks in interface ISchematicNodeReductionRuleByFlow

Parameters:

reduceSinks - The reduceSinks (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.