com.esri.arcgis.schematic
Interface ISchematicRelationshipRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicRelationshipRule

public interface ISchematicRelationshipRule
extends Serializable

Provides access to members that manage the generic Schematic Relationship rule.

Description

The Relationship rule allows you to create schematic elements and/or relations regarding the information stored in a relationship class.

Any schematic relationship rule process is based on the source schematic elements associated with real features/objects that are used in input to generate the diagram. Based on the specified relationship class, these source schematic elements are used to retrieve the related target schematic elements that will be added into the generated diagram, even if these target schematic elements have no real features/objects associated with them in the initial input

Product Availability

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

Method Summary

String	getDescription() Description of the Schematic Relationship rule.
double	getOffsetAngle() Angle of offset at start.
double	getOffsetDistance() Value of the offset distance.
String	getRelationshipClassName() Relationship class name related to the Schematic Relationship rule.
String	getRelationshipElementClassName() Relationship element class name related to the Schematic Relationship rule.
String	getSourceElementClassName() Source element class name related to the Schematic Relationship rule.
String	getTargetElementClassName() Target element class name related to the Schematic Relationship rule.
boolean	isAddRelationBetweenTargetAndSource() Indicates if the relation between target and source must be included in the diagram.
boolean	isAddRelationshipElement() Indicates if the relationship element must be included in the diagram.
boolean	isAddTargetElement() Indicates if the target element must be included in the diagram.
boolean	isInitializeTargetVertices() Indicates if vertices on the target must be initialized.
boolean	isReportSourceRelationOnTarget() Indicates if the source relation must be reported on the target.
boolean	isReportTargetRelationOnConnectedNodes() Indicates if the target relation must be reported on the connected nodes.
boolean	isReverseRelationshipLinkOrientation() Indicates if the relationship link orientation must be reversed.
boolean	isReverseTargetRelation() Indicates if the target relation must be reversed.
void	setAddRelationBetweenTargetAndSource(boolean addRelationBetweenTargetAndSource) Indicates if the relation between target and source must be included in the diagram.
void	setAddRelationshipElement(boolean addRelationshipElement) Indicates if the relationship element must be included in the diagram.
void	setAddTargetElement(boolean addTargetElement) Indicates if the target element must be included in the diagram.
void	setDescription(String description) Description of the Schematic Relationship rule.
void	setInitializeTargetVertices(boolean initializeTargetVertices) Indicates if vertices on the target must be initialized.
void	setOffsetAngle(double offsetAngle) Angle of offset at start.
void	setOffsetDistance(double offsetDistance) Value of the offset distance.
void	setRelationshipClassName(String relationshipClassName) Relationship class name related to the Schematic Relationship rule.
void	setRelationshipElementClassName(String relationshipClassName) Relationship element class name related to the Schematic Relationship rule.
void	setReportSourceRelationOnTarget(boolean reportSourceRelationOnTarget) Indicates if the source relation must be reported on the target.
void	setReportTargetRelationOnConnectedNodes(boolean reportTargetRelationOnConnectedNodes) Indicates if the target relation must be reported on the connected nodes.
void	setReverseRelationshipLinkOrientation(boolean reverseRelationshipLinkOrientation) Indicates if the relationship link orientation must be reversed.
void	setReverseTargetRelation(boolean reverseTargetRelation) Indicates if the target relation must be reversed.
void	setSourceElementClassName(String sourceClassName) Source element class name related to the Schematic Relationship rule.
void	setTargetElementClassName(String targetClassName) Target element class name related to the Schematic Relationship rule.

Method Detail

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the Schematic Relationship rule.

Product Availability

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

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(String description)
                    throws IOException,
                           AutomationException

Description of the Schematic Relationship rule.

Product Availability

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

Parameters:

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipClassName

String getRelationshipClassName()
                                throws IOException,
                                       AutomationException

Relationship class name related to the Schematic Relationship rule.

Product Availability

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

Returns:

The relationshipClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationshipClassName

void setRelationshipClassName(String relationshipClassName)
                              throws IOException,
                                     AutomationException

Relationship class name related to the Schematic Relationship rule.

Product Availability

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

Parameters:

relationshipClassName - The relationshipClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceElementClassName

String getSourceElementClassName()
                                 throws IOException,
                                        AutomationException

Source element class name related to the Schematic Relationship rule.

Product Availability

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

Returns:

The sourceClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceElementClassName

void setSourceElementClassName(String sourceClassName)
                               throws IOException,
                                      AutomationException

Source element class name related to the Schematic Relationship rule.

Product Availability

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

Parameters:

sourceClassName - The sourceClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetElementClassName

String getTargetElementClassName()
                                 throws IOException,
                                        AutomationException

Target element class name related to the Schematic Relationship rule.

Product Availability

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

Returns:

The targetClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetElementClassName

void setTargetElementClassName(String targetClassName)
                               throws IOException,
                                      AutomationException

Target element class name related to the Schematic Relationship rule.

Product Availability

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

Parameters:

targetClassName - The targetClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipElementClassName

String getRelationshipElementClassName()
                                       throws IOException,
                                              AutomationException

Relationship element class name related to the Schematic Relationship rule.

Product Availability

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

Returns:

The relationshipClassName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationshipElementClassName

void setRelationshipElementClassName(String relationshipClassName)
                                     throws IOException,
                                            AutomationException

Relationship element class name related to the Schematic Relationship rule.

Product Availability

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

Parameters:

relationshipClassName - The relationshipClassName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddTargetElement

boolean isAddTargetElement()
                           throws IOException,
                                  AutomationException

Indicates if the target element must be included in the diagram.

Product Availability

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

Returns:

The addTargetElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddTargetElement

void setAddTargetElement(boolean addTargetElement)
                         throws IOException,
                                AutomationException

Indicates if the target element must be included in the diagram.

Product Availability

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

Parameters:

addTargetElement - The addTargetElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddRelationBetweenTargetAndSource

boolean isAddRelationBetweenTargetAndSource()
                                            throws IOException,
                                                   AutomationException

Indicates if the relation between target and source must be included in the diagram.

Product Availability

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

Returns:

The addRelationBetweenTargetAndSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddRelationBetweenTargetAndSource

void setAddRelationBetweenTargetAndSource(boolean addRelationBetweenTargetAndSource)
                                          throws IOException,
                                                 AutomationException

Indicates if the relation between target and source must be included in the diagram.

Product Availability

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

Parameters:

addRelationBetweenTargetAndSource - The addRelationBetweenTargetAndSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReverseTargetRelation

boolean isReverseTargetRelation()
                                throws IOException,
                                       AutomationException

Indicates if the target relation must be reversed.

Product Availability

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

Returns:

The reverseTargetRelation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReverseTargetRelation

void setReverseTargetRelation(boolean reverseTargetRelation)
                              throws IOException,
                                     AutomationException

Indicates if the target relation must be reversed.

Product Availability

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

Parameters:

reverseTargetRelation - The reverseTargetRelation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitializeTargetVertices

void setInitializeTargetVertices(boolean initializeTargetVertices)
                                 throws IOException,
                                        AutomationException

Indicates if vertices on the target must be initialized.

Product Availability

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

Parameters:

initializeTargetVertices - The initializeTargetVertices (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInitializeTargetVertices

boolean isInitializeTargetVertices()
                                   throws IOException,
                                          AutomationException

Indicates if vertices on the target must be initialized.

Product Availability

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

Returns:

The initializeTargetVertices

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReportSourceRelationOnTarget

boolean isReportSourceRelationOnTarget()
                                       throws IOException,
                                              AutomationException

Indicates if the source relation must be reported on the target.

Product Availability

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

Returns:

The reportSourceRelationOnTarget

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportSourceRelationOnTarget

void setReportSourceRelationOnTarget(boolean reportSourceRelationOnTarget)
                                     throws IOException,
                                            AutomationException

Indicates if the source relation must be reported on the target.

Product Availability

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

Parameters:

reportSourceRelationOnTarget - The reportSourceRelationOnTarget (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReportTargetRelationOnConnectedNodes

boolean isReportTargetRelationOnConnectedNodes()
                                               throws IOException,
                                                      AutomationException

Indicates if the target relation must be reported on the connected nodes.

Product Availability

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

Returns:

The reportTargetRelationOnConnectedNodes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportTargetRelationOnConnectedNodes

void setReportTargetRelationOnConnectedNodes(boolean reportTargetRelationOnConnectedNodes)
                                             throws IOException,
                                                    AutomationException

Indicates if the target relation must be reported on the connected nodes.

Product Availability

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

Parameters:

reportTargetRelationOnConnectedNodes - The reportTargetRelationOnConnectedNodes (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddRelationshipElement

boolean isAddRelationshipElement()
                                 throws IOException,
                                        AutomationException

Indicates if the relationship element must be included in the diagram.

Product Availability

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

Returns:

The addRelationshipElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddRelationshipElement

void setAddRelationshipElement(boolean addRelationshipElement)
                               throws IOException,
                                      AutomationException

Indicates if the relationship element must be included in the diagram.

Product Availability

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

Parameters:

addRelationshipElement - The addRelationshipElement (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReverseRelationshipLinkOrientation

boolean isReverseRelationshipLinkOrientation()
                                             throws IOException,
                                                    AutomationException

Indicates if the relationship link orientation must be reversed.

Product Availability

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

Returns:

The reverseRelationshipLinkOrientation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReverseRelationshipLinkOrientation

void setReverseRelationshipLinkOrientation(boolean reverseRelationshipLinkOrientation)
                                           throws IOException,
                                                  AutomationException

Indicates if the relationship link orientation must be reversed.

Product Availability

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

Parameters:

reverseRelationshipLinkOrientation - The reverseRelationshipLinkOrientation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffsetDistance

double getOffsetDistance()
                         throws IOException,
                                AutomationException

Value of the offset distance.

Product Availability

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

Returns:

The offsetDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffsetDistance

void setOffsetDistance(double offsetDistance)
                       throws IOException,
                              AutomationException

Value of the offset distance.

Product Availability

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

Parameters:

offsetDistance - The offsetDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOffsetAngle

double getOffsetAngle()
                      throws IOException,
                             AutomationException

Angle of offset at start.

Product Availability

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

Returns:

The offsetAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOffsetAngle

void setOffsetAngle(double offsetAngle)
                    throws IOException,
                           AutomationException

Angle of offset at start.

Product Availability

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

Parameters:

offsetAngle - The offsetAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.