com.esri.arcgis.networkanalysis
Class NetworkLoader

java.lang.Object
  com.esri.arcgis.networkanalysis.NetworkLoader

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INetworkLoader, INetworkLoader2, INetworkLoader3, INetworkLoaderProps, ISupportErrorInfo, java.io.Serializable

public class NetworkLoader
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INetworkLoader, INetworkLoader2, INetworkLoader3, INetworkLoaderProps, ISupportErrorInfo

COM Class 'NetworkLoader'. Generated 3/19/2015 1:20:44 PM from 'C:\ArcGIS\COM\esriNetworkAnalysis.olb'

Description 'A container for specifying the parameters for building a geometric network.' 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.networkanalysis.INetworkLoader3

IID, IID3e11f7be_9c8e_4ce3_b282_91740166259f, xxDummy

Fields inherited from interface com.esri.arcgis.networkanalysis.INetworkLoader2

IIDdf31f749_148d_11d4_a0ea_00c04f6bdf0e

Fields inherited from interface com.esri.arcgis.networkanalysis.INetworkLoader

IID3b310ed4_772a_11d1_b25b_0000f878229e

Fields inherited from interface com.esri.arcgis.networkanalysis.INetworkLoaderProps

IID, IID8f313d14_49de_11d3_9f5a_00c04f68e627, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Constructor Summary

NetworkLoader()
Constructs a NetworkLoader using ArcGIS Engine.

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

Method Summary

void	addFeatureClass(java.lang.String featureClassName, int newFeatureType, IUID newClsID, boolean canChangeGeometry) Adds a feature class to the new geometric network.
void	addINetworkLoaderProgressListener(INetworkLoaderProgress theListener) addINetworkLoaderProgressListener.
void	addWeight(java.lang.String networkWeightName, int weightType, int bitGateSize) Adds a weight to the new geometric network.
void	addWeightAssociation(java.lang.String networkWeightName, java.lang.String featureClassName, java.lang.String fieldName) Adds an association between a network weight and a feature class attribute.
int	canUseFeatureClass(java.lang.String featureClassName) Determines if the given feature class can participate in a network.
int	checkAncillaryRoleField(java.lang.String featureClassName, java.lang.String fieldName) Determines whether the given AncillaryRole field is valid.
int	checkEnabledDisabledField(java.lang.String featureClassName, java.lang.String fieldName) Determines whether the given Enabled field is valid.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
java.lang.String	getDefaultAncillaryRoleDomain() Default ancillary role domain name.
java.lang.String	getDefaultAncillaryRoleField() Default ancillary role field name.
java.lang.String	getDefaultEnabledDomain() Default enabled domain name.
java.lang.String	getDefaultEnabledField() Default enabled field name.
double	getDefaultSnapTolerance() Default nonzero XY cluster tolerance.
double	getDefaultZSnapTolerance() Default nonzero Z cluster tolerance.
java.lang.String	getErrorTableName() Name of the table containing errors encountered while building the new geometric network.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
double	getMaxSnapTolerance() Maximum nonzero XY cluster tolerance.
double	getMaxZSnapTolerance() Maximum nonzero Z cluster tolerance.
double	getMinSnapTolerance() Minimum nonzero snap tolerance for creating a new geometric network.
double	getMinZSnapTolerance() Minimum nonzero Z cluster tolerance.
int	getNumInvalidFeatures(java.lang.String featureClassName) Number of features with invalid geometry in the given feature class.
int	getTotalNumInvalidFeatures() Total number of features with invalid geometry.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isCanUseZs() Indicates if Z coordinates are used for snapping and connectivity.
void	loadNetwork() Creates the new geometric network inside the feature dataset.
void	putAncillaryRole(java.lang.String featureClassName, int ancillaryRole, java.lang.String ancillaryRoleFieldName) Specifies the ancillary role attribute field for the specified feature class.
void	putEnabledDisabledFieldName(java.lang.String featureClassName, java.lang.String enabledDisabledFieldName) Specifies the enabled/disabled field for the specified feature class.
void	release() Release a NetworkLoader.
void	removeINetworkLoaderProgressListener(INetworkLoaderProgress theListener) removeINetworkLoaderProgressListener.
void	setConfigurationKeyword(java.lang.String rhs1) Configuration keyword for the new geometric network.
void	setFeatureDatasetNameByRef(IDatasetName rhs1) Feature dataset name to where the new geometric network is to be created.
void	setNetworkName(java.lang.String rhs1) Name of the new geometric network.
void	setNetworkType(int rhs1) Network type of the new geometric network.
void	setPreserveEnabledValues(boolean rhs1) Indicates if the Network Loader should preserve the values in the existing Enabled fields.
void	setSnapTolerance(double rhs1) Snap tolerance to be used in creating the new geometric network.
void	setUseXYsForSnapping(boolean rhs1) Indicates if the feature classes are snapped on XY plane.
void	setUseZs(boolean rhs1) Indicates if Z coordinates are used for snapping and connectivity.
void	setZSnapTolerance(double rhs1) Snap tolerance for Z coordinates.

Methods inherited from class java.lang.Object

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

Constructor Detail

NetworkLoader

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

Constructs a NetworkLoader using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NetworkLoader

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

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

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

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

addINetworkLoaderProgressListener

public void addINetworkLoaderProgressListener(INetworkLoaderProgress theListener)
                                       throws java.io.IOException

addINetworkLoaderProgressListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalysis.INetworkLoaderProgress interface.

Throws:

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

removeINetworkLoaderProgressListener

public void removeINetworkLoaderProgressListener(INetworkLoaderProgress theListener)
                                          throws java.io.IOException

removeINetworkLoaderProgressListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalysis.INetworkLoaderProgress interface.

Throws:

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

release

public void release()

Release a NetworkLoader.

Specified by:

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

setNetworkType

public void setNetworkType(int rhs1)
                    throws java.io.IOException,
                           AutomationException

Network type of the new geometric network.

Specified by:

setNetworkType in interface INetworkLoader

Parameters:

rhs1 - A com.esri.arcgis.geodatabase.esriNetworkType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

public void setSnapTolerance(double rhs1)
                      throws java.io.IOException,
                             AutomationException

Snap tolerance to be used in creating the new geometric network.

Specified by:

setSnapTolerance in interface INetworkLoader

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNetworkName

public void setNetworkName(java.lang.String rhs1)
                    throws java.io.IOException,
                           AutomationException

Name of the new geometric network.

Specified by:

setNetworkName in interface INetworkLoader

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFeatureDatasetNameByRef

public void setFeatureDatasetNameByRef(IDatasetName rhs1)
                                throws java.io.IOException,
                                       AutomationException

Feature dataset name to where the new geometric network is to be created.

Specified by:

setFeatureDatasetNameByRef in interface INetworkLoader

Parameters:

rhs1 - A reference to a com.esri.arcgis.geodatabase.IDatasetName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addFeatureClass

public void addFeatureClass(java.lang.String featureClassName,
                            int newFeatureType,
                            IUID newClsID,
                            boolean canChangeGeometry)
                     throws java.io.IOException,
                            AutomationException

Adds a feature class to the new geometric network.

Specified by:

addFeatureClass in interface INetworkLoader

Parameters:

featureClassName - The featureClassName (in)

newFeatureType - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)

newClsID - A reference to a com.esri.arcgis.system.IUID (in)

canChangeGeometry - The canChangeGeometry (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addWeight

public void addWeight(java.lang.String networkWeightName,
                      int weightType,
                      int bitGateSize)
               throws java.io.IOException,
                      AutomationException

Adds a weight to the new geometric network.

Specified by:

addWeight in interface INetworkLoader

Parameters:

networkWeightName - The networkWeightName (in)

weightType - A com.esri.arcgis.geodatabase.esriWeightType constant (in)

bitGateSize - The bitGateSize (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addWeightAssociation

public void addWeightAssociation(java.lang.String networkWeightName,
                                 java.lang.String featureClassName,
                                 java.lang.String fieldName)
                          throws java.io.IOException,
                                 AutomationException

Adds an association between a network weight and a feature class attribute.

Specified by:

addWeightAssociation in interface INetworkLoader

Parameters:

networkWeightName - The networkWeightName (in)

featureClassName - The featureClassName (in)

fieldName - The fieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putAncillaryRole

public void putAncillaryRole(java.lang.String featureClassName,
                             int ancillaryRole,
                             java.lang.String ancillaryRoleFieldName)
                      throws java.io.IOException,
                             AutomationException

Specifies the ancillary role attribute field for the specified feature class.

Specified by:

putAncillaryRole in interface INetworkLoader

Parameters:

featureClassName - The featureClassName (in)

ancillaryRole - A com.esri.arcgis.geodatabase.esriNetworkClassAncillaryRole constant (in)

ancillaryRoleFieldName - The ancillaryRoleFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

putEnabledDisabledFieldName

public void putEnabledDisabledFieldName(java.lang.String featureClassName,
                                        java.lang.String enabledDisabledFieldName)
                                 throws java.io.IOException,
                                        AutomationException

Specifies the enabled/disabled field for the specified feature class.

Specified by:

putEnabledDisabledFieldName in interface INetworkLoader

Parameters:

featureClassName - The featureClassName (in)

enabledDisabledFieldName - The enabledDisabledFieldName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

loadNetwork

public void loadNetwork()
                 throws java.io.IOException,
                        AutomationException

Creates the new geometric network inside the feature dataset.

Specified by:

loadNetwork in interface INetworkLoader

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setConfigurationKeyword

public void setConfigurationKeyword(java.lang.String rhs1)
                             throws java.io.IOException,
                                    AutomationException

Configuration keyword for the new geometric network.

Specified by:

setConfigurationKeyword in interface INetworkLoader2

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinSnapTolerance

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

Minimum nonzero snap tolerance for creating a new geometric network.

Specified by:

getMinSnapTolerance in interface INetworkLoader2

Returns:

The pMinSnapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

canUseFeatureClass

public int canUseFeatureClass(java.lang.String featureClassName)
                       throws java.io.IOException,
                              AutomationException

Determines if the given feature class can participate in a network.

Specified by:

canUseFeatureClass in interface INetworkLoader2

Parameters:

featureClassName - The featureClassName (in)

Returns:

A com.esri.arcgis.networkanalysis.esriNetworkLoaderFeatureClassCheck constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkEnabledDisabledField

public int checkEnabledDisabledField(java.lang.String featureClassName,
                                     java.lang.String fieldName)
                              throws java.io.IOException,
                                     AutomationException

Determines whether the given Enabled field is valid.

Specified by:

checkEnabledDisabledField in interface INetworkLoader2

Parameters:

featureClassName - The featureClassName (in)

fieldName - The fieldName (in)

Returns:

A com.esri.arcgis.networkanalysis.esriNetworkLoaderFieldCheck constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

checkAncillaryRoleField

public int checkAncillaryRoleField(java.lang.String featureClassName,
                                   java.lang.String fieldName)
                            throws java.io.IOException,
                                   AutomationException

Determines whether the given AncillaryRole field is valid.

Specified by:

checkAncillaryRoleField in interface INetworkLoader2

Parameters:

featureClassName - The featureClassName (in)

fieldName - The fieldName (in)

Returns:

A com.esri.arcgis.networkanalysis.esriNetworkLoaderFieldCheck constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPreserveEnabledValues

public void setPreserveEnabledValues(boolean rhs1)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the Network Loader should preserve the values in the existing Enabled fields.

Specified by:

setPreserveEnabledValues in interface INetworkLoader2

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getErrorTableName

public java.lang.String getErrorTableName()
                                   throws java.io.IOException,
                                          AutomationException

Name of the table containing errors encountered while building the new geometric network.

Specified by:

getErrorTableName in interface INetworkLoader2

Returns:

The pErrorTableName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTotalNumInvalidFeatures

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

Total number of features with invalid geometry.

Specified by:

getTotalNumInvalidFeatures in interface INetworkLoader2

Returns:

The pTotalNumInvalidFeatures

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumInvalidFeatures

public int getNumInvalidFeatures(java.lang.String featureClassName)
                          throws java.io.IOException,
                                 AutomationException

Number of features with invalid geometry in the given feature class.

Specified by:

getNumInvalidFeatures in interface INetworkLoader2

Parameters:

featureClassName - The featureClassName (in)

Returns:

The pNumInvalidFeatures

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseXYsForSnapping

public void setUseXYsForSnapping(boolean rhs1)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the feature classes are snapped on XY plane.

Specified by:

setUseXYsForSnapping in interface INetworkLoader3

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanUseZs

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

Indicates if Z coordinates are used for snapping and connectivity.

Specified by:

isCanUseZs in interface INetworkLoader3

Returns:

The canUseZs

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseZs

public void setUseZs(boolean rhs1)
              throws java.io.IOException,
                     AutomationException

Indicates if Z coordinates are used for snapping and connectivity.

Specified by:

setUseZs in interface INetworkLoader3

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setZSnapTolerance

public void setZSnapTolerance(double rhs1)
                       throws java.io.IOException,
                              AutomationException

Snap tolerance for Z coordinates.

Specified by:

setZSnapTolerance in interface INetworkLoader3

Parameters:

rhs1 - The rhs1 (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxSnapTolerance

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

Maximum nonzero XY cluster tolerance.

Specified by:

getMaxSnapTolerance in interface INetworkLoader3

Returns:

The maxSnapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultSnapTolerance

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

Default nonzero XY cluster tolerance.

Specified by:

getDefaultSnapTolerance in interface INetworkLoader3

Returns:

The defaultSnapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMinZSnapTolerance

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

Minimum nonzero Z cluster tolerance.

Specified by:

getMinZSnapTolerance in interface INetworkLoader3

Returns:

The minZSnapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxZSnapTolerance

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

Maximum nonzero Z cluster tolerance.

Specified by:

getMaxZSnapTolerance in interface INetworkLoader3

Returns:

The maxZSnapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultZSnapTolerance

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

Default nonzero Z cluster tolerance.

Specified by:

getDefaultZSnapTolerance in interface INetworkLoader3

Returns:

The defaultZSnapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultEnabledDomain

public java.lang.String getDefaultEnabledDomain()
                                         throws java.io.IOException,
                                                AutomationException

Default enabled domain name.

Specified by:

getDefaultEnabledDomain in interface INetworkLoaderProps

Returns:

The defaultEnabledDomain

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultEnabledField

public java.lang.String getDefaultEnabledField()
                                        throws java.io.IOException,
                                               AutomationException

Default enabled field name.

Specified by:

getDefaultEnabledField in interface INetworkLoaderProps

Returns:

The defaultEnabledField

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultAncillaryRoleDomain

public java.lang.String getDefaultAncillaryRoleDomain()
                                               throws java.io.IOException,
                                                      AutomationException

Default ancillary role domain name.

Specified by:

getDefaultAncillaryRoleDomain in interface INetworkLoaderProps

Returns:

The defaultAncillaryRoleDomain

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultAncillaryRoleField

public java.lang.String getDefaultAncillaryRoleField()
                                              throws java.io.IOException,
                                                     AutomationException

Default ancillary role field name.

Specified by:

getDefaultAncillaryRoleField in interface INetworkLoaderProps

Returns:

The defaultAncillaryRoleField

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.