|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.arcgis.networkanalyst.NAServerRecordSet
public class NAServerRecordSet
Deprecated as of 10.0. A container for a RecordSet of network locations.
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.
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 |
---|
public NAServerRecordSet() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic NAServerRecordSet(Object obj) throws IOException
NAServerRecordSet theNAServerRecordSet = (NAServerRecordSet) obj;
obj
to NAServerRecordSet
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public IRecordSet getRecordSet() throws IOException, AutomationException
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 .
getRecordSet
in interface INAServerRecordSet
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setRecordSetByRef(IRecordSet ppValue) throws IOException, AutomationException
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 .
setRecordSetByRef
in interface INAServerRecordSet
ppValue
- A reference to a com.esri.arcgis.geodatabase.IRecordSet (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isDoNotLocateOnRestrictedElements() throws IOException, AutomationException
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.
isDoNotLocateOnRestrictedElements
in interface INAServerLocations2
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDoNotLocateOnRestrictedElements(boolean pValue) throws IOException, AutomationException
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.
setDoNotLocateOnRestrictedElements
in interface INAServerLocations2
pValue
- The pValue (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws IOException, AutomationException
serialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws IOException, AutomationException
deserialize
in interface IXMLSerialize
data
- A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws IOException, AutomationException
IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.
getClassID
in interface IPersist
pClassID
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void isDirty() throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
isDirty
in interface IPersistStream
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void load(IStream pstm) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
load
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
save
in interface IPersistStream
pstm
- A reference to a com.esri.arcgis.system.IStream (in)fClearDirty
- The fClearDirty (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws IOException, AutomationException
IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.
getSizeMax
in interface IPersistStream
pcbSize
- A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void interfaceSupportsErrorInfo(GUID riid) throws IOException, AutomationException
Indicates whether the interface supports IErrorInfo.
interfaceSupportsErrorInfo
in interface ISupportErrorInfo
riid
- A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getMinNamespaceSupported() throws IOException, AutomationException
getMinNamespaceSupported
in interface IXMLVersionSupport
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void writeExternal(ObjectOutput out) throws IOException
writeExternal
in interface Externalizable
IOException
public void readExternal(ObjectInput in) throws IOException, ClassNotFoundException
readExternal
in interface Externalizable
IOException
ClassNotFoundException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |