com.esri.arcgis.networkanalyst
Class NAServerDataLayer

java.lang.Object
  extended by com.esri.arcgis.networkanalyst.NAServerDataLayer
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INAServerDataLayer, INAServerLocations, INAServerLocations2, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

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

A container that references a data layer containing network locations.

Remarks

The NAServerDataLayer object is used to load network locations.

The NAServerDataLayer object implements the INAServerDataLayer interface and can be passed in to any of the properties of the NAServerSolverParams objects that expect an INAServerLocations interface pointer. For example, Stops, Barriers, Facilities, or Incidents.

If the data layer contains 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 in the data layer 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.

See Also:
Serialized Form

Constructor Summary
NAServerDataLayer()
          Constructs a NAServerDataLayer using ArcGIS Engine.
NAServerDataLayer(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerDataLayer theNAServerDataLayer = (NAServerDataLayer) 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 getDataLayerName()
          The name of the layer in the map.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 IQueryFilter getQueryFilter()
          The query filter used to constrain the search.
 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 setDataLayerName(String pValue)
          The name of the layer in the map.
 void setDoNotLocateOnRestrictedElements(boolean pValue)
          Indicates if restricted network elements should be considered when finding network locations.
 void setQueryFilterByRef(IQueryFilter ppValue)
          The query filter used to constrain the search.
 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

NAServerDataLayer

public NAServerDataLayer()
                  throws IOException,
                         UnknownHostException
Constructs a NAServerDataLayer using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

NAServerDataLayer

public NAServerDataLayer(Object obj)
                  throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAServerDataLayer theNAServerDataLayer = (NAServerDataLayer) obj;

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

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

getDataLayerName

public String getDataLayerName()
                        throws IOException,
                               AutomationException
The name of the layer in the map.

Remarks

DataLayerName specifies the name of a data layer in the associate map service to load as network locations.

Product Availability

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

Specified by:
getDataLayerName in interface INAServerDataLayer
Returns:
The pValue
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataLayerName

public void setDataLayerName(String pValue)
                      throws IOException,
                             AutomationException
The name of the layer in the map.

Remarks

DataLayerName specifies the name of a data layer in the associate map service to load as network locations.

Product Availability

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

Specified by:
setDataLayerName in interface INAServerDataLayer
Parameters:
pValue - The pValue (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getQueryFilter

public IQueryFilter getQueryFilter()
                            throws IOException,
                                   AutomationException
The query filter used to constrain the search.

Remarks

QueryFilter specifies an instance of QueryFilter or SpatialFilter used to constrain the input features.

Product Availability

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

Specified by:
getQueryFilter in interface INAServerDataLayer
Returns:
A reference to a com.esri.arcgis.geodatabase.IQueryFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryFilterByRef

public void setQueryFilterByRef(IQueryFilter ppValue)
                         throws IOException,
                                AutomationException
The query filter used to constrain the search.

Remarks

QueryFilter specifies an instance of QueryFilter or SpatialFilter used to constrain the input features.

Product Availability

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

Specified by:
setQueryFilterByRef in interface INAServerDataLayer
Parameters:
ppValue - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (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