com.esri.arcgis.geodatabase
Class NetworkForwardStar

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

All Implemented Interfaces:

INetworkForwardStar, INetworkForwardStarEx, INetworkForwardStarSetup, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, java.io.Serializable

public class NetworkForwardStar
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkForwardStar, INetworkForwardStarSetup, INetworkForwardStarEx, ISupportErrorInfo

COM Class 'NetworkForwardStar'. 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 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

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

IID, IIDfde593a2_8e96_40c8_8ab2_6da6d60af9b9, xxDummy

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

IID, IIDd68a2a0c_f2b9_47af_8ae6_811513349546, xxDummy

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

IID, IID25c310eb_bff3_4a47_a694_3f17e16fbfda, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

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

Method Summary

void	addCachedAttribute(INetworkAttribute attribute) AddCachedAttribute has been deprecated and should not be called.
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	addRestriction(INetworkAttribute attribute) Adds a restriction network attribute to the NetworkForwardStar object to filter elements returned.
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.
boolean	equals(java.lang.Object o) Compare this object with another
int	getBacktrack() Policy on when to return the from-edge in the NetworkForwardStarAdjacencies object.
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.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
int	getMaxHierarchyValue() Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.
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.
IEnumNetworkElement	getNonTraversableElements(int elementType, int direction) The collection of network elements of the given type that are set to not traversable.
INetworkAttribute	getRestriction(int index) Restriction network attribute by index applied to the NetworkForwardStar object.
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.
int	getRestrictionCount() Number of restriction network attributes applied to the NetworkForwardStar object.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isFiltered(INetworkElement element) Indicates if the given network element is filtered out from the adjacencies 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.
boolean	isTraversable(INetworkElement element) Indicates if the given network element is travserable by 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	release() Release a NetworkForwardStar.
void	removeAllCachedAttributes() RemoveAllCachedAttributes has been deprecated and should not be called.
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	removeRestriction(int index) Removes the given restriction network attribute by index from the NetworkForwardStar object.
void	removeRestrictionAttributes() Removes all restriction network attributes currently applied to the NetworkForwardStar object.
void	setAllTraversable(int elementType, boolean traversable) Sets all network elements of the given element type to be traversable or non-traversable.
void	setBacktrack(int backtrack) Policy on when to return the from-edge in the NetworkForwardStarAdjacencies 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	setMaxHierarchyValue(int maxValue) Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.
void	setMaxTraversableHierarchyValue(int maxValue) Maximum hierarchy attribute value for elements permitted to be returned in the adjacency queries.
void	setTraversable(INetworkElement element, boolean traversable) Indicates if the given network element is travserable by the NetworkForwardStar object.
void	setTraversable2(IEnumNetworkElement elements, boolean traversable) Sets the given network elements to be traversable or non-traversable.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkForwardStar

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

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

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

Throws:

java.io.IOException - if there are interop problems NetworkForwardStar theNetworkForwardStar = (NetworkForwardStar) 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 NetworkForwardStar.

Specified by:

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

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 INetworkForwardStar

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.

isFiltered

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

Indicates if the given network element is filtered out from the adjacencies object.

Specified by:

isFiltered in interface INetworkForwardStar

Parameters:

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

Returns:

The isFiltered

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBacktrack

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

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

Specified by:

getBacktrack in interface INetworkForwardStarSetup

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.

setBacktrack

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

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

Specified by:

setBacktrack in interface INetworkForwardStarSetup

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

Specified by:

isForwardTraversal in interface INetworkForwardStarSetup

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

Specified by:

setIsForwardTraversal in interface INetworkForwardStarSetup

Parameters:

isForwardTraversal - The isForwardTraversal (in)

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

Specified by:

getNetworkDataset in interface INetworkForwardStarSetup

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.

addCachedAttribute

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

AddCachedAttribute has been deprecated and should not be called.

Specified by:

addCachedAttribute in interface INetworkForwardStarSetup

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.

removeAllCachedAttributes

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

RemoveAllCachedAttributes has been deprecated and should not be called.

Specified by:

removeAllCachedAttributes in interface INetworkForwardStarSetup

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addRestriction

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

Adds a restriction network attribute to the NetworkForwardStar object to filter elements returned.

Specified by:

addRestriction in interface INetworkForwardStarSetup

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.

getRestriction

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

Restriction network attribute by index applied to the NetworkForwardStar object.

Specified by:

getRestriction in interface INetworkForwardStarSetup

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.

getRestrictionCount

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

Number of restriction network attributes applied to the NetworkForwardStar object.

Specified by:

getRestrictionCount in interface INetworkForwardStarSetup

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeRestriction

public void removeRestriction(int index)
                       throws java.io.IOException,
                              AutomationException

Removes the given restriction network attribute by index from the NetworkForwardStar object.

Specified by:

removeRestriction in interface INetworkForwardStarSetup

Parameters:

index - The index (in)

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

Specified by:

setHierarchyAttributeByRef in interface INetworkForwardStarSetup

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.

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

Specified by:

getHierarchyAttribute in interface INetworkForwardStarSetup

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.

setMaxHierarchyValue

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

Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.

Specified by:

setMaxHierarchyValue in interface INetworkForwardStarSetup

Parameters:

maxValue - The maxValue (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxHierarchyValue

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

Maximum hierarchy attribute value permitted to be returned in the NetworkForwardStarAdjacencies object.

Specified by:

getMaxHierarchyValue in interface INetworkForwardStarSetup

Returns:

The maxValue

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTraversable

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

Indicates if the given network element is travserable by the NetworkForwardStar object.

Specified by:

isTraversable in interface INetworkForwardStarSetup

Parameters:

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

Returns:

The traversable

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTraversable

public void setTraversable(INetworkElement element,
                           boolean traversable)
                    throws java.io.IOException,
                           AutomationException

Indicates if the given network element is travserable by the NetworkForwardStar object.

Specified by:

setTraversable in interface INetworkForwardStarSetup

Parameters:

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

traversable - The traversable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTraversable2

public void setTraversable2(IEnumNetworkElement elements,
                            boolean traversable)
                     throws java.io.IOException,
                            AutomationException

Sets the given network elements to be traversable or non-traversable.

Specified by:

setTraversable2 in interface INetworkForwardStarSetup

Parameters:

elements - A reference to a com.esri.arcgis.geodatabase.IEnumNetworkElement (in)

traversable - The traversable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAllTraversable

public void setAllTraversable(int elementType,
                              boolean traversable)
                       throws java.io.IOException,
                              AutomationException

Sets all network elements of the given element type to be traversable or non-traversable.

Specified by:

setAllTraversable in interface INetworkForwardStarSetup

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

traversable - The traversable (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNonTraversableElements

public IEnumNetworkElement getNonTraversableElements(int elementType,
                                                     int direction)
                                              throws java.io.IOException,
                                                     AutomationException

The collection of network elements of the given type that are set to not traversable.

Specified by:

getNonTraversableElements in interface INetworkForwardStarSetup

Parameters:

elementType - A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)

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

Returns:

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

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.

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.

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.

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.