com.esri.arcgis.schematic
Interface ISchematicSpatialQueryRule

All Superinterfaces:

Serializable

All Known Implementing Classes:

SchematicSpatialQueryRule

public interface ISchematicSpatialQueryRule
extends Serializable

Provides access to members that manage the generic Schematic Spatial Query rule.

Description

The Spatial Query rule allows you to detect new schematic elements from one or more schematic element classes, based on where their associated GIS features are located in relation to the GIS features in input, and add these detected schematic elements to the generated schematic diagram.

Starting from the set of GIS features specified in input for the diagram generation, this rule queries new GIS features based on their location relative to the input GIS features and adds the associated schematic elements in the generated diagram as though these new detected GIS features were initial input.

Product Availability

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

Method Summary

double	getBufferDistance() Spatial buffer distance of the Schematic Spatial Query rule.
int	getBufferUnits() Spatial buffer units of the Schematic Spatial Query rule.
String	getDescription() Description of the Schematic Spatial Query rule.
String	getRelationshipElementClassName() Relationship element class name related to the Schematic Relationship rule.
int	getSearchMethod() List of the target element class names.
String	getSourceElementClassName() Source element class name related to the Schematic Spatial Query rule.
Object	getTargetElementClassNames() List of the target element class names.
boolean	isAddElements() Indicates if the elements detected by the Schematic Spatial Query rule must be included in the diagram.
boolean	isAddRelationshipElement() Indicates if the relationship element must be included in the diagram.
boolean	isBufferUsed() Indicates if the Schematic Spatial Query rule uses a spatial buffer.
boolean	isKeepVertices() Indicates if the Schematic Spatial Query rule keeps the links vertices.
boolean	isRelateConnectedNodes() Indicates if the relation must be reported on the origin and end nodes of links when schematic links are returned by the Schematic Spatial Query rule.
boolean	isRelateElements() Indicates if a relation between elements must be initialized.
boolean	isReverseRelation() Indicates if the relation between elements must be reversed.
boolean	isReverseRelationshipLinkOrientation() Indicates if the relationship link orientation must be reversed.
void	setAddElements(boolean addElements) Indicates if the elements detected by the Schematic Spatial Query rule must be included in the diagram.
void	setAddRelationshipElement(boolean addRelationshipElement) Indicates if the relationship element must be included in the diagram.
void	setBufferDistance(double bufferDistance) Spatial buffer distance of the Schematic Spatial Query rule.
void	setBufferUnits(int bufferUnits) Spatial buffer units of the Schematic Spatial Query rule.
void	setBufferUsed(boolean bufferUsed) Indicates if the Schematic Spatial Query rule uses a spatial buffer.
void	setDescription(String description) Description of the Schematic Spatial Query rule.
void	setKeepVertices(boolean keepVertices) Indicates if the Schematic Spatial Query rule keeps the links vertices.
void	setRelateConnectedNodes(boolean relateConnectedNodes) Indicates if the relation must be reported on the origin and end nodes of links when schematic links are returned by the Schematic Spatial Query rule.
void	setRelateElements(boolean relateElements) Indicates if a relation between elements must be initialized.
void	setRelationshipElementClassName(String relationshipClassName) Relationship element class name related to the Schematic Relationship rule.
void	setReverseRelation(boolean reverseTRelation) Indicates if the relation between elements must be reversed.
void	setReverseRelationshipLinkOrientation(boolean reverseRelationshipLinkOrientation) Indicates if the relationship link orientation must be reversed.
void	setSearchMethod(int searchMethod) List of the target element class names.
void	setSourceElementClassName(String sourceClassName) Source element class name related to the Schematic Spatial Query rule.
void	setTargetElementClassNames(Object names) List of the target element class names.

Method Detail

getDescription

String getDescription()
                      throws IOException,
                             AutomationException

Description of the Schematic Spatial Query 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 Spatial Query 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.

getSourceElementClassName

String getSourceElementClassName()
                                 throws IOException,
                                        AutomationException

Source element class name related to the Schematic Spatial Query 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 Spatial Query 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.

getTargetElementClassNames

Object getTargetElementClassNames()
                                  throws IOException,
                                         AutomationException

List of the target element class names.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetElementClassNames

void setTargetElementClassNames(Object names)
                                throws IOException,
                                       AutomationException

List of the target element class names.

Product Availability

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

Parameters:

names - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchMethod

int getSearchMethod()
                    throws IOException,
                           AutomationException

List of the target element class names.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicSpatialQueryRuleSearchMethod constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchMethod

void setSearchMethod(int searchMethod)
                     throws IOException,
                            AutomationException

List of the target element class names.

Product Availability

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

Parameters:

searchMethod - A com.esri.arcgis.schematic.esriSchematicSpatialQueryRuleSearchMethod constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepVertices

boolean isKeepVertices()
                       throws IOException,
                              AutomationException

Indicates if the Schematic Spatial Query rule keeps the links vertices.

Product Availability

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

Returns:

The keepVertices

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepVertices

void setKeepVertices(boolean keepVertices)
                     throws IOException,
                            AutomationException

Indicates if the Schematic Spatial Query rule keeps the links vertices.

Product Availability

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

Parameters:

keepVertices - The keepVertices (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBufferUsed

boolean isBufferUsed()
                     throws IOException,
                            AutomationException

Indicates if the Schematic Spatial Query rule uses a spatial buffer.

Product Availability

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

Returns:

The bufferUsed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferUsed

void setBufferUsed(boolean bufferUsed)
                   throws IOException,
                          AutomationException

Indicates if the Schematic Spatial Query rule uses a spatial buffer.

Product Availability

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

Parameters:

bufferUsed - The bufferUsed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferDistance

double getBufferDistance()
                         throws IOException,
                                AutomationException

Spatial buffer distance of the Schematic Spatial Query rule.

Product Availability

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

Returns:

The bufferDistance

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferDistance

void setBufferDistance(double bufferDistance)
                       throws IOException,
                              AutomationException

Spatial buffer distance of the Schematic Spatial Query rule.

Product Availability

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

Parameters:

bufferDistance - The bufferDistance (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferUnits

int getBufferUnits()
                   throws IOException,
                          AutomationException

Spatial buffer units of the Schematic Spatial Query rule.

Product Availability

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

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferUnits

void setBufferUnits(int bufferUnits)
                    throws IOException,
                           AutomationException

Spatial buffer units of the Schematic Spatial Query rule.

Product Availability

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

Parameters:

bufferUnits - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddElements

boolean isAddElements()
                      throws IOException,
                             AutomationException

Indicates if the elements detected by the Schematic Spatial Query rule must be included in the diagram.

Product Availability

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

Returns:

The addElements

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddElements

void setAddElements(boolean addElements)
                    throws IOException,
                           AutomationException

Indicates if the elements detected by the Schematic Spatial Query rule must be included in the diagram.

Product Availability

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

Parameters:

addElements - The addElements (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRelateElements

boolean isRelateElements()
                         throws IOException,
                                AutomationException

Indicates if a relation between elements must be initialized.

Product Availability

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

Returns:

The relateElements

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelateElements

void setRelateElements(boolean relateElements)
                       throws IOException,
                              AutomationException

Indicates if a relation between elements must be initialized.

Product Availability

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

Parameters:

relateElements - The relateElements (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReverseRelation

boolean isReverseRelation()
                          throws IOException,
                                 AutomationException

Indicates if the relation between elements must be reversed.

Product Availability

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

Returns:

The reverseTRelation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReverseRelation

void setReverseRelation(boolean reverseTRelation)
                        throws IOException,
                               AutomationException

Indicates if the relation between elements must be reversed.

Product Availability

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

Parameters:

reverseTRelation - The reverseTRelation (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRelateConnectedNodes

boolean isRelateConnectedNodes()
                               throws IOException,
                                      AutomationException

Indicates if the relation must be reported on the origin and end nodes of links when schematic links are returned by the Schematic Spatial Query rule.

Product Availability

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

Returns:

The relateConnectedNodes

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelateConnectedNodes

void setRelateConnectedNodes(boolean relateConnectedNodes)
                             throws IOException,
                                    AutomationException

Indicates if the relation must be reported on the origin and end nodes of links when schematic links are returned by the Schematic Spatial Query rule.

Product Availability

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

Parameters:

relateConnectedNodes - The relateConnectedNodes (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.

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.