com.esri.arcgis.geodatabase
Class INetworkEvaluatorSetupProxy

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

All Implemented Interfaces:

INetworkEvaluatorSetup, java.io.Externalizable, java.io.Serializable

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

Description: 'Provides access to members that set up a network evaluator for use within a 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 =

public class INetworkEvaluatorSetupProxy
extends com.esri.arcgis.interop.Dispatch
implements INetworkEvaluatorSetup, java.io.Serializable

Internal use class

See Also:

Serialized Form

Field Summary

boolean	noncastable Deprecated.
static java.lang.Class	targetClass Deprecated.

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

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

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

Method Summary

void	addListener(java.lang.String iidStr, java.lang.Object theListener, java.lang.Object theSource) Deprecated.
IUID	getCLSID() Deprecated. Unique CLSID identifier for this network evaluator.
IPropertySet	getData() Deprecated. The data used by this network evaluator for custom properties.
void	initialize(INetworkDataset networkDataset, IDENetworkDataset dataElement, INetworkSource source, IEvaluatedNetworkAttribute attribute) Deprecated. Initializes the network evaluator in preparation to evaluate the attribute value of a network element.
boolean	isDataHasEdits() Deprecated. Indicates if the data for this evaluator has been edited.
java.lang.Object	queryValue(INetworkElement element, IRow row) Deprecated. Evaluates the attribute value of a network element.
void	removeListener(java.lang.String iidStr, java.lang.Object theListener) Deprecated.
void	setData(IPropertySet data) Deprecated. The data used by this network evaluator for custom properties.
boolean	supportsDefault(int elementType, IEvaluatedNetworkAttribute attribute) Deprecated. Indicates if this network evaluator can be used as the default evaluator for the given network element type and network attribute.
boolean	supportsSource(INetworkSource source, IEvaluatedNetworkAttribute attribute) Deprecated. Indicates if this network evaluator can be used as the evaluator for the given network source and network attribute.
boolean	validateDefault(int elementType, IEvaluatedNetworkAttribute attribute, int[] errorCode, java.lang.String[] errorDescription, java.lang.String[] errorAppendInfo) Deprecated. Indicates if the network evaluator is in a valid state for use as the default evaluator for the given element type and network attribute.
boolean	validateSource(IDatasetContainer2 datasetContainer, INetworkSource networkSource, IEvaluatedNetworkAttribute attribute, int[] errorCode, java.lang.String[] errorDescription, java.lang.String[] errorAppendInfo) Deprecated. Indicates if the network evaluator is in a valid state for use as the evaluator for the given network source and network attribute.

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

Deprecated.

noncastable

public boolean noncastable

Deprecated.

Constructor Detail

INetworkEvaluatorSetupProxy

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

Deprecated.

Throws:

java.net.UnknownHostException

java.io.IOException

INetworkEvaluatorSetupProxy

public INetworkEvaluatorSetupProxy()

Deprecated.

For internal use only

INetworkEvaluatorSetupProxy

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

Deprecated.

Throws:

java.io.IOException

INetworkEvaluatorSetupProxy

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

Deprecated.

Throws:

java.io.IOException

INetworkEvaluatorSetupProxy

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

Deprecated.

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

Deprecated.

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

Deprecated.

Overrides:

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

Throws:

java.io.IOException

initialize

public void initialize(INetworkDataset networkDataset,
                       IDENetworkDataset dataElement,
                       INetworkSource source,
                       IEvaluatedNetworkAttribute attribute)
                throws java.io.IOException,
                       AutomationException

Deprecated.

Initializes the network evaluator in preparation to evaluate the attribute value of a network element.

Remarks

The Initialize method does all the "heavy lifting" needed to prepare the evaluator for a call to QueryValue, a lightweight method for querying the attribute value for a network element. Once the evaluator is initialized, the client can make multiple calls to this lightweight QueryValue for calculating the attribute values of multiple network elements.

When querying for attribute values in the network dataset ArcGIS calls the Initialize method immediately after it instantiates the evaluator. For evaluators with CacheAttribute = True, this occurs when building the network dataset. For evaluators with CacheAttribute = False, this occurs on the first call in the session to INetworkElement::AttributeValue or ::AttributeValueByName that requires this evaluator to determine the attribute value.

Product Availability

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

Specified by:

initialize in interface INetworkEvaluatorSetup

Parameters:

networkDataset - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)

dataElement - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

source - A reference to a com.esri.arcgis.geodatabase.INetworkSource (in)

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setData

public void setData(IPropertySet data)
             throws java.io.IOException,
                    AutomationException

Deprecated.

The data used by this network evaluator for custom properties.

Product Availability

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

Specified by:

setData in interface INetworkEvaluatorSetup

Parameters:

data - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getData

public IPropertySet getData()
                     throws java.io.IOException,
                            AutomationException

Deprecated.

The data used by this network evaluator for custom properties.

Remarks

The Data property stores data that is needed by the evaluator. It is stored in a PropertySet object using key-value pairs.

Product Availability

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

Specified by:

getData in interface INetworkEvaluatorSetup

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDataHasEdits

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

Deprecated.

Indicates if the data for this evaluator has been edited.

Remarks

The DataHasEdits property indicates whether changes have been made to the Data PropertySet that have not yet been handled by the evaluator's internal logic. This is useful in determining whether the evaluator needs to be re-Initialized before making additional calls to QueryValue.

This property is only used when modifying the network dataset's evaluators via objects like the EvaluatorEditor to signify the network dataset may need to be rebuilt/reinitialized. This property is not queried prior to network analysis to determine if the evaluator needs to be re-initialized. Thus, it is not a mechanism to trigger that the evaluators need to be re-initialized based on new data between solves.

Product Availability

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

Specified by:

isDataHasEdits in interface INetworkEvaluatorSetup

Returns:

The hasEdits

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCLSID

public IUID getCLSID()
              throws java.io.IOException,
                     AutomationException

Deprecated.

Unique CLSID identifier for this network evaluator.

Product Availability

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

Specified by:

getCLSID in interface INetworkEvaluatorSetup

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

supportsSource

public boolean supportsSource(INetworkSource source,
                              IEvaluatedNetworkAttribute attribute)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Indicates if this network evaluator can be used as the evaluator for the given network source and network attribute.

Remarks

TheSupportsSource method is used to determine if the evaluator can be used to assign attribute values for elements generated by the given source. If SupportsSource is False, then the evaluator does not show up as a choice for the user in the Evaluators dialog in ArcCatalog.

Product Availability

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

Specified by:

supportsSource in interface INetworkEvaluatorSetup

Parameters:

source - A reference to a com.esri.arcgis.geodatabase.INetworkSource (in)

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

Returns:

The isSupported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

supportsDefault

public boolean supportsDefault(int elementType,
                               IEvaluatedNetworkAttribute attribute)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Indicates if this network evaluator can be used as the default evaluator for the given network element type and network attribute.

Remarks

The SupportsDefault method is used to determine if the evaluator can be used to assign default attribute values for elements of the given type. If SupportsDefault is False, then the evaluator does not show up as a default evaluator choice for the user in the Evaluators dialog in ArcCatalog.

Product Availability

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

Specified by:

supportsDefault in interface INetworkEvaluatorSetup

Parameters:

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

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

Returns:

The isSupported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateSource

public boolean validateSource(IDatasetContainer2 datasetContainer,
                              INetworkSource networkSource,
                              IEvaluatedNetworkAttribute attribute,
                              int[] errorCode,
                              java.lang.String[] errorDescription,
                              java.lang.String[] errorAppendInfo)
                       throws java.io.IOException,
                              AutomationException

Deprecated.

Indicates if the network evaluator is in a valid state for use as the evaluator for the given network source and network attribute.

Product Availability

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

Specified by:

validateSource in interface INetworkEvaluatorSetup

Parameters:

datasetContainer - A reference to a com.esri.arcgis.geodatabase.IDatasetContainer2 (in)

networkSource - A reference to a com.esri.arcgis.geodatabase.INetworkSource (in)

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

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

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

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

Returns:

The isValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

validateDefault

public boolean validateDefault(int elementType,
                               IEvaluatedNetworkAttribute attribute,
                               int[] errorCode,
                               java.lang.String[] errorDescription,
                               java.lang.String[] errorAppendInfo)
                        throws java.io.IOException,
                               AutomationException

Deprecated.

Indicates if the network evaluator is in a valid state for use as the default evaluator for the given element type and network attribute.

Product Availability

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

Specified by:

validateDefault in interface INetworkEvaluatorSetup

Parameters:

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

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

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

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

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

Returns:

The isValid

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryValue

public java.lang.Object queryValue(INetworkElement element,
                                   IRow row)
                            throws java.io.IOException,
                                   AutomationException

Deprecated.

Evaluates the attribute value of a network element.

Remarks

QueryValue uses this evaluator to compute the attribute value for the given network element.

The Row parameter is provided in order to query any information from the Row (such as field values) corresponding to the given network element when building the network dataset. When computing attribute values that will be cached within the network, QueryValue is automatically called by the system, and the Row from the corresponding source feature will be passed into QueryValue.

Note that QueryValue is also automatically called by the system when querying non-cached attribute values by using the INetworkElement interface. In this situation, the Row parameter will always be null; that is, the Row from the corresponding source feature will not be passed into QueryValue.

Before calling QueryValue, the evaluator must first be initialized by calling the Initialize method. After calling Initialize, QueryValue can be called multiple times to calculate attribute values for multiple network elements.

Product Availability

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

Specified by:

queryValue in interface INetworkEvaluatorSetup

Parameters:

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

row - A reference to a com.esri.arcgis.geodatabase.IRow (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.