com.esri.arcgis.geodatabase
Class ForwardStar

java.lang.Object
  com.esri.arcgis.geodatabase.ForwardStar

All Implemented Interfaces:

IForwardStar, IForwardStarGEN, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class ForwardStar
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IForwardStarGEN, IForwardStar

COM Class 'ForwardStar'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description 'A container for querying information about adjacent elements in the logical network.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabase.IForwardStarGEN

IID, IID7ebfc159_e0da_4d21_9c3b_5d81f2e6ad9f, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IForwardStar

IID, IID19f99c81_a089_11d0_9cc9_00805f74d243, xxDummy

Constructor Summary

ForwardStar(java.lang.Object obj)
Construct a ForwardStar using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
void	findAdjacent(int fromEdgeEID, int atJunctionEID, int[] adjacentEdgesCount) Finds the edge elements that are adjacent to the given junction element and returns the count.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
INetwork	getNetwork() Underlying network of this forward star cursor.
int	hashCode() the hashcode for this object
void	queryAdjacentEdge(int index, int[] adjacentEdgeEID, boolean[] reverseOrientation, java.lang.Object[] adjacentEdgeWeightValue) Returns index'th adjacent edge found with FindAdjacent, its orientation, and its weight value.
void	queryAdjacentEdges(int[][] adjacentEdgeEIDs, boolean[][] reverseOrientation, java.lang.Object[][] adjacentEdgesWeightValue) Returns the adjacent edges found with FindAdjacent into the specified user-defined array.
void	queryAdjacentEdges(int count, int[] adjacentEdgeEIDs, boolean[] reverseOrientation, java.lang.Object[] adjacentEdgesWeightValue) Returns the adjacent edges found with FindAdjacent into the specified user-defined array.
void	queryAdjacentJunction(int index, int[] adjacentJunctionEID, java.lang.Object[] adjacentJunctionWeightValue) Returns the opposite junction of the index'th adjacent edge found with FindAdjacent, and the weight value for this junction.
void	queryAdjacentJunctions(int[][] adjacentJunctionEIDs, java.lang.Object[][] adjacentJunctionsWeightValue) Returns the opposite junctions of the adjacent edges found with FindAdjacent into the specified user-defined array.
void	queryAdjacentJunctions(int count, int[] adjacentJunctionEIDs, java.lang.Object[] adjacentJunctionsWeightValue) Returns the opposite junctions of the adjacent edges found with FindAdjacent into the specified user-defined array.
void	queryAtTurn(int index, int[] adjacentTurnEID, java.lang.Object[] adjacentTurnWeightValue) Returns the turn through which the index'th adjacent edge found with FindAdjacent passes, and the weight value of the turn.
void	queryAtTurns(int count, int[] adjacentTurnEIDs, java.lang.Object[] adjacentTurnsWeightValue) Returns the turns through which the adjacent edges found with FindAdjacent passes into the user-defined array.
void	release() Release a ForwardStar.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForwardStar

public ForwardStar(java.lang.Object obj)
            throws java.io.IOException

Construct a ForwardStar using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ForwardStar.
Casting to this class from the return value of a method will not work, as this class represents an abstract class in ArcObjects.
*
ForwardStar o = (ForwardStar)obj; // will not work

ForwardStar o = new ForwardStar(obj); // Use this constructor instead
* @param obj an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems ForwardStar theForwardStar = (ForwardStar) obj;

Method Detail

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a ForwardStar.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getNetwork

public INetwork getNetwork()
                    throws java.io.IOException,
                           AutomationException

Underlying network of this forward star cursor.

Specified by:

getNetwork in interface IForwardStar

Specified by:

getNetwork in interface IForwardStarGEN

Returns:

A reference to a com.esri.arcgis.geodatabase.INetwork

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findAdjacent

public void findAdjacent(int fromEdgeEID,
                         int atJunctionEID,
                         int[] adjacentEdgesCount)
                  throws java.io.IOException,
                         AutomationException

Finds the edge elements that are adjacent to the given junction element and returns the count.

Specified by:

findAdjacent in interface IForwardStar

Specified by:

findAdjacent in interface IForwardStarGEN

Parameters:

fromEdgeEID - The fromEdgeEID (in)

atJunctionEID - The atJunctionEID (in)

adjacentEdgesCount - The adjacentEdgesCount (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentJunction

public void queryAdjacentJunction(int index,
                                  int[] adjacentJunctionEID,
                                  java.lang.Object[] adjacentJunctionWeightValue)
                           throws java.io.IOException,
                                  AutomationException

Returns the opposite junction of the index'th adjacent edge found with FindAdjacent, and the weight value for this junction.

Specified by:

queryAdjacentJunction in interface IForwardStar

Specified by:

queryAdjacentJunction in interface IForwardStarGEN

Parameters:

index - The index (in)

adjacentJunctionEID - The adjacentJunctionEID (out: use single element array)

adjacentJunctionWeightValue - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentEdge

public void queryAdjacentEdge(int index,
                              int[] adjacentEdgeEID,
                              boolean[] reverseOrientation,
                              java.lang.Object[] adjacentEdgeWeightValue)
                       throws java.io.IOException,
                              AutomationException

Returns index'th adjacent edge found with FindAdjacent, its orientation, and its weight value.

Specified by:

queryAdjacentEdge in interface IForwardStar

Specified by:

queryAdjacentEdge in interface IForwardStarGEN

Parameters:

index - The index (in)

adjacentEdgeEID - The adjacentEdgeEID (out: use single element array)

reverseOrientation - The reverseOrientation (out: use single element array)

adjacentEdgeWeightValue - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAtTurn

public void queryAtTurn(int index,
                        int[] adjacentTurnEID,
                        java.lang.Object[] adjacentTurnWeightValue)
                 throws java.io.IOException,
                        AutomationException

Returns the turn through which the index'th adjacent edge found with FindAdjacent passes, and the weight value of the turn.

Specified by:

queryAtTurn in interface IForwardStar

Specified by:

queryAtTurn in interface IForwardStarGEN

Parameters:

index - The index (in)

adjacentTurnEID - The adjacentTurnEID (out: use single element array)

adjacentTurnWeightValue - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentJunctions

public void queryAdjacentJunctions(int[][] adjacentJunctionEIDs,
                                   java.lang.Object[][] adjacentJunctionsWeightValue)
                            throws java.io.IOException,
                                   AutomationException

Returns the opposite junctions of the adjacent edges found with FindAdjacent into the specified user-defined array.

Specified by:

queryAdjacentJunctions in interface IForwardStarGEN

Parameters:

adjacentJunctionEIDs - The adjacentJunctionEIDs (in/out: use single element array)

adjacentJunctionsWeightValue - A Variant (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentEdges

public void queryAdjacentEdges(int[][] adjacentEdgeEIDs,
                               boolean[][] reverseOrientation,
                               java.lang.Object[][] adjacentEdgesWeightValue)
                        throws java.io.IOException,
                               AutomationException

Returns the adjacent edges found with FindAdjacent into the specified user-defined array.

Specified by:

queryAdjacentEdges in interface IForwardStarGEN

Parameters:

adjacentEdgeEIDs - The adjacentEdgeEIDs (in/out: use single element array)

reverseOrientation - The reverseOrientation (in/out: use single element array)

adjacentEdgesWeightValue - A Variant (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentJunctions

public void queryAdjacentJunctions(int count,
                                   int[] adjacentJunctionEIDs,
                                   java.lang.Object[] adjacentJunctionsWeightValue)
                            throws java.io.IOException,
                                   AutomationException

Returns the opposite junctions of the adjacent edges found with FindAdjacent into the specified user-defined array.

Specified by:

queryAdjacentJunctions in interface IForwardStar

Parameters:

count - The count (in)

adjacentJunctionEIDs - The adjacentJunctionEIDs (out: use single element array)

adjacentJunctionsWeightValue - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAdjacentEdges

public void queryAdjacentEdges(int count,
                               int[] adjacentEdgeEIDs,
                               boolean[] reverseOrientation,
                               java.lang.Object[] adjacentEdgesWeightValue)
                        throws java.io.IOException,
                               AutomationException

Returns the adjacent edges found with FindAdjacent into the specified user-defined array.

Specified by:

queryAdjacentEdges in interface IForwardStar

Parameters:

count - The count (in)

adjacentEdgeEIDs - The adjacentEdgeEIDs (out: use single element array)

reverseOrientation - The reverseOrientation (out: use single element array)

adjacentEdgesWeightValue - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAtTurns

public void queryAtTurns(int count,
                         int[] adjacentTurnEIDs,
                         java.lang.Object[] adjacentTurnsWeightValue)
                  throws java.io.IOException,
                         AutomationException

Returns the turns through which the adjacent edges found with FindAdjacent passes into the user-defined array.

Specified by:

queryAtTurns in interface IForwardStar

Parameters:

count - The count (in)

adjacentTurnEIDs - The adjacentTurnEIDs (out: use single element array)

adjacentTurnsWeightValue - A Variant (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.