com.esri.arcgis.networkanalyst
Class NACandidateFieldMap

java.lang.Object
  com.esri.arcgis.networkanalyst.NACandidateFieldMap

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INACandidateFieldMap, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NACandidateFieldMap
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INACandidateFieldMap, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

Deprecated as of 10.0. Field Map holding default value and candidate fields.

Remarks

The NACandidateFieldMap object is used to specify the default value and candidate field names for a particular field in an NAClass.

An NAClassCandidateFieldMap object holds an array of NACandidateFieldMap objects.

Within INAServer::Solve the information provided by INACandidateFieldMap is applied to an NAClassFieldMap object prior to loading network locations to specify the values of the network locations based on these default values and candidate fields.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NACandidateFieldMap()
Constructs a NACandidateFieldMap using ArcGIS Engine.

NACandidateFieldMap(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NACandidateFieldMap theNACandidateFieldMap = (NACandidateFieldMap) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
IStringArray	getCandidateFieldNames() CandidateFieldNames for the field.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
Object	getDefaultValue() Default value for the field.
String	getFieldName() Name of the field.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setCandidateFieldNamesByRef(IStringArray ppCandidateFieldNames) CandidateFieldNames for the field.
void	setDefaultValue(Object defaultValue) Default value for the field.
void	setFieldName(String name) Name of the field.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

NACandidateFieldMap

public NACandidateFieldMap()
                    throws IOException,
                           UnknownHostException

Constructs a NACandidateFieldMap using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NACandidateFieldMap

public NACandidateFieldMap(Object obj)
                    throws IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getFieldName

public String getFieldName()
                    throws IOException,
                           AutomationException

Name of the field.

Remarks

The FieldName is the name of the field that the default value and candidate field names apply to.

Product Availability

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

Specified by:

getFieldName in interface INACandidateFieldMap

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldName

public void setFieldName(String name)
                  throws IOException,
                         AutomationException

Name of the field.

Remarks

The FieldName is the name of the field that the default value and candidate field names apply to.

Product Availability

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

Specified by:

setFieldName in interface INACandidateFieldMap

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public Object getDefaultValue()
                       throws IOException,
                              AutomationException

Default value for the field.

Remarks

The DefaultValue specifies the value to use for this field of the network location. This value will be overridden if a candidate field name matches a field on the input cursor.

Product Availability

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

Specified by:

getDefaultValue in interface INACandidateFieldMap

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

public void setDefaultValue(Object defaultValue)
                     throws IOException,
                            AutomationException

Default value for the field.

Remarks

The DefaultValue specifies the value to use for this field of the network location. This value will be overridden if a candidate field name matches a field on the input cursor.

Product Availability

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

Specified by:

setDefaultValue in interface INACandidateFieldMap

Parameters:

defaultValue - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCandidateFieldNames

public IStringArray getCandidateFieldNames()
                                    throws IOException,
                                           AutomationException

CandidateFieldNames for the field.

Remarks

The CandidateFieldNames specifies the possible field names to try to match with the input cursor. If the input cursor has a field with a name in the CandidateFieldNames, it uses the value from this field on the input feature to set the network location's field specified by FieldName.

If a candidate field name matches one of the input cursor's fields, the feature's field value overrides the DefaultValue unless the value is NULL in which case it uses the DefaultValue.

Product Availability

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

Specified by:

getCandidateFieldNames in interface INACandidateFieldMap

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCandidateFieldNamesByRef

public void setCandidateFieldNamesByRef(IStringArray ppCandidateFieldNames)
                                 throws IOException,
                                        AutomationException

CandidateFieldNames for the field.

Remarks

The CandidateFieldNames specifies the possible field names to try to match with the input cursor. If the input cursor has a field with a name in the CandidateFieldNames, it uses the value from this field on the input feature to set the network location's field specified by FieldName.

If a candidate field name matches one of the input cursor's fields, the feature's field value overrides the DefaultValue unless the value is NULL in which case it uses the DefaultValue.

Product Availability

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

Specified by:

setCandidateFieldNamesByRef in interface INACandidateFieldMap

Parameters:

ppCandidateFieldNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException

The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException