com.esri.arcgis.schematic
Interface ISchematicSpatialQueryRule

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ISchematicSpatialQueryRuleProxy, SchematicSpatialQueryRule

public interface ISchematicSpatialQueryRule
extends java.io.Serializable

COM Interface 'ISchematicSpatialQueryRule'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSchematic.olb'

Description: 'Provides access to members that manage the generic Schematic Spatial Query rule.' 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 =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID7b2e34b8_f671_420f_a713_785d7679333e
static int	xxDummy Deprecated. Internal use only

Method Summary

double	getBufferDistance() Spatial buffer distance of the Schematic Spatial Query rule.
int	getBufferUnits() Spatial buffer units of the Schematic Spatial Query rule.
java.lang.String	getDescription() Description of the Schematic Spatial Query rule.
java.lang.String	getRelationshipElementClassName() Relationship element class name related to the Schematic Relationship rule.
int	getSearchMethod() List of the target element class names.
java.lang.String	getSourceElementClassName() Source element class name related to the Schematic Spatial Query rule.
java.lang.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(java.lang.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(java.lang.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(java.lang.String sourceClassName) Source element class name related to the Schematic Spatial Query rule.
void	setTargetElementClassNames(java.lang.Object names) List of the target element class names.

Field Detail

IID7b2e34b8_f671_420f_a713_785d7679333e

static final int IID7b2e34b8_f671_420f_a713_785d7679333e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getDescription

java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException

Description of the Schematic Spatial Query rule.

Returns:

The description

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

Description of the Schematic Spatial Query rule.

Parameters:

description - The description (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSourceElementClassName

java.lang.String getSourceElementClassName()
                                           throws java.io.IOException,
                                                  AutomationException

Source element class name related to the Schematic Spatial Query rule.

Returns:

The sourceClassName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSourceElementClassName

void setSourceElementClassName(java.lang.String sourceClassName)
                               throws java.io.IOException,
                                      AutomationException

Source element class name related to the Schematic Spatial Query rule.

Parameters:

sourceClassName - The sourceClassName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTargetElementClassNames

java.lang.Object getTargetElementClassNames()
                                            throws java.io.IOException,
                                                   AutomationException

List of the target element class names.

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTargetElementClassNames

void setTargetElementClassNames(java.lang.Object names)
                                throws java.io.IOException,
                                       AutomationException

List of the target element class names.

Parameters:

names - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchMethod

int getSearchMethod()
                    throws java.io.IOException,
                           AutomationException

List of the target element class names.

Returns:

A com.esri.arcgis.schematic.esriSchematicSpatialQueryRuleSearchMethod constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchMethod

void setSearchMethod(int searchMethod)
                     throws java.io.IOException,
                            AutomationException

List of the target element class names.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKeepVertices

boolean isKeepVertices()
                       throws java.io.IOException,
                              AutomationException

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

Returns:

The keepVertices

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKeepVertices

void setKeepVertices(boolean keepVertices)
                     throws java.io.IOException,
                            AutomationException

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

Parameters:

keepVertices - The keepVertices (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBufferUsed

boolean isBufferUsed()
                     throws java.io.IOException,
                            AutomationException

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

Returns:

The bufferUsed

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferUsed

void setBufferUsed(boolean bufferUsed)
                   throws java.io.IOException,
                          AutomationException

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

Parameters:

bufferUsed - The bufferUsed (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferDistance

double getBufferDistance()
                         throws java.io.IOException,
                                AutomationException

Spatial buffer distance of the Schematic Spatial Query rule.

Returns:

The bufferDistance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferDistance

void setBufferDistance(double bufferDistance)
                       throws java.io.IOException,
                              AutomationException

Spatial buffer distance of the Schematic Spatial Query rule.

Parameters:

bufferDistance - The bufferDistance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBufferUnits

int getBufferUnits()
                   throws java.io.IOException,
                          AutomationException

Spatial buffer units of the Schematic Spatial Query rule.

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBufferUnits

void setBufferUnits(int bufferUnits)
                    throws java.io.IOException,
                           AutomationException

Spatial buffer units of the Schematic Spatial Query rule.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddElements

boolean isAddElements()
                      throws java.io.IOException,
                             AutomationException

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

Returns:

The addElements

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddElements

void setAddElements(boolean addElements)
                    throws java.io.IOException,
                           AutomationException

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

Parameters:

addElements - The addElements (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRelateElements

boolean isRelateElements()
                         throws java.io.IOException,
                                AutomationException

Indicates if a relation between elements must be initialized.

Returns:

The relateElements

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelateElements

void setRelateElements(boolean relateElements)
                       throws java.io.IOException,
                              AutomationException

Indicates if a relation between elements must be initialized.

Parameters:

relateElements - The relateElements (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReverseRelation

boolean isReverseRelation()
                          throws java.io.IOException,
                                 AutomationException

Indicates if the relation between elements must be reversed.

Returns:

The reverseTRelation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReverseRelation

void setReverseRelation(boolean reverseTRelation)
                        throws java.io.IOException,
                               AutomationException

Indicates if the relation between elements must be reversed.

Parameters:

reverseTRelation - The reverseTRelation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isRelateConnectedNodes

boolean isRelateConnectedNodes()
                               throws java.io.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.

Returns:

The relateConnectedNodes

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelateConnectedNodes

void setRelateConnectedNodes(boolean relateConnectedNodes)
                             throws java.io.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.

Parameters:

relateConnectedNodes - The relateConnectedNodes (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationshipElementClassName

java.lang.String getRelationshipElementClassName()
                                                 throws java.io.IOException,
                                                        AutomationException

Relationship element class name related to the Schematic Relationship rule.

Returns:

The relationshipClassName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationshipElementClassName

void setRelationshipElementClassName(java.lang.String relationshipClassName)
                                     throws java.io.IOException,
                                            AutomationException

Relationship element class name related to the Schematic Relationship rule.

Parameters:

relationshipClassName - The relationshipClassName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAddRelationshipElement

boolean isAddRelationshipElement()
                                 throws java.io.IOException,
                                        AutomationException

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

Returns:

The addRelationshipElement

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddRelationshipElement

void setAddRelationshipElement(boolean addRelationshipElement)
                               throws java.io.IOException,
                                      AutomationException

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

Parameters:

addRelationshipElement - The addRelationshipElement (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isReverseRelationshipLinkOrientation

boolean isReverseRelationshipLinkOrientation()
                                             throws java.io.IOException,
                                                    AutomationException

Indicates if the relationship link orientation must be reversed.

Returns:

The reverseRelationshipLinkOrientation

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReverseRelationshipLinkOrientation

void setReverseRelationshipLinkOrientation(boolean reverseRelationshipLinkOrientation)
                                           throws java.io.IOException,
                                                  AutomationException

Indicates if the relationship link orientation must be reversed.

Parameters:

reverseRelationshipLinkOrientation - The reverseRelationshipLinkOrientation (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.