com.esri.arcgis.networkanalyst
Class NAClassCandidateFieldMap

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

All Implemented Interfaces:

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

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

Candidate field maps of an NAClass.

Remarks

The NAClassCandidateFieldMap object is used to specify the default values and candidate field names for an NAClass.

An NAClassCandidateFieldMap object holds an array of NACandidateFieldMap objects.

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

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NAClassCandidateFieldMap()
Constructs a NAClassCandidateFieldMap using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
INACandidateFieldMap[]	getCandidateFieldMaps() Array of candidate field map objects.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
String	getNAClassName() Name of the NAClass.
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	setCandidateFieldMaps(INACandidateFieldMap[] ppCandidateFieldMaps) Array of candidate field map objects.
void	setNAClassName(String name) Name of the NAClass.
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

NAClassCandidateFieldMap

public NAClassCandidateFieldMap()
                         throws IOException,
                                UnknownHostException

Constructs a NAClassCandidateFieldMap using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NAClassCandidateFieldMap

public NAClassCandidateFieldMap(Object obj)
                         throws IOException

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

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

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

getNAClassName

public String getNAClassName()
                      throws IOException,
                             AutomationException

Name of the NAClass.

Remarks

NAClassName refers to the name of the NAClass that this NAClassCandidateFieldMap is referencing. The array of CandidateFieldMaps will be applied to this NAClass.

Product Availability

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

Specified by:

getNAClassName in interface INAClassCandidateFieldMap

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setNAClassName

public void setNAClassName(String name)
                    throws IOException,
                           AutomationException

Name of the NAClass.

Remarks

NAClassName refers to the name of the NAClass that this NAClassCandidateFieldMap is referencing. The array of CandidateFieldMaps will be applied to this NAClass.

Product Availability

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

Specified by:

setNAClassName in interface INAClassCandidateFieldMap

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCandidateFieldMaps

public INACandidateFieldMap[] getCandidateFieldMaps()
                                             throws IOException,
                                                    AutomationException

Array of candidate field map objects.

Remarks

The CandidateFieldMaps property holds an array of NACandidateFieldMap objects that will be applied to the NAClass with the name specified by NAClassName.

Product Availability

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

Specified by:

getCandidateFieldMaps in interface INAClassCandidateFieldMap

Returns:

A reference to a com.esri.arcgis.networkanalyst.INACandidateFieldMap array

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCandidateFieldMaps

public void setCandidateFieldMaps(INACandidateFieldMap[] ppCandidateFieldMaps)
                           throws IOException,
                                  AutomationException

Array of candidate field map objects.

Remarks

The CandidateFieldMaps property holds an array of NACandidateFieldMap objects that will be applied to the NAClass with the name specified by NAClassName.

Product Availability

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

Specified by:

setCandidateFieldMaps in interface INAClassCandidateFieldMap

Parameters:

ppCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INACandidateFieldMap array (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