com.esri.arcgis.geometry
Class RelationResult

java.lang.Object
  extended by com.esri.arcgis.geometry.RelationResult
All Implemented Interfaces:
IRelationResult, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class RelationResult
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IRelationResult

The indexes of geometrybag elements that are in a specified relation.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
RelationResult()
          Constructs a RelationResult using ArcGIS Engine.
RelationResult(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RelationResult theRelationResult = (RelationResult) obj;
 
Method Summary
 void add(IRelationResult pRelations)
          Add elements of other Relation to the end of this Relations, and the set is re-sorted.
 boolean equals(Object o)
          Compare this object with another
 void flipRelations()
          Flips the left and right indexes of all the elements of the relation.
static String getClsid()
          getClsid.
 void getRelationElement(int i, int[] left, int[] right)
          The ith element of the relation.
 int getRelationElementCount()
          The number of pairs of geometries in the relation.
 int hashCode()
          the hashcode for this object
 void intersect(IRelationResult pRelations)
          Construct the set with only those elements that exist in both relation sets.
 void setRelationElement(int i, int left, int right)
          The ith element of the relation.
 void setRelationElements(int cPairs, esriRelationPair pairs)
          Sets RelationResult with an array of relations.
 void sortLeft()
          Sort the set according to the left index.
 void sortRight()
          Sort the set according to the right index.
 void subtract(IRelationResult pRelations)
          Finds elements existing in another relation set and delete them from this set.
 
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

RelationResult

public RelationResult()
               throws IOException,
                      UnknownHostException
Constructs a RelationResult using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

RelationResult

public RelationResult(Object obj)
               throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RelationResult theRelationResult = (RelationResult) obj;

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

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

getRelationElementCount

public int getRelationElementCount()
                            throws IOException,
                                   AutomationException
The number of pairs of geometries in the relation.

Product Availability

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

Specified by:
getRelationElementCount in interface IRelationResult
Returns:
The resultPairCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRelationElement

public void getRelationElement(int i,
                               int[] left,
                               int[] right)
                        throws IOException,
                               AutomationException
The ith element of the relation. The indexes refer to elements of the left and right operand geometry bags.

Product Availability

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

Specified by:
getRelationElement in interface IRelationResult
Parameters:
i - The i (in)
left - The left (out: use single element array)
right - The right (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelationElement

public void setRelationElement(int i,
                               int left,
                               int right)
                        throws IOException,
                               AutomationException
The ith element of the relation. The indexes refer to elements of the left and right operand geometry bags.

Product Availability

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

Specified by:
setRelationElement in interface IRelationResult
Parameters:
i - The i (in)
left - The left (in)
right - The right (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRelationElements

public void setRelationElements(int cPairs,
                                esriRelationPair pairs)
                         throws IOException,
                                AutomationException
Sets RelationResult with an array of relations.

Product Availability

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

Specified by:
setRelationElements in interface IRelationResult
Parameters:
cPairs - The cPairs (in)
pairs - A Structure: com.esri.arcgis.geometry.esriRelationPair (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sortRight

public void sortRight()
               throws IOException,
                      AutomationException
Sort the set according to the right index.

Product Availability

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

Specified by:
sortRight in interface IRelationResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

sortLeft

public void sortLeft()
              throws IOException,
                     AutomationException
Sort the set according to the left index.

Product Availability

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

Specified by:
sortLeft in interface IRelationResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

flipRelations

public void flipRelations()
                   throws IOException,
                          AutomationException
Flips the left and right indexes of all the elements of the relation.

Product Availability

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

Specified by:
flipRelations in interface IRelationResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

subtract

public void subtract(IRelationResult pRelations)
              throws IOException,
                     AutomationException
Finds elements existing in another relation set and delete them from this set.

Product Availability

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

Specified by:
subtract in interface IRelationResult
Parameters:
pRelations - A reference to a com.esri.arcgis.geometry.IRelationResult (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

intersect

public void intersect(IRelationResult pRelations)
               throws IOException,
                      AutomationException
Construct the set with only those elements that exist in both relation sets.

Product Availability

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

Specified by:
intersect in interface IRelationResult
Parameters:
pRelations - A reference to a com.esri.arcgis.geometry.IRelationResult (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

public void add(IRelationResult pRelations)
         throws IOException,
                AutomationException
Add elements of other Relation to the end of this Relations, and the set is re-sorted.

Product Availability

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

Specified by:
add in interface IRelationResult
Parameters:
pRelations - A reference to a com.esri.arcgis.geometry.IRelationResult (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.