com.esri.arcgis.networkanalyst
Class NAServerRecordSet

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INAServerLocations, INAServerLocations2, INAServerRecordSet, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class NAServerRecordSet
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerRecordSet, INAServerLocations, INAServerLocations2, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, Externalizable

Deprecated as of 10.0. A container for a RecordSet of network locations.

Remarks

At version 10.1, ArcGIS for Server no longer supports performing network analysis via local connections using the GISServer and GISClient APIs. Use the SOAP or REST API instead.

The NAServerRecordSet object holds a RecordSet object representing network locations.

The NAServerRecordSet object can be passed into any of the properties of the NAServerSolverParams objects that expect an INAServerLocations interface pointer (for example, Stops, Barriers, Facilities, or Incidents).

At a minimum, the RecordSet needs a shape field with a point geometry type. You can also add fields to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (int), "SourceOID" (int), "PosAlong" (double), and "SideOfEdge" (int), the values in these fields will specify the network location rather than perform a spatial search to determine the network location.

Any other fields can be added to the RecordSet and can be used when loading network locations. INAServerSolverParams.NAClassCandidateFieldMaps determines which properties map to NAClass fields.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NAServerRecordSet()
Constructs a NAServerRecordSet using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
IRecordSet	getRecordSet() The recordset containing the records to load into the analysis.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isDoNotLocateOnRestrictedElements() Indicates if restricted network elements should be considered when finding network locations.
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	setDoNotLocateOnRestrictedElements(boolean pValue) Indicates if restricted network elements should be considered when finding network locations.
void	setRecordSetByRef(IRecordSet ppValue) The recordset containing the records to load into the analysis.
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

NAServerRecordSet

public NAServerRecordSet()
                  throws IOException,
                         UnknownHostException

Constructs a NAServerRecordSet using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NAServerRecordSet

public NAServerRecordSet(Object obj)
                  throws IOException

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

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

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

getRecordSet

public IRecordSet getRecordSet()
                        throws IOException,
                               AutomationException

The recordset containing the records to load into the analysis.

Remarks

The RecordSet property provides access to a RecordSet of network locations.

At a minimum, the RecordSet needs a shape field with a point geometry type. You can also add additional fields that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (int), "SourceOID" (int), "PosAlong" (double), and "SideOfEdge" (int) the values in these fields will specify the network location rather than performing a spatial search to determine the network location.

Any other fields can be added to the RecordSet and may be used when loading network locations. What fields map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps .

Product Availability

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

Specified by:

getRecordSet in interface INAServerRecordSet

Returns:

A reference to a com.esri.arcgis.geodatabase.IRecordSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRecordSetByRef

public void setRecordSetByRef(IRecordSet ppValue)
                       throws IOException,
                              AutomationException

The recordset containing the records to load into the analysis.

Remarks

The RecordSet property provides access to a RecordSet of network locations.

At a minimum, the RecordSet needs a shape field with a point geometry type. You can also add additional fields that you wish to be used when loading the network locations. For example, if you specify the network location fields "SourceID" (int), "SourceOID" (int), "PosAlong" (double), and "SideOfEdge" (int) the values in these fields will specify the network location rather than performing a spatial search to determine the network location.

Any other fields can be added to the RecordSet and may be used when loading network locations. What fields map to NAClass fields is a function of INAServerSolverParams.NAClassCandidateFieldMaps .

Product Availability

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

Specified by:

setRecordSetByRef in interface INAServerRecordSet

Parameters:

ppValue - A reference to a com.esri.arcgis.geodatabase.IRecordSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDoNotLocateOnRestrictedElements

public boolean isDoNotLocateOnRestrictedElements()
                                          throws IOException,
                                                 AutomationException

Indicates if restricted network elements should be considered when finding network locations.

Remarks

DoNotLocateOnRestrictedElements indicates if the loader should avoid locating the network locations on network elements that are restricted by Barriers, PolylineBarriers, PolygonBarriers or due to the set of restrictions specified by NAServerSolverParams.RestrictionAttributeNames.

Product Availability

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

Specified by:

isDoNotLocateOnRestrictedElements in interface INAServerLocations2

Returns:

The pValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDoNotLocateOnRestrictedElements

public void setDoNotLocateOnRestrictedElements(boolean pValue)
                                        throws IOException,
                                               AutomationException

Indicates if restricted network elements should be considered when finding network locations.

Remarks

DoNotLocateOnRestrictedElements indicates if the loader should avoid locating the network locations on network elements that are restricted by Barriers, PolylineBarriers, PolygonBarriers or due to the set of restrictions specified by NAServerSolverParams.RestrictionAttributeNames.

Product Availability

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

Specified by:

setDoNotLocateOnRestrictedElements in interface INAServerLocations2

Parameters:

pValue - The pValue (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