|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geodatabase.NetworkFunctionEvaluator
public class NetworkFunctionEvaluator
COM Class 'NetworkFunctionEvaluator'. Generated 3/19/2015 1:20:43 PM from 'C:\ArcGIS\COM\esriGeoDatabase.olb'
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 =
Field Summary |
---|
Fields inherited from interface com.esri.arcgis.geodatabase.INetworkFunctionEvaluator |
---|
IID, IID6699c29b_86cc_4c25_b3dd_98959760477b, xxDummy |
Constructor Summary | |
---|---|
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 | |
---|---|
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. |
IUID |
getCLSID()
Unique CLSID identifier for this network evaluator. |
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()
Deprecated. Internal use only. |
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 |
void |
initialize(INetworkDataset networkDataset,
IDENetworkDataset dataElement,
INetworkSource source,
IEvaluatedNetworkAttribute attribute)
Initializes the network evaluator in preparation to evaluate the attribute value of a network element. |
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 |
isDataHasEdits()
Indicates if the data for this evaluator has been edited. |
java.lang.Object |
queryValue(INetworkElement element,
IRow row)
Evaluates the attribute value of a network element. |
void |
refresh()
Refresh custom data for this network evaluator to synchronize with updated attribute parameter values or other external data. |
void |
release()
Release a NetworkFunctionEvaluator. |
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. |
boolean |
supportsDefault(int elementType,
IEvaluatedNetworkAttribute attribute)
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)
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)
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)
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 java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public NetworkFunctionEvaluator() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic NetworkFunctionEvaluator(java.lang.Object obj) throws java.io.IOException
NetworkFunctionEvaluator theNetworkFunctionEvaluator = (NetworkFunctionEvaluator) obj;
obj
to NetworkFunctionEvaluator
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public java.lang.String getName() throws java.io.IOException, AutomationException
getName
in interface INetworkEvaluator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDisplayName() throws java.io.IOException, AutomationException
The DisplayName is the name for the evaluator that will be displayed in the Type column of the Evaluators dialog in ArcCatalog.
getDisplayName
in interface INetworkEvaluator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isCacheAttribute() throws java.io.IOException, AutomationException
The CacheAttribute property determines whether the values computed by this evaluator are stored in the logical network of the network dataset.
If the CacheAttribute property is set to True, then the attribute values are computed by the evaluator only when the network is built. The computed attribute values are then stored in the logical network. When a client queries for attribute values (such as during a network analysis), the attribute values are retrieved from the logical network.
If the CacheAttribute property is set to False, then the attribute values are computed by the evaluator whenever any client asks for an attribute value (such as during a network analysis). The computed attribute values are not stored in the logical network. Depending on the complexity of the evaluator, this operation can be much slower than looking up values stored in the logical network.
isCacheAttribute
in interface INetworkEvaluator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IStringArray getRequiredFieldNames() throws java.io.IOException, AutomationException
RequiredFieldNames returns the field names that the evaluator requires in order to correctly evaluate the row. This property is used to minimize the data that is returned by the query to the database by only returning the required fields. Return a NULL pointer if you want it to include all the field names in the query.
getRequiredFieldNames
in interface INetworkEvaluator2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void refresh() throws java.io.IOException, AutomationException
The Refresh method is an opportunity to update any internal state within the evaluator based on changes to parameters, dynamic data feeds, etc. The Refresh method is called on every evaluator assigned to a network attribute when INetworkAttribute2::Refresh() is called. For example, this is called internally during a solve operation after setting the network attribute parameters and prior to performing the actual solve.
refresh
in interface INetworkEvaluator2
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void initialize(INetworkDataset networkDataset, IDENetworkDataset dataElement, INetworkSource source, IEvaluatedNetworkAttribute attribute) throws java.io.IOException, AutomationException
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.
initialize
in interface INetworkEvaluatorSetup
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setData(IPropertySet data) throws java.io.IOException, AutomationException
setData
in interface INetworkEvaluatorSetup
data
- A reference to a com.esri.arcgis.system.IPropertySet (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet getData() throws java.io.IOException, AutomationException
The Data property stores data that is needed by the evaluator. It is stored in a PropertySet object using key-value pairs.
getData
in interface INetworkEvaluatorSetup
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDataHasEdits() throws java.io.IOException, AutomationException
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.
isDataHasEdits
in interface INetworkEvaluatorSetup
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getCLSID() throws java.io.IOException, AutomationException
getCLSID
in interface INetworkEvaluatorSetup
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean supportsSource(INetworkSource source, IEvaluatedNetworkAttribute attribute) throws java.io.IOException, AutomationException
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.
supportsSource
in interface INetworkEvaluatorSetup
source
- A reference to a com.esri.arcgis.geodatabase.INetworkSource (in)attribute
- A reference to a com.esri.arcgis.geodatabase.IEvaluatedNetworkAttribute (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean supportsDefault(int elementType, IEvaluatedNetworkAttribute attribute) throws java.io.IOException, AutomationException
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.
supportsDefault
in interface INetworkEvaluatorSetup
elementType
- A com.esri.arcgis.geodatabase.esriNetworkElementType constant (in)attribute
- A reference to a com.esri.arcgis.geodatabase.IEvaluatedNetworkAttribute (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean validateSource(IDatasetContainer2 datasetContainer, INetworkSource networkSource, IEvaluatedNetworkAttribute attribute, int[] errorCode, java.lang.String[] errorDescription, java.lang.String[] errorAppendInfo) throws java.io.IOException, AutomationException
validateSource
in interface INetworkEvaluatorSetup
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean validateDefault(int elementType, IEvaluatedNetworkAttribute attribute, int[] errorCode, java.lang.String[] errorDescription, java.lang.String[] errorAppendInfo) throws java.io.IOException, AutomationException
validateDefault
in interface INetworkEvaluatorSetup
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)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object queryValue(INetworkElement element, IRow row) throws java.io.IOException, AutomationException
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.
queryValue
in interface INetworkEvaluatorSetup
element
- A reference to a com.esri.arcgis.geodatabase.INetworkElement (in)row
- A reference to a com.esri.arcgis.geodatabase.IRow (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setFirstArgument(java.lang.Object arg1) throws java.io.IOException, AutomationException
setFirstArgument
in interface INetworkFunctionEvaluator
arg1
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object getFirstArgument() throws java.io.IOException, AutomationException
getFirstArgument
in interface INetworkFunctionEvaluator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setOperator(java.lang.String op) throws java.io.IOException, AutomationException
setOperator
in interface INetworkFunctionEvaluator
op
- The op (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getOperator() throws java.io.IOException, AutomationException
getOperator
in interface INetworkFunctionEvaluator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSecondArgument(java.lang.Object arg2) throws java.io.IOException, AutomationException
setSecondArgument
in interface INetworkFunctionEvaluator
arg2
- A Variant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object getSecondArgument() throws java.io.IOException, AutomationException
getSecondArgument
in interface INetworkFunctionEvaluator
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IEnumBSTR getOperators(int returnDataType) throws java.io.IOException, AutomationException
getOperators
in interface INetworkFunctionEvaluator
returnDataType
- A com.esri.arcgis.geodatabase.esriNetworkAttributeDataType constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.Object describe(java.lang.String name) throws java.io.IOException, AutomationException
describe
in interface IGPDescribe
name
- The name (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |