com.esri.arcgis.networkanalyst
Class NAClassLoader

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INAClassLoader, INAClassLoader2, ISupportErrorInfo, java.io.Serializable

public class NAClassLoader
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAClassLoader, INAClassLoader2, ISupportErrorInfo

COM Class 'NAClassLoader'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriNetworkAnalyst.olb'

Description 'Loads a network class based on its field maps.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.networkanalyst.INAClassLoader2

IID, IID43580bf9_848b_4c66_b82b_a3bba8d74e85, xxDummy

Fields inherited from interface com.esri.arcgis.networkanalyst.INAClassLoader

IIDba4f2689_f38a_4cea_aaa1_7511eeed1fa9

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

NAClassLoader()
Constructs a NAClassLoader using ArcGIS Engine.

NAClassLoader(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAClassLoader theNAClassLoader = (NAClassLoader) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
ILocator	getAddressLocator() The address locator to be used.
static java.lang.String	getClsid() getClsid.
INAClassFieldMap	getFieldMap() The field mapping definition.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
INALocator	getLocator() The locator to be used.
INAClass	getNAClass() The network analysis class.
double	getSnapOffsetDistance() The snap offset distance from the network.
int	getSnapOffsetUnits() The snap offset units.
int	hashCode() the hashcode for this object
void	initialize(INAContext context, java.lang.String nAClassName, ICursor cursor) Quickly initializes the class loader to be able to load information from a cursor into a given NAClass.
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isSnapToNetwork() Indicates if the geometry should be snapped to the network.
void	load(ICursor cursor, ITrackCancel trackCancel, int[] rowsInCursor, int[] rowsLocated) Populate the network analysis class.
void	release() Release a NAClassLoader.
void	setAddressLocatorByRef(ILocator addressLocator) The address locator to be used.
void	setFieldMapByRef(INAClassFieldMap fieldMapping) The field mapping definition.
void	setLocatorByRef(INALocator loaderLocator) The locator to be used.
void	setNAClassByRef(INAClass classToLoadInto) The network analysis class.
void	setSnapOffsetDistance(double distance) The snap offset distance from the network.
void	setSnapOffsetUnits(int units) The snap offset units.
void	setSnapToNetwork(boolean enabled) Indicates if the geometry should be snapped to the network.

Methods inherited from class java.lang.Object

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

Constructor Detail

NAClassLoader

public NAClassLoader()
              throws java.io.IOException,
                     java.net.UnknownHostException

Constructs a NAClassLoader using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NAClassLoader

public NAClassLoader(java.lang.Object obj)
              throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a NAClassLoader.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setNAClassByRef

public void setNAClassByRef(INAClass classToLoadInto)
                     throws java.io.IOException,
                            AutomationException

The network analysis class.

Specified by:

setNAClassByRef in interface INAClassLoader

Parameters:

classToLoadInto - A reference to a com.esri.arcgis.networkanalyst.INAClass (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNAClass

public INAClass getNAClass()
                    throws java.io.IOException,
                           AutomationException

The network analysis class.

Specified by:

getNAClass in interface INAClassLoader

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAClass

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFieldMapByRef

public void setFieldMapByRef(INAClassFieldMap fieldMapping)
                      throws java.io.IOException,
                             AutomationException

The field mapping definition.

Specified by:

setFieldMapByRef in interface INAClassLoader

Parameters:

fieldMapping - A reference to a com.esri.arcgis.networkanalyst.INAClassFieldMap (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldMap

public INAClassFieldMap getFieldMap()
                             throws java.io.IOException,
                                    AutomationException

The field mapping definition.

Specified by:

getFieldMap in interface INAClassLoader

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAClassFieldMap

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocatorByRef

public void setLocatorByRef(INALocator loaderLocator)
                     throws java.io.IOException,
                            AutomationException

The locator to be used.

Specified by:

setLocatorByRef in interface INAClassLoader

Parameters:

loaderLocator - A reference to a com.esri.arcgis.networkanalyst.INALocator (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocator

public INALocator getLocator()
                      throws java.io.IOException,
                             AutomationException

The locator to be used.

Specified by:

getLocator in interface INAClassLoader

Returns:

A reference to a com.esri.arcgis.networkanalyst.INALocator

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(ICursor cursor,
                 ITrackCancel trackCancel,
                 int[] rowsInCursor,
                 int[] rowsLocated)
          throws java.io.IOException,
                 AutomationException

Populate the network analysis class.

Specified by:

load in interface INAClassLoader

Parameters:

cursor - A reference to a com.esri.arcgis.geodatabase.ICursor (in)

trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)

rowsInCursor - The rowsInCursor (in/out: use single element array)

rowsLocated - The rowsLocated (in/out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(INAContext context,
                       java.lang.String nAClassName,
                       ICursor cursor)
                throws java.io.IOException,
                       AutomationException

Quickly initializes the class loader to be able to load information from a cursor into a given NAClass.

Specified by:

initialize in interface INAClassLoader2

Parameters:

context - A reference to a com.esri.arcgis.networkanalyst.INAContext (in)

nAClassName - The nAClassName (in)

cursor - A reference to a com.esri.arcgis.geodatabase.ICursor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAddressLocatorByRef

public void setAddressLocatorByRef(ILocator addressLocator)
                            throws java.io.IOException,
                                   AutomationException

The address locator to be used.

Specified by:

setAddressLocatorByRef in interface INAClassLoader2

Parameters:

addressLocator - A reference to a com.esri.arcgis.geodatabase.ILocator (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAddressLocator

public ILocator getAddressLocator()
                           throws java.io.IOException,
                                  AutomationException

The address locator to be used.

Specified by:

getAddressLocator in interface INAClassLoader2

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapToNetwork

public void setSnapToNetwork(boolean enabled)
                      throws java.io.IOException,
                             AutomationException

Indicates if the geometry should be snapped to the network.

Specified by:

setSnapToNetwork in interface INAClassLoader2

Parameters:

enabled - The enabled (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSnapToNetwork

public boolean isSnapToNetwork()
                        throws java.io.IOException,
                               AutomationException

Indicates if the geometry should be snapped to the network.

Specified by:

isSnapToNetwork in interface INAClassLoader2

Returns:

The enabled

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapOffsetDistance

public void setSnapOffsetDistance(double distance)
                           throws java.io.IOException,
                                  AutomationException

The snap offset distance from the network.

Specified by:

setSnapOffsetDistance in interface INAClassLoader2

Parameters:

distance - The distance (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapOffsetDistance

public double getSnapOffsetDistance()
                             throws java.io.IOException,
                                    AutomationException

The snap offset distance from the network.

Specified by:

getSnapOffsetDistance in interface INAClassLoader2

Returns:

The distance

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSnapOffsetUnits

public void setSnapOffsetUnits(int units)
                        throws java.io.IOException,
                               AutomationException

The snap offset units.

Specified by:

setSnapOffsetUnits in interface INAClassLoader2

Parameters:

units - A com.esri.arcgis.system.esriUnits constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSnapOffsetUnits

public int getSnapOffsetUnits()
                       throws java.io.IOException,
                              AutomationException

The snap offset units.

Specified by:

getSnapOffsetUnits in interface INAClassLoader2

Returns:

A com.esri.arcgis.system.esriUnits constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.