com.esri.arcgis.networkanalyst
Class NAServerLocationAllocationParams

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INALocationAllocationSolver, INAServerLocationAllocationParams, INAServerSolverParams, INAServerSolverParams2, INAServerSolverParams3, INASolverSettings, INASolverSettings2, INATimeAwareSolverSettings, INATimeAwareSolverSettings2, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, IXMLVersionSupport, java.io.Externalizable, java.io.Serializable

public class NAServerLocationAllocationParams
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAServerSolverParams, INAServerSolverParams2, INAServerSolverParams3, INAServerLocationAllocationParams, INASolverSettings, INASolverSettings2, INALocationAllocationSolver, INATimeAwareSolverSettings, INATimeAwareSolverSettings2, IXMLSerialize, IPersist, IPersistStream, ISupportErrorInfo, IXMLVersionSupport, java.io.Externalizable

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

Description 'Deprecated as of 10.0. A container for the Location-Allocation solver settings and return parameters used by NAServer.' 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

static long

serialVersionUID

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

IID, IID1bb2d1b6_cabf_4eba_bbd1_d9ed4a92f414, xxDummy

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

IID1fb9dd3f_a315_4df0_a02a_3358a2bee920

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

IID40635a1f_4c95_4f57_a220_c683941715e5

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

IID, IID5f8a3857_106a_4880_abe8_57ead44ef4d6, xxDummy

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

IID, IIDd3696546_2831_4aa5_a879_acd66e50a938, xxDummy

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

IID5a8dc105_0e57_45c8_a01d_0188ce7f7b52

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

IID, IID51b22eed_7a65_4037_b2b9_8bcfe354e4c5, xxDummy

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

IID, IID3d8bbac9_2ebd_4f2f_bafe_bf9da41beb80, xxDummy

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

IIDe9cbb341_3c3c_41a1_a660_784708288434

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IID72ca65b9_13de_48b7_8443_717b69b72a99, xxDummy

Constructor Summary

NAServerLocationAllocationParams()
Constructs a NAServerLocationAllocationParams using ArcGIS Engine.

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

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IStringArray	getAccumulateAttributeNames() The collection of network attribute names to be accumulated with the analysis.
java.lang.Object	getAttributeParameterValue(java.lang.String attributeName, java.lang.String paramName) The value to use for an attribute parameter within the network dataset.
INAServerLocations	getBarriers() RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
java.lang.Object	getDefaultCutoff() Determines the default cutoff beyond which no demand point can be allocated to a facility
INAServerLocations	getDemandPoints() RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.
INAServerLocations	getFacilities() RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
java.lang.String	getHierarchyAttributeName() The name of the hierarchy attribute to be used in analysis.
int	getHierarchyLevelCount() The number of levels in the hierarchy attribute.
IImageDescription	getImageDescription() ImageDescription used when generating the MapImage returned with the analysis results.
java.lang.String	getImpedanceAttributeName() The network attribute name to be used as the impedance attribute in analysis.
int	getImpedanceTransformation() Determines which formula will modify the impedance.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getLayerToken() Token identifying the network analysis layer on the server to use.
IMapDescription	getMapDescription() MapDescription used when generating the MapImage returned with the analysis results.
double	getMaxSnapTolerance() Maximum search tolerance used when attempting to load network locations.
int	getMaxValueForHierarchy(int level) The maximum value of the hierarchy attribute.
java.lang.String	getMinNamespaceSupported() The minimum namespace the class can serialize to (eg the 90 namespace).
INAClassCandidateFieldMap[]	getNAClassCandidateFieldMaps() Array of NAClassCandidateFieldMaps .
java.lang.String	getNALayerName() Network analysis layer name.
int	getNumberFacilitiesToLocate() Determines how many facilities will be present in the solution.
int	getNumTransitionToHierarchy(int toLevel) The number of lower level junctions to explore before searching the next hierarchy level.
int	getOutputLines() Specifies what if any shape geometry will be output
ISpatialReference	getOutputSpatialReference() Spatial reference of the geometries returned with the analysis results.
INAServerLocations	getPolygonBarriers() RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
INAServerLocations	getPolylineBarriers() RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
int	getProblemType() Specifies which location-allocation problem type to solve.
IStringArray	getRestrictionAttributeNames() The collection of network attribute names to be used as restrictions with the analysis.
int	getRestrictUTurns() Indicates how U-Turns should be restricted in the analysis.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getSnapTolerance() Minimum search tolerance used when attempting to load network locations.
int	getSnapToleranceUnits() Length units of the SnapTolerance and MaxSnapTolerance.
double	getTargetMarketSharePercentage() Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.
java.util.Date	getTimeOfDay() The date-time value used in time-aware solvers.
int	getTimeOfDayUsage() The usage type for the TimeOfDay property.
double	getTransformationParameter() Applies to the impedance transformation.
int	getTravelDirection() Specifies which direction the network will be traversed
java.lang.String	getTravelMode() Specifies the travel mode.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
void	isDirty() isDirty
boolean	isIgnoreInvalidLocations() Indicates if invalid locations should be ignored or raise an error.
boolean	isResetHierarchyRangesOnBind() Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
boolean	isReturnBarriers() Indicates if the output Barriers recordset should be returned with the analysis results.
boolean	isReturnDemandPoints() Indicates if the output DemandPoints recordset should be returned with the analysis results.
boolean	isReturnFacilities() Indicates if the output Facilities recordset should be returned with the analysis results.
boolean	isReturnLALines() Indicates if the output LALines recordset should be returned with the analysis results.
boolean	isReturnMap() Indicates if a MapImage should be generated and returned with the analysis results.
boolean	isReturnPartialResultsOnError() Indicates if the result object should be returned even if an error was generated during the solve operation.
boolean	isReturnPolygonBarriers() Indicates if the output polygon barriers recordset should be returned with the analysis results.
boolean	isReturnPolylineBarriers() Indicates if the output polyline barriers recordset should be returned with the analysis results.
boolean	isSaveLayerOnServer() Indicates if the resulting analysis layer should be saved on the server.
boolean	isTimeOfDayIsUTC() Indicates whether the date-time value used in time-aware solvers is UTC or local time.
boolean	isUseHierarchy() Indicates if the hierarchy attribute for the network should be used in analysis.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a NAServerLocationAllocationParams.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setAccumulateAttributeNamesByRef(IStringArray attributeNames) The collection of network attribute names to be accumulated with the analysis.
void	setAttributeParameterValue(java.lang.String attributeName, java.lang.String paramName, java.lang.Object value) The value to use for an attribute parameter within the network dataset.
void	setBarriersByRef(INAServerLocations barriers) RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.
void	setDefaultCutoff(java.lang.Object value) Determines the default cutoff beyond which no demand point can be allocated to a facility
void	setDemandPointsByRef(INAServerLocations demandPoints) RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.
void	setFacilitiesByRef(INAServerLocations facilities) RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.
void	setHierarchyAttributeName(java.lang.String attributeName) The name of the hierarchy attribute to be used in analysis.
void	setHierarchyLevelCount(int count) The number of levels in the hierarchy attribute.
void	setIgnoreInvalidLocations(boolean ignoreInvalidLocations) Indicates if invalid locations should be ignored or raise an error.
void	setImageDescriptionByRef(IImageDescription imageDescription) ImageDescription used when generating the MapImage returned with the analysis results.
void	setImpedanceAttributeName(java.lang.String attributeName) The network attribute name to be used as the impedance attribute in analysis.
void	setImpedanceTransformation(int value) Determines which formula will modify the impedance.
void	setLayerToken(java.lang.String layerToken) Token identifying the network analysis layer on the server to use.
void	setMapDescriptionByRef(IMapDescription mapDescription) MapDescription used when generating the MapImage returned with the analysis results.
void	setMaxSnapTolerance(double maxSnapTolerance) Maximum search tolerance used when attempting to load network locations.
void	setMaxValueForHierarchy(int level, int value) The maximum value of the hierarchy attribute.
void	setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps) Array of NAClassCandidateFieldMaps .
void	setNALayerName(java.lang.String nALayerName) Network analysis layer name.
void	setNumberFacilitiesToLocate(int value) Determines how many facilities will be present in the solution.
void	setNumTransitionToHierarchy(int toLevel, int value) The number of lower level junctions to explore before searching the next hierarchy level.
void	setOutputLines(int value) Specifies what if any shape geometry will be output
void	setOutputSpatialReferenceByRef(ISpatialReference spatialReference) Spatial reference of the geometries returned with the analysis results.
void	setPolygonBarriersByRef(INAServerLocations polygonBarriers) RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.
void	setPolylineBarriersByRef(INAServerLocations polylineBarriers) RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.
void	setProblemType(int value) Specifies which location-allocation problem type to solve.
void	setResetHierarchyRangesOnBind(boolean value) Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.
void	setRestrictionAttributeNamesByRef(IStringArray attributeName) The collection of network attribute names to be used as restrictions with the analysis.
void	setRestrictUTurns(int backtrack) Indicates how U-Turns should be restricted in the analysis.
void	setReturnBarriers(boolean returnBarriers) Indicates if the output Barriers recordset should be returned with the analysis results.
void	setReturnDemandPoints(boolean returnDemandPoints) Indicates if the output DemandPoints recordset should be returned with the analysis results.
void	setReturnFacilities(boolean returnFacilities) Indicates if the output Facilities recordset should be returned with the analysis results.
void	setReturnLALines(boolean returnLALines) Indicates if the output LALines recordset should be returned with the analysis results.
void	setReturnMap(boolean returnMap) Indicates if a MapImage should be generated and returned with the analysis results.
void	setReturnPartialResultsOnError(boolean returnPartialResultsOnError) Indicates if the result object should be returned even if an error was generated during the solve operation.
void	setReturnPolygonBarriers(boolean returnBarriers) Indicates if the output polygon barriers recordset should be returned with the analysis results.
void	setReturnPolylineBarriers(boolean returnBarriers) Indicates if the output polyline barriers recordset should be returned with the analysis results.
void	setSaveLayerOnServer(boolean saveLayerOnServer) Indicates if the resulting analysis layer should be saved on the server.
void	setSnapTolerance(double snapTolerance) Minimum search tolerance used when attempting to load network locations.
void	setSnapToleranceUnits(int snapToleranceUnits) Length units of the SnapTolerance and MaxSnapTolerance.
void	setTargetMarketSharePercentage(double value) Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.
void	setTimeOfDay(java.util.Date timeOfDay) The date-time value used in time-aware solvers.
void	setTimeOfDayIsUTC(boolean timeOfDayIsUTC) Indicates whether the date-time value used in time-aware solvers is UTC or local time.
void	setTimeOfDayUsage(int timeOfDayUsage) The usage type for the TimeOfDay property.
void	setTransformationParameter(double value) Applies to the impedance transformation.
void	setTravelDirection(int value) Specifies which direction the network will be traversed
void	setTravelMode(java.lang.String value) Specifies the travel mode.
void	setUseHierarchy(boolean useHierarchy) Indicates if the hierarchy attribute for the network should be used in analysis.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

NAServerLocationAllocationParams

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

Constructs a NAServerLocationAllocationParams using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NAServerLocationAllocationParams

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

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

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

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 NAServerLocationAllocationParams.

Specified by:

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

setNALayerName

public void setNALayerName(java.lang.String nALayerName)
                    throws java.io.IOException,
                           AutomationException

Network analysis layer name.

Specified by:

setNALayerName in interface INAServerSolverParams

Parameters:

nALayerName - The nALayerName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNALayerName

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

Network analysis layer name.

Specified by:

getNALayerName in interface INAServerSolverParams

Returns:

The nALayerName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapTolerance

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

Minimum search tolerance used when attempting to load network locations.

Specified by:

setSnapTolerance in interface INAServerSolverParams

Parameters:

snapTolerance - The snapTolerance (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSnapTolerance

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

Minimum search tolerance used when attempting to load network locations.

Specified by:

getSnapTolerance in interface INAServerSolverParams

Returns:

The snapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxSnapTolerance

public void setMaxSnapTolerance(double maxSnapTolerance)
                         throws java.io.IOException,
                                AutomationException

Maximum search tolerance used when attempting to load network locations.

Specified by:

setMaxSnapTolerance in interface INAServerSolverParams

Parameters:

maxSnapTolerance - The maxSnapTolerance (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 search tolerance used when attempting to load network locations.

Specified by:

getMaxSnapTolerance in interface INAServerSolverParams

Returns:

The maxSnapTolerance

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSnapToleranceUnits

public void setSnapToleranceUnits(int snapToleranceUnits)
                           throws java.io.IOException,
                                  AutomationException

Length units of the SnapTolerance and MaxSnapTolerance.

Specified by:

setSnapToleranceUnits in interface INAServerSolverParams

Parameters:

snapToleranceUnits - 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.

getSnapToleranceUnits

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

Length units of the SnapTolerance and MaxSnapTolerance.

Specified by:

getSnapToleranceUnits in interface INAServerSolverParams

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.

setNAClassCandidateFieldMaps

public void setNAClassCandidateFieldMaps(INAClassCandidateFieldMap[] ppNAClassCandidateFieldMaps)
                                  throws java.io.IOException,
                                         AutomationException

Array of NAClassCandidateFieldMaps .

Specified by:

setNAClassCandidateFieldMaps in interface INAServerSolverParams

Parameters:

ppNAClassCandidateFieldMaps - A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNAClassCandidateFieldMaps

public INAClassCandidateFieldMap[] getNAClassCandidateFieldMaps()
                                                         throws java.io.IOException,
                                                                AutomationException

Array of NAClassCandidateFieldMaps .

Specified by:

getNAClassCandidateFieldMaps in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.networkanalyst.INAClassCandidateFieldMap array

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnMap

public void setReturnMap(boolean returnMap)
                  throws java.io.IOException,
                         AutomationException

Indicates if a MapImage should be generated and returned with the analysis results.

Specified by:

setReturnMap in interface INAServerSolverParams

Parameters:

returnMap - The returnMap (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnMap

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

Indicates if a MapImage should be generated and returned with the analysis results.

Specified by:

isReturnMap in interface INAServerSolverParams

Returns:

The returnMap

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMapDescriptionByRef

public void setMapDescriptionByRef(IMapDescription mapDescription)
                            throws java.io.IOException,
                                   AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Specified by:

setMapDescriptionByRef in interface INAServerSolverParams

Parameters:

mapDescription - A reference to a com.esri.arcgis.carto.IMapDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMapDescription

public IMapDescription getMapDescription()
                                  throws java.io.IOException,
                                         AutomationException

MapDescription used when generating the MapImage returned with the analysis results.

Specified by:

getMapDescription in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.carto.IMapDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setImageDescriptionByRef

public void setImageDescriptionByRef(IImageDescription imageDescription)
                              throws java.io.IOException,
                                     AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Specified by:

setImageDescriptionByRef in interface INAServerSolverParams

Parameters:

imageDescription - A reference to a com.esri.arcgis.carto.IImageDescription (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImageDescription

public IImageDescription getImageDescription()
                                      throws java.io.IOException,
                                             AutomationException

ImageDescription used when generating the MapImage returned with the analysis results.

Specified by:

getImageDescription in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.carto.IImageDescription

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(ISpatialReference spatialReference)
                                    throws java.io.IOException,
                                           AutomationException

Spatial reference of the geometries returned with the analysis results.

Specified by:

setOutputSpatialReferenceByRef in interface INAServerSolverParams

Parameters:

spatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference()
                                            throws java.io.IOException,
                                                   AutomationException

Spatial reference of the geometries returned with the analysis results.

Specified by:

getOutputSpatialReference in interface INAServerSolverParams

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnPartialResultsOnError

public void setReturnPartialResultsOnError(boolean returnPartialResultsOnError)
                                    throws java.io.IOException,
                                           AutomationException

Indicates if the result object should be returned even if an error was generated during the solve operation.

Specified by:

setReturnPartialResultsOnError in interface INAServerSolverParams2

Parameters:

returnPartialResultsOnError - The returnPartialResultsOnError (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnPartialResultsOnError

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

Indicates if the result object should be returned even if an error was generated during the solve operation.

Specified by:

isReturnPartialResultsOnError in interface INAServerSolverParams2

Returns:

The returnPartialResultsOnError

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSaveLayerOnServer

public void setSaveLayerOnServer(boolean saveLayerOnServer)
                          throws java.io.IOException,
                                 AutomationException

Indicates if the resulting analysis layer should be saved on the server.

Specified by:

setSaveLayerOnServer in interface INAServerSolverParams2

Parameters:

saveLayerOnServer - The saveLayerOnServer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSaveLayerOnServer

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

Indicates if the resulting analysis layer should be saved on the server.

Specified by:

isSaveLayerOnServer in interface INAServerSolverParams2

Returns:

The saveLayerOnServer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerToken

public void setLayerToken(java.lang.String layerToken)
                   throws java.io.IOException,
                          AutomationException

Token identifying the network analysis layer on the server to use.

Specified by:

setLayerToken in interface INAServerSolverParams2

Parameters:

layerToken - The layerToken (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayerToken

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

Token identifying the network analysis layer on the server to use.

Specified by:

getLayerToken in interface INAServerSolverParams2

Returns:

The layerToken

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTravelMode

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

Specifies the travel mode.

Specified by:

getTravelMode in interface INAServerSolverParams3

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTravelMode

public void setTravelMode(java.lang.String value)
                   throws java.io.IOException,
                          AutomationException

Specifies the travel mode.

Specified by:

setTravelMode in interface INAServerSolverParams3

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFacilitiesByRef

public void setFacilitiesByRef(INAServerLocations facilities)
                        throws java.io.IOException,
                               AutomationException

RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.

Specified by:

setFacilitiesByRef in interface INAServerLocationAllocationParams

Parameters:

facilities - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFacilities

public INAServerLocations getFacilities()
                                 throws java.io.IOException,
                                        AutomationException

RecordSet or array of PropertySets representing Facilities loaded as network locations during analysis.

Specified by:

getFacilities in interface INAServerLocationAllocationParams

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDemandPointsByRef

public void setDemandPointsByRef(INAServerLocations demandPoints)
                          throws java.io.IOException,
                                 AutomationException

RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.

Specified by:

setDemandPointsByRef in interface INAServerLocationAllocationParams

Parameters:

demandPoints - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDemandPoints

public INAServerLocations getDemandPoints()
                                   throws java.io.IOException,
                                          AutomationException

RecordSet or array of PropertySets representing DemandPoints loaded as network locations during analysis.

Specified by:

getDemandPoints in interface INAServerLocationAllocationParams

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setBarriersByRef

public void setBarriersByRef(INAServerLocations barriers)
                      throws java.io.IOException,
                             AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Specified by:

setBarriersByRef in interface INAServerLocationAllocationParams

Parameters:

barriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getBarriers

public INAServerLocations getBarriers()
                               throws java.io.IOException,
                                      AutomationException

RecordSet or array of PropertySets representing Barriers loaded as network locations during analysis.

Specified by:

getBarriers in interface INAServerLocationAllocationParams

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPolylineBarriersByRef

public void setPolylineBarriersByRef(INAServerLocations polylineBarriers)
                              throws java.io.IOException,
                                     AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Specified by:

setPolylineBarriersByRef in interface INAServerLocationAllocationParams

Parameters:

polylineBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPolylineBarriers

public INAServerLocations getPolylineBarriers()
                                       throws java.io.IOException,
                                              AutomationException

RecordSet or array of PropertySets representing Polyline Barriers loaded as collections of network locations during analysis.

Specified by:

getPolylineBarriers in interface INAServerLocationAllocationParams

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setPolygonBarriersByRef

public void setPolygonBarriersByRef(INAServerLocations polygonBarriers)
                             throws java.io.IOException,
                                    AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Specified by:

setPolygonBarriersByRef in interface INAServerLocationAllocationParams

Parameters:

polygonBarriers - A reference to a com.esri.arcgis.networkanalyst.INAServerLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPolygonBarriers

public INAServerLocations getPolygonBarriers()
                                      throws java.io.IOException,
                                             AutomationException

RecordSet or array of PropertySets representing Polygon Barriers loaded as collections of network locations during analysis.

Specified by:

getPolygonBarriers in interface INAServerLocationAllocationParams

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnLALines

public void setReturnLALines(boolean returnLALines)
                      throws java.io.IOException,
                             AutomationException

Indicates if the output LALines recordset should be returned with the analysis results.

Specified by:

setReturnLALines in interface INAServerLocationAllocationParams

Parameters:

returnLALines - The returnLALines (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnLALines

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

Indicates if the output LALines recordset should be returned with the analysis results.

Specified by:

isReturnLALines in interface INAServerLocationAllocationParams

Returns:

The returnLALines

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnFacilities

public void setReturnFacilities(boolean returnFacilities)
                         throws java.io.IOException,
                                AutomationException

Indicates if the output Facilities recordset should be returned with the analysis results.

Specified by:

setReturnFacilities in interface INAServerLocationAllocationParams

Parameters:

returnFacilities - The returnFacilities (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnFacilities

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

Indicates if the output Facilities recordset should be returned with the analysis results.

Specified by:

isReturnFacilities in interface INAServerLocationAllocationParams

Returns:

The returnFacilities

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnDemandPoints

public void setReturnDemandPoints(boolean returnDemandPoints)
                           throws java.io.IOException,
                                  AutomationException

Indicates if the output DemandPoints recordset should be returned with the analysis results.

Specified by:

setReturnDemandPoints in interface INAServerLocationAllocationParams

Parameters:

returnDemandPoints - The returnDemandPoints (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnDemandPoints

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

Indicates if the output DemandPoints recordset should be returned with the analysis results.

Specified by:

isReturnDemandPoints in interface INAServerLocationAllocationParams

Returns:

The returnDemandPoints

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnBarriers

public void setReturnBarriers(boolean returnBarriers)
                       throws java.io.IOException,
                              AutomationException

Indicates if the output Barriers recordset should be returned with the analysis results.

Specified by:

setReturnBarriers in interface INAServerLocationAllocationParams

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnBarriers

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

Indicates if the output Barriers recordset should be returned with the analysis results.

Specified by:

isReturnBarriers in interface INAServerLocationAllocationParams

Returns:

The returnBarriers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnPolylineBarriers

public void setReturnPolylineBarriers(boolean returnBarriers)
                               throws java.io.IOException,
                                      AutomationException

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Specified by:

setReturnPolylineBarriers in interface INAServerLocationAllocationParams

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnPolylineBarriers

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

Indicates if the output polyline barriers recordset should be returned with the analysis results.

Specified by:

isReturnPolylineBarriers in interface INAServerLocationAllocationParams

Returns:

The returnBarriers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setReturnPolygonBarriers

public void setReturnPolygonBarriers(boolean returnBarriers)
                              throws java.io.IOException,
                                     AutomationException

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Specified by:

setReturnPolygonBarriers in interface INAServerLocationAllocationParams

Parameters:

returnBarriers - The returnBarriers (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isReturnPolygonBarriers

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

Indicates if the output polygon barriers recordset should be returned with the analysis results.

Specified by:

isReturnPolygonBarriers in interface INAServerLocationAllocationParams

Returns:

The returnBarriers

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAccumulateAttributeNames

public IStringArray getAccumulateAttributeNames()
                                         throws java.io.IOException,
                                                AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:

getAccumulateAttributeNames in interface INASolverSettings

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAccumulateAttributeNamesByRef

public void setAccumulateAttributeNamesByRef(IStringArray attributeNames)
                                      throws java.io.IOException,
                                             AutomationException

The collection of network attribute names to be accumulated with the analysis.

Specified by:

setAccumulateAttributeNamesByRef in interface INASolverSettings

Parameters:

attributeNames - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setImpedanceAttributeName

public void setImpedanceAttributeName(java.lang.String attributeName)
                               throws java.io.IOException,
                                      AutomationException

The network attribute name to be used as the impedance attribute in analysis.

Specified by:

setImpedanceAttributeName in interface INASolverSettings

Parameters:

attributeName - The attributeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImpedanceAttributeName

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

The network attribute name to be used as the impedance attribute in analysis.

Specified by:

getImpedanceAttributeName in interface INASolverSettings

Returns:

The attributeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setIgnoreInvalidLocations

public void setIgnoreInvalidLocations(boolean ignoreInvalidLocations)
                               throws java.io.IOException,
                                      AutomationException

Indicates if invalid locations should be ignored or raise an error.

Specified by:

setIgnoreInvalidLocations in interface INASolverSettings

Parameters:

ignoreInvalidLocations - The ignoreInvalidLocations (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIgnoreInvalidLocations

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

Indicates if invalid locations should be ignored or raise an error.

Specified by:

isIgnoreInvalidLocations in interface INASolverSettings

Returns:

The ignoreInvalidLocations

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRestrictionAttributeNames

public IStringArray getRestrictionAttributeNames()
                                          throws java.io.IOException,
                                                 AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:

getRestrictionAttributeNames in interface INASolverSettings

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRestrictionAttributeNamesByRef

public void setRestrictionAttributeNamesByRef(IStringArray attributeName)
                                       throws java.io.IOException,
                                              AutomationException

The collection of network attribute names to be used as restrictions with the analysis.

Specified by:

setRestrictionAttributeNamesByRef in interface INASolverSettings

Parameters:

attributeName - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setRestrictUTurns

public void setRestrictUTurns(int backtrack)
                       throws java.io.IOException,
                              AutomationException

Indicates how U-Turns should be restricted in the analysis.

Specified by:

setRestrictUTurns in interface INASolverSettings

Parameters:

backtrack - A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRestrictUTurns

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

Indicates how U-Turns should be restricted in the analysis.

Specified by:

getRestrictUTurns in interface INASolverSettings

Returns:

A com.esri.arcgis.geodatabase.esriNetworkForwardStarBacktrack constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setUseHierarchy

public void setUseHierarchy(boolean useHierarchy)
                     throws java.io.IOException,
                            AutomationException

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:

setUseHierarchy in interface INASolverSettings

Parameters:

useHierarchy - The useHierarchy (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isUseHierarchy

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

Indicates if the hierarchy attribute for the network should be used in analysis.

Specified by:

isUseHierarchy in interface INASolverSettings

Returns:

The useHierarchy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHierarchyAttributeName

public void setHierarchyAttributeName(java.lang.String attributeName)
                               throws java.io.IOException,
                                      AutomationException

The name of the hierarchy attribute to be used in analysis.

Specified by:

setHierarchyAttributeName in interface INASolverSettings

Parameters:

attributeName - The attributeName (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHierarchyAttributeName

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

The name of the hierarchy attribute to be used in analysis.

Specified by:

getHierarchyAttributeName in interface INASolverSettings

Returns:

The attributeName

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHierarchyLevelCount

public void setHierarchyLevelCount(int count)
                            throws java.io.IOException,
                                   AutomationException

The number of levels in the hierarchy attribute.

Specified by:

setHierarchyLevelCount in interface INASolverSettings

Parameters:

count - The count (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHierarchyLevelCount

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

The number of levels in the hierarchy attribute.

Specified by:

getHierarchyLevelCount in interface INASolverSettings

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setMaxValueForHierarchy

public void setMaxValueForHierarchy(int level,
                                    int value)
                             throws java.io.IOException,
                                    AutomationException

The maximum value of the hierarchy attribute.

Specified by:

setMaxValueForHierarchy in interface INASolverSettings

Parameters:

level - The level (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getMaxValueForHierarchy

public int getMaxValueForHierarchy(int level)
                            throws java.io.IOException,
                                   AutomationException

The maximum value of the hierarchy attribute.

Specified by:

getMaxValueForHierarchy in interface INASolverSettings

Parameters:

level - The level (in)

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumTransitionToHierarchy

public void setNumTransitionToHierarchy(int toLevel,
                                        int value)
                                 throws java.io.IOException,
                                        AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:

setNumTransitionToHierarchy in interface INASolverSettings

Parameters:

toLevel - The toLevel (in)

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumTransitionToHierarchy

public int getNumTransitionToHierarchy(int toLevel)
                                throws java.io.IOException,
                                       AutomationException

The number of lower level junctions to explore before searching the next hierarchy level.

Specified by:

getNumTransitionToHierarchy in interface INASolverSettings

Parameters:

toLevel - The toLevel (in)

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isResetHierarchyRangesOnBind

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

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:

isResetHierarchyRangesOnBind in interface INASolverSettings2

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setResetHierarchyRangesOnBind

public void setResetHierarchyRangesOnBind(boolean value)
                                   throws java.io.IOException,
                                          AutomationException

Indicates if the hierarchy ranges will be reset to the network dataset's hierarchy settings when the solver is bound.

Specified by:

setResetHierarchyRangesOnBind in interface INASolverSettings2

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getAttributeParameterValue

public java.lang.Object getAttributeParameterValue(java.lang.String attributeName,
                                                   java.lang.String paramName)
                                            throws java.io.IOException,
                                                   AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:

getAttributeParameterValue in interface INASolverSettings2

Parameters:

attributeName - The attributeName (in)

paramName - The paramName (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setAttributeParameterValue

public void setAttributeParameterValue(java.lang.String attributeName,
                                       java.lang.String paramName,
                                       java.lang.Object value)
                                throws java.io.IOException,
                                       AutomationException

The value to use for an attribute parameter within the network dataset.

Specified by:

setAttributeParameterValue in interface INASolverSettings2

Parameters:

attributeName - The attributeName (in)

paramName - The paramName (in)

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTravelDirection

public void setTravelDirection(int value)
                        throws java.io.IOException,
                               AutomationException

Specifies which direction the network will be traversed

Specified by:

setTravelDirection in interface INALocationAllocationSolver

Parameters:

value - A com.esri.arcgis.networkanalyst.esriNATravelDirection constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTravelDirection

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

Specifies which direction the network will be traversed

Specified by:

getTravelDirection in interface INALocationAllocationSolver

Returns:

A com.esri.arcgis.networkanalyst.esriNATravelDirection constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputLines

public void setOutputLines(int value)
                    throws java.io.IOException,
                           AutomationException

Specifies what if any shape geometry will be output

Specified by:

setOutputLines in interface INALocationAllocationSolver

Parameters:

value - A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputLines

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

Specifies what if any shape geometry will be output

Specified by:

getOutputLines in interface INALocationAllocationSolver

Returns:

A com.esri.arcgis.networkanalyst.esriNAOutputLineType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setProblemType

public void setProblemType(int value)
                    throws java.io.IOException,
                           AutomationException

Specifies which location-allocation problem type to solve.

Specified by:

setProblemType in interface INALocationAllocationSolver

Parameters:

value - A com.esri.arcgis.networkanalyst.esriNALocationAllocationProblemType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProblemType

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

Specifies which location-allocation problem type to solve.

Specified by:

getProblemType in interface INALocationAllocationSolver

Returns:

A com.esri.arcgis.networkanalyst.esriNALocationAllocationProblemType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNumberFacilitiesToLocate

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

Determines how many facilities will be present in the solution.

Specified by:

getNumberFacilitiesToLocate in interface INALocationAllocationSolver

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setNumberFacilitiesToLocate

public void setNumberFacilitiesToLocate(int value)
                                 throws java.io.IOException,
                                        AutomationException

Determines how many facilities will be present in the solution.

Specified by:

setNumberFacilitiesToLocate in interface INALocationAllocationSolver

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultCutoff

public java.lang.Object getDefaultCutoff()
                                  throws java.io.IOException,
                                         AutomationException

Determines the default cutoff beyond which no demand point can be allocated to a facility

Specified by:

getDefaultCutoff in interface INALocationAllocationSolver

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultCutoff

public void setDefaultCutoff(java.lang.Object value)
                      throws java.io.IOException,
                             AutomationException

Determines the default cutoff beyond which no demand point can be allocated to a facility

Specified by:

setDefaultCutoff in interface INALocationAllocationSolver

Parameters:

value - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getImpedanceTransformation

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

Determines which formula will modify the impedance.

Specified by:

getImpedanceTransformation in interface INALocationAllocationSolver

Returns:

A com.esri.arcgis.networkanalyst.esriNAImpedanceTransformationType constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setImpedanceTransformation

public void setImpedanceTransformation(int value)
                                throws java.io.IOException,
                                       AutomationException

Determines which formula will modify the impedance.

Specified by:

setImpedanceTransformation in interface INALocationAllocationSolver

Parameters:

value - A com.esri.arcgis.networkanalyst.esriNAImpedanceTransformationType constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTransformationParameter

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

Applies to the impedance transformation.

Specified by:

getTransformationParameter in interface INALocationAllocationSolver

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTransformationParameter

public void setTransformationParameter(double value)
                                throws java.io.IOException,
                                       AutomationException

Applies to the impedance transformation.

Specified by:

setTransformationParameter in interface INALocationAllocationSolver

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTargetMarketSharePercentage

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

Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.

Specified by:

getTargetMarketSharePercentage in interface INALocationAllocationSolver

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTargetMarketSharePercentage

public void setTargetMarketSharePercentage(double value)
                                    throws java.io.IOException,
                                           AutomationException

Applies to the target market share problem, the minimum number of facilites will be placed to obtain the target market share.

Specified by:

setTargetMarketSharePercentage in interface INALocationAllocationSolver

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOfDay

public java.util.Date getTimeOfDay()
                            throws java.io.IOException,
                                   AutomationException

The date-time value used in time-aware solvers.

Specified by:

getTimeOfDay in interface INATimeAwareSolverSettings

Returns:

The timeOfDay

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOfDay

public void setTimeOfDay(java.util.Date timeOfDay)
                  throws java.io.IOException,
                         AutomationException

The date-time value used in time-aware solvers.

Specified by:

setTimeOfDay in interface INATimeAwareSolverSettings

Parameters:

timeOfDay - The timeOfDay (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTimeOfDayUsage

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

The usage type for the TimeOfDay property.

Specified by:

getTimeOfDayUsage in interface INATimeAwareSolverSettings

Returns:

A com.esri.arcgis.networkanalyst.esriNATimeOfDayUsage constant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOfDayUsage

public void setTimeOfDayUsage(int timeOfDayUsage)
                       throws java.io.IOException,
                              AutomationException

The usage type for the TimeOfDay property.

Specified by:

setTimeOfDayUsage in interface INATimeAwareSolverSettings

Parameters:

timeOfDayUsage - A com.esri.arcgis.networkanalyst.esriNATimeOfDayUsage constant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isTimeOfDayIsUTC

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

Indicates whether the date-time value used in time-aware solvers is UTC or local time.

Specified by:

isTimeOfDayIsUTC in interface INATimeAwareSolverSettings2

Returns:

The timeOfDayIsUTC

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTimeOfDayIsUTC

public void setTimeOfDayIsUTC(boolean timeOfDayIsUTC)
                       throws java.io.IOException,
                              AutomationException

Indicates whether the date-time value used in time-aware solvers is UTC or local time.

Specified by:

setTimeOfDayIsUTC in interface INATimeAwareSolverSettings2

Parameters:

timeOfDayIsUTC - The timeOfDayIsUTC (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

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.

getMinNamespaceSupported

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

The minimum namespace the class can serialize to (eg the 90 namespace).

Specified by:

getMinNamespaceSupported in interface IXMLVersionSupport

Returns:

The namespaceURI

Throws:

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

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException