com.esri.arcgis.geodatabase

Class NetworkFunctionEvaluator

java.lang.Object

com.esri.arcgis.geodatabase.NetworkFunctionEvaluator

All Implemented Interfaces:

IGPDescribe, INetworkEvaluator, INetworkFunctionEvaluator, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class NetworkFunctionEvaluator
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkEvaluator, INetworkFunctionEvaluator, IGPDescribe

COM Class 'NetworkFunctionEvaluator'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description 'A container for describing a network evaluator function.' 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.INetworkEvaluator

IID, IID0fcb88f9_8b17_4ed8_99c7_c876f5da8b7e, xxDummy

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

IID, IID6699c29b_86cc_4c25_b3dd_98959760477b, xxDummy

Constructor Summary

Constructors

Constructor and Description
NetworkFunctionEvaluator() Constructs a NetworkFunctionEvaluator using ArcGIS Engine.
NetworkFunctionEvaluator(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. NetworkFunctionEvaluator theNetworkFunctionEvaluator = (NetworkFunctionEvaluator) obj;

Method Summary

Modifier and Type	Method and Description
java.lang.Object	describe(java.lang.String name) The description of the named object.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
IPropertySet	getData() The data used by this network evaluator for custom properties.
java.lang.String	getDisplayName() Name displayed in the user interface for this network evaluator.
java.lang.Object	getFirstArgument() The attribute name or constant value representing the first argument of the function.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
java.lang.String	getName() Unique name of this network evaluator.
java.lang.String	getOperator() The operator used in the function.
IEnumBSTR	getOperators(int returnDataType) Get the list of supported binary operator names.
IStringArray	getRequiredFieldNames() Required fields of this network evaluator.
java.lang.Object	getSecondArgument() The parameter name or constant value representing the second argument of the function.
int	hashCode() the hashcode for this object
boolean	isCacheAttribute() Indicates if this evaluator's values should be computed and stored when the network is built or computed at run time and never stored.
boolean	isTimeAware() Indicates if this evaluator supports time aware queries
void	release() Release this COM object reference
void	setData(IPropertySet data) The data used by this network evaluator for custom properties.
void	setFirstArgument(java.lang.Object arg1) The attribute name or constant value representing the first argument of the function.
void	setOperator(java.lang.String op) The operator used in the function.
void	setSecondArgument(java.lang.Object arg2) The parameter name or constant value representing the second argument of the function.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkFunctionEvaluator

public NetworkFunctionEvaluator()
                         throws java.io.IOException,
                                java.net.UnknownHostException

Constructs a NetworkFunctionEvaluator using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NetworkFunctionEvaluator

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NetworkFunctionEvaluator theNetworkFunctionEvaluator = (NetworkFunctionEvaluator) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

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

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

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

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

Unique name of this network evaluator.

Specified by:

getName in interface INetworkEvaluator

Returns:

The pName

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

The data used by this network evaluator for custom properties.

Specified by:

setData in interface INetworkEvaluator

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

The data used by this network evaluator for custom properties.

Specified by:

getData in interface INetworkEvaluator

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.

getDisplayName

public java.lang.String getDisplayName()
                                throws java.io.IOException,
                                       AutomationException

Name displayed in the user interface for this network evaluator.

Specified by:

getDisplayName in interface INetworkEvaluator

Returns:

The pDisplayName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCacheAttribute

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

Indicates if this evaluator's values should be computed and stored when the network is built or computed at run time and never stored.

Specified by:

isCacheAttribute in interface INetworkEvaluator

Returns:

The cache

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRequiredFieldNames

public IStringArray getRequiredFieldNames()
                                   throws java.io.IOException,
                                          AutomationException

Required fields of this network evaluator.

Specified by:

getRequiredFieldNames in interface INetworkEvaluator

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTimeAware

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

Indicates if this evaluator supports time aware queries

Specified by:

isTimeAware in interface INetworkEvaluator

Returns:

The aware

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFirstArgument

public void setFirstArgument(java.lang.Object arg1)
                      throws java.io.IOException,
                             AutomationException

The attribute name or constant value representing the first argument of the function.

Specified by:

setFirstArgument in interface INetworkFunctionEvaluator

Parameters:

arg1 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFirstArgument

public java.lang.Object getFirstArgument()
                                  throws java.io.IOException,
                                         AutomationException

The attribute name or constant value representing the first argument of the function.

Specified by:

getFirstArgument in interface INetworkFunctionEvaluator

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOperator

public void setOperator(java.lang.String op)
                 throws java.io.IOException,
                        AutomationException

The operator used in the function.

Specified by:

setOperator in interface INetworkFunctionEvaluator

Parameters:

op - The op (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOperator

public java.lang.String getOperator()
                             throws java.io.IOException,
                                    AutomationException

The operator used in the function.

Specified by:

getOperator in interface INetworkFunctionEvaluator

Returns:

The op

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSecondArgument

public void setSecondArgument(java.lang.Object arg2)
                       throws java.io.IOException,
                              AutomationException

The parameter name or constant value representing the second argument of the function.

Specified by:

setSecondArgument in interface INetworkFunctionEvaluator

Parameters:

arg2 - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSecondArgument

public java.lang.Object getSecondArgument()
                                   throws java.io.IOException,
                                          AutomationException

The parameter name or constant value representing the second argument of the function.

Specified by:

getSecondArgument in interface INetworkFunctionEvaluator

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOperators

public IEnumBSTR getOperators(int returnDataType)
                       throws java.io.IOException,
                              AutomationException

Get the list of supported binary operator names.

Specified by:

getOperators in interface INetworkFunctionEvaluator

Parameters:

returnDataType - A com.esri.arcgis.geodatabase.esriNetworkAttributeDataType constant (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

describe

public java.lang.Object describe(java.lang.String name)
                          throws java.io.IOException,
                                 AutomationException

The description of the named object.

Product Availability

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

Specified by:

describe in interface IGPDescribe

Parameters:

name - The name (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.