com.esri.arcgis.geodatabase
Class INetworkForwardStarExProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.INetworkForwardStarExProxy

All Implemented Interfaces:

INetworkForwardStarEx, java.io.Externalizable, java.io.Serializable

public class INetworkForwardStarExProxy
extends com.esri.arcgis.interop.Dispatch
implements INetworkForwardStarEx, java.io.Serializable

Internal use class Proxy for COM Interface 'INetworkForwardStarEx'. Generated 3/19/2015 1:20:57 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'

Description: 'Provides access to members that specify the configuration for this NetworkForwardStar object and query information about adjacent elements in the network dataset.' 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

boolean	noncastable
static java.lang.Class	targetClass

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

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

IID, IID25c310eb_bff3_4a47_a694_3f17e16fbfda

Constructor Summary

	INetworkForwardStarExProxy() For internal use only
	INetworkForwardStarExProxy(java.lang.Object obj)
protected	INetworkForwardStarExProxy(java.lang.Object obj, java.lang.String iid)
	INetworkForwardStarExProxy(java.lang.String CLSID, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)
protected	INetworkForwardStarExProxy(java.lang.String CLSID, java.lang.String iid, java.lang.String host, com.esri.arcgis.interop.AuthInfo authInfo)

Method Summary

void	addEdgeRestriction(INetworkEdge edge, double fromPosition, double toPosition) Restricts the traversability of a range on an edge element in the adjacency queries.
void	addJunctionRestriction(INetworkJunction junction) Restricts a junction element from being returned in the adjacency queries.
void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource)
void	addRestrictionAttribute(INetworkAttribute attribute) Adds a restriction network attribute to the NetworkForwardStar object to filter elements from adjacency queries.
void	addTurnRestriction(INetworkTurn turn) Restricts a turn in the adjacency queries.
void	adjustEdgeAttributeValue(INetworkEdge edge, double fromPosition, double toPosition, INetworkAttribute attribute, int adjustmentType, java.lang.Object value) Adjusts the value of a network attribute for a range on an edge element.
void	adjustJunctionAttributeValue(INetworkJunction junction, INetworkAttribute attribute, int adjustmentType, java.lang.Object value) Adjusts the value of a network attribute for a junction element.
void	adjustTurnAttributeValue(INetworkTurn turn, INetworkAttribute attribute, int adjustmentType, java.lang.Object value) Adjusts the value of a network attribute for a turn element.
int	getBacktrackPolicy() Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.
INetworkAttribute	getHierarchyAttribute() Network attribute containing the hierarchy values for each network element.
int	getMaxTraversableHierarchyValue() Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.
INetworkDataset	getNetworkDataset() Network dataset on which the NetworkForwardStar object is querying.
INetworkAttribute	getRestrictionAttribute(int index) Restriction network attribute by index in the NetworkForwardStar object.
int	getRestrictionAttributeCount() Number of restriction network attributes currently applied to the NetworkForwardStar object.
boolean	isForwardTraversal() Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.
boolean	isRestricted(INetworkElement element) Indicates if the given network element is restricted from traversal in the NetworkForwardStar object.
void	queryAdjacencies(INetworkJunction atJunction, INetworkEdge fromEdge, INetworkEdge lastExteriorEdge, INetworkForwardStarAdjacencies adjacencies) Finds all network elements that are adjacent to the given sequence of network elements.
void	queryAttributeCutoffRange(INetworkEdge edge, INetworkAttribute attribute, double queryPosition, java.lang.Object cutoffValue, double[] fromPosition, double[] toPosition) Returns the range of accessible positions within a specified attribute cutoff from a query position along an edge element, respective to any existing attribute adjustments along the edge.
void	queryEdge(int eID, int direction, INetworkEdge edge) Performs a network edge element query by element ID and edge direction and populates the given edge element object.
void	queryJunction(int eID, INetworkJunction junction) Performs a network junction element query by element ID and populates the given junction element object.
void	queryTraversableRange(INetworkEdge edge, double queryPosition, double[] fromPosition, double[] toPosition, boolean[] isFromPositionAccessible, boolean[] isToPositionAccessible) Returns the range of accessible positions from a query position along an edge element, respective to any existing restrictions along the edge.
void	queryTurn(int eID, INetworkTurn turn) Performs a network turn element query by element ID and populates the given turn element object.
void	removeAttributeValueAdjustments() Removes all element-specific attribute value adjustments currently applied to the NetworkForwardStar object.
void	removeElementRestrictions() Removes all element-specific restrictions currently applied to the NetworkForwardStar object.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener)
void	removeRestrictionAttributes() Removes all restriction network attributes currently applied to the NetworkForwardStar object.
void	setBacktrackPolicy(int backtrack) Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.
void	setHierarchyAttributeByRef(INetworkAttribute attribute) Network attribute containing the hierarchy values for each network element.
void	setIsForwardTraversal(boolean isForwardTraversal) Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.
void	setMaxTraversableHierarchyValue(int maxValue) Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

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

Field Detail

targetClass

public static final java.lang.Class targetClass

noncastable

public boolean noncastable

Constructor Detail

INetworkForwardStarExProxy

public INetworkForwardStarExProxy(java.lang.String CLSID,
                                  java.lang.String host,
                                  com.esri.arcgis.interop.AuthInfo authInfo)
                           throws java.net.UnknownHostException,
                                  java.io.IOException

Throws:

java.net.UnknownHostException

java.io.IOException

INetworkForwardStarExProxy

public INetworkForwardStarExProxy()

For internal use only

INetworkForwardStarExProxy

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

Throws:

java.io.IOException

INetworkForwardStarExProxy

protected INetworkForwardStarExProxy(java.lang.Object obj,
                                     java.lang.String iid)
                              throws java.io.IOException

Throws:

java.io.IOException

INetworkForwardStarExProxy

protected INetworkForwardStarExProxy(java.lang.String CLSID,
                                     java.lang.String iid,
                                     java.lang.String host,
                                     com.esri.arcgis.interop.AuthInfo authInfo)
                              throws java.io.IOException

Throws:

java.io.IOException

Method Detail

addListener

public void addListener(java.lang.String iidStr,
                        java.lang.Object theListener,
                        java.lang.Object theSource)
                 throws java.io.IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

removeListener

public void removeListener(java.lang.String iidStr,
                           java.lang.Object theListener)
                    throws java.io.IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

java.io.IOException

queryAdjacencies

public void queryAdjacencies(INetworkJunction atJunction,
                             INetworkEdge fromEdge,
                             INetworkEdge lastExteriorEdge,
                             INetworkForwardStarAdjacencies adjacencies)
                      throws java.io.IOException,
                             AutomationException

Finds all network elements that are adjacent to the given sequence of network elements.

Specified by:

queryAdjacencies in interface INetworkForwardStarEx

Parameters:

atJunction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)

fromEdge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)

lastExteriorEdge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)

adjacencies - A reference to a com.esri.arcgis.geodatabase.INetworkForwardStarAdjacencies (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryJunction

public void queryJunction(int eID,
                          INetworkJunction junction)
                   throws java.io.IOException,
                          AutomationException

Performs a network junction element query by element ID and populates the given junction element object.

Specified by:

queryJunction in interface INetworkForwardStarEx

Parameters:

eID - The eID (in)

junction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryEdge

public void queryEdge(int eID,
                      int direction,
                      INetworkEdge edge)
               throws java.io.IOException,
                      AutomationException

Performs a network edge element query by element ID and edge direction and populates the given edge element object.

Specified by:

queryEdge in interface INetworkForwardStarEx

Parameters:

eID - The eID (in)

direction - A com.esri.arcgis.geodatabase.esriNetworkEdgeDirection constant (in)

edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTurn

public void queryTurn(int eID,
                      INetworkTurn turn)
               throws java.io.IOException,
                      AutomationException

Performs a network turn element query by element ID and populates the given turn element object.

Specified by:

queryTurn in interface INetworkForwardStarEx

Parameters:

eID - The eID (in)

turn - A reference to a com.esri.arcgis.geodatabase.INetworkTurn (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryTraversableRange

public void queryTraversableRange(INetworkEdge edge,
                                  double queryPosition,
                                  double[] fromPosition,
                                  double[] toPosition,
                                  boolean[] isFromPositionAccessible,
                                  boolean[] isToPositionAccessible)
                           throws java.io.IOException,
                                  AutomationException

Returns the range of accessible positions from a query position along an edge element, respective to any existing restrictions along the edge.

Specified by:

queryTraversableRange in interface INetworkForwardStarEx

Parameters:

edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)

queryPosition - The queryPosition (in)

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

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

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryAttributeCutoffRange

public void queryAttributeCutoffRange(INetworkEdge edge,
                                      INetworkAttribute attribute,
                                      double queryPosition,
                                      java.lang.Object cutoffValue,
                                      double[] fromPosition,
                                      double[] toPosition)
                               throws java.io.IOException,
                                      AutomationException

Returns the range of accessible positions within a specified attribute cutoff from a query position along an edge element, respective to any existing attribute adjustments along the edge.

Specified by:

queryAttributeCutoffRange in interface INetworkForwardStarEx

Parameters:

edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

queryPosition - The queryPosition (in)

cutoffValue - A Variant (in)

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

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNetworkDataset

public INetworkDataset getNetworkDataset()
                                  throws java.io.IOException,
                                         AutomationException

Network dataset on which the NetworkForwardStar object is querying.

Specified by:

getNetworkDataset in interface INetworkForwardStarEx

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBacktrackPolicy

public int getBacktrackPolicy()
                       throws java.io.IOException,
                              AutomationException

Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.

Specified by:

getBacktrackPolicy in interface INetworkForwardStarEx

Returns:

A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBacktrackPolicy

public void setBacktrackPolicy(int backtrack)
                        throws java.io.IOException,
                               AutomationException

Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.

Specified by:

setBacktrackPolicy in interface INetworkForwardStarEx

Parameters:

backtrack - A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isForwardTraversal

public boolean isForwardTraversal()
                           throws java.io.IOException,
                                  AutomationException

Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.

Specified by:

isForwardTraversal in interface INetworkForwardStarEx

Returns:

The isForwardTraversal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIsForwardTraversal

public void setIsForwardTraversal(boolean isForwardTraversal)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the NetworkForwardStar object is used to model forward traversal through the network dataset.

Specified by:

setIsForwardTraversal in interface INetworkForwardStarEx

Parameters:

isForwardTraversal - The isForwardTraversal (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRestrictionAttribute

public void addRestrictionAttribute(INetworkAttribute attribute)
                             throws java.io.IOException,
                                    AutomationException

Adds a restriction network attribute to the NetworkForwardStar object to filter elements from adjacency queries.

Specified by:

addRestrictionAttribute in interface INetworkForwardStarEx

Parameters:

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRestrictionAttribute

public INetworkAttribute getRestrictionAttribute(int index)
                                          throws java.io.IOException,
                                                 AutomationException

Restriction network attribute by index in the NetworkForwardStar object.

Specified by:

getRestrictionAttribute in interface INetworkForwardStarEx

Parameters:

index - The index (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRestrictionAttributeCount

public int getRestrictionAttributeCount()
                                 throws java.io.IOException,
                                        AutomationException

Number of restriction network attributes currently applied to the NetworkForwardStar object.

Specified by:

getRestrictionAttributeCount in interface INetworkForwardStarEx

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeRestrictionAttributes

public void removeRestrictionAttributes()
                                 throws java.io.IOException,
                                        AutomationException

Removes all restriction network attributes currently applied to the NetworkForwardStar object.

Specified by:

removeRestrictionAttributes in interface INetworkForwardStarEx

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHierarchyAttribute

public INetworkAttribute getHierarchyAttribute()
                                        throws java.io.IOException,
                                               AutomationException

Network attribute containing the hierarchy values for each network element.

Specified by:

getHierarchyAttribute in interface INetworkForwardStarEx

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHierarchyAttributeByRef

public void setHierarchyAttributeByRef(INetworkAttribute attribute)
                                throws java.io.IOException,
                                       AutomationException

Network attribute containing the hierarchy values for each network element.

Specified by:

setHierarchyAttributeByRef in interface INetworkForwardStarEx

Parameters:

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxTraversableHierarchyValue

public int getMaxTraversableHierarchyValue()
                                    throws java.io.IOException,
                                           AutomationException

Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.

Specified by:

getMaxTraversableHierarchyValue in interface INetworkForwardStarEx

Returns:

The maxValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxTraversableHierarchyValue

public void setMaxTraversableHierarchyValue(int maxValue)
                                     throws java.io.IOException,
                                            AutomationException

Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.

Specified by:

setMaxTraversableHierarchyValue in interface INetworkForwardStarEx

Parameters:

maxValue - The maxValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addJunctionRestriction

public void addJunctionRestriction(INetworkJunction junction)
                            throws java.io.IOException,
                                   AutomationException

Restricts a junction element from being returned in the adjacency queries.

Specified by:

addJunctionRestriction in interface INetworkForwardStarEx

Parameters:

junction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addEdgeRestriction

public void addEdgeRestriction(INetworkEdge edge,
                               double fromPosition,
                               double toPosition)
                        throws java.io.IOException,
                               AutomationException

Restricts the traversability of a range on an edge element in the adjacency queries.

Specified by:

addEdgeRestriction in interface INetworkForwardStarEx

Parameters:

edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)

fromPosition - The fromPosition (in)

toPosition - The toPosition (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addTurnRestriction

public void addTurnRestriction(INetworkTurn turn)
                        throws java.io.IOException,
                               AutomationException

Restricts a turn in the adjacency queries.

Specified by:

addTurnRestriction in interface INetworkForwardStarEx

Parameters:

turn - A reference to a com.esri.arcgis.geodatabase.INetworkTurn (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeElementRestrictions

public void removeElementRestrictions()
                               throws java.io.IOException,
                                      AutomationException

Removes all element-specific restrictions currently applied to the NetworkForwardStar object.

Specified by:

removeElementRestrictions in interface INetworkForwardStarEx

Throws:

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

AutomationException - If the ArcObject component throws an exception.

adjustJunctionAttributeValue

public void adjustJunctionAttributeValue(INetworkJunction junction,
                                         INetworkAttribute attribute,
                                         int adjustmentType,
                                         java.lang.Object value)
                                  throws java.io.IOException,
                                         AutomationException

Adjusts the value of a network attribute for a junction element.

Specified by:

adjustJunctionAttributeValue in interface INetworkForwardStarEx

Parameters:

junction - A reference to a com.esri.arcgis.geodatabase.INetworkJunction (in)

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

adjustmentType - A com.esri.arcgis.geodatabase.esriNetworkAttributeAdjustmentType constant (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

adjustEdgeAttributeValue

public void adjustEdgeAttributeValue(INetworkEdge edge,
                                     double fromPosition,
                                     double toPosition,
                                     INetworkAttribute attribute,
                                     int adjustmentType,
                                     java.lang.Object value)
                              throws java.io.IOException,
                                     AutomationException

Adjusts the value of a network attribute for a range on an edge element.

Specified by:

adjustEdgeAttributeValue in interface INetworkForwardStarEx

Parameters:

edge - A reference to a com.esri.arcgis.geodatabase.INetworkEdge (in)

fromPosition - The fromPosition (in)

toPosition - The toPosition (in)

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

adjustmentType - A com.esri.arcgis.geodatabase.esriNetworkAttributeAdjustmentType constant (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

adjustTurnAttributeValue

public void adjustTurnAttributeValue(INetworkTurn turn,
                                     INetworkAttribute attribute,
                                     int adjustmentType,
                                     java.lang.Object value)
                              throws java.io.IOException,
                                     AutomationException

Adjusts the value of a network attribute for a turn element.

Specified by:

adjustTurnAttributeValue in interface INetworkForwardStarEx

Parameters:

turn - A reference to a com.esri.arcgis.geodatabase.INetworkTurn (in)

attribute - A reference to a com.esri.arcgis.geodatabase.INetworkAttribute (in)

adjustmentType - A com.esri.arcgis.geodatabase.esriNetworkAttributeAdjustmentType constant (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAttributeValueAdjustments

public void removeAttributeValueAdjustments()
                                     throws java.io.IOException,
                                            AutomationException

Removes all element-specific attribute value adjustments currently applied to the NetworkForwardStar object.

Specified by:

removeAttributeValueAdjustments in interface INetworkForwardStarEx

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isRestricted

public boolean isRestricted(INetworkElement element)
                     throws java.io.IOException,
                            AutomationException

Indicates if the given network element is restricted from traversal in the NetworkForwardStar object.

Specified by:

isRestricted in interface INetworkForwardStarEx

Parameters:

element - A reference to a com.esri.arcgis.geodatabase.INetworkElement (in)

Returns:

The isRestricted

Throws:

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

AutomationException - If the ArcObject component throws an exception.