com.esri.arcgis.networkanalyst
Class NALocationAllocationSolver

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INALocationAllocationSolver, INALocationAllocationSolver2, INASolver, INASolverForwardStar, INASolverOutputGeneralization, INASolverSettings, INASolverSettings2, INASolverSettings3, INATimeAwareSolverSettings, INATimeAwareSolverSettings2, IClone, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class NALocationAllocationSolver
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INASolver, INASolverSettings, INASolverSettings2, INASolverSettings3, INALocationAllocationSolver, INALocationAllocationSolver2, INASolverOutputGeneralization, INATimeAwareSolverSettings, INATimeAwareSolverSettings2, IPersist, IPersistStream, IClone, IXMLSerialize, ISupportErrorInfo, INASolverForwardStar, java.io.Externalizable

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

Description 'Solves various location-allocation problem types' 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.INASolver

IID, IIDbfd9e9d5_cd3c_4f1c_b39d_40a4134e4b36, xxDummy

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

IID, IID1e4089cc_b6c8_4c0c_8855_9a609c26ed3e, xxDummy

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

IIDd3696546_2831_4aa5_a879_acd66e50a938

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

IID5a8dc105_0e57_45c8_a01d_0188ce7f7b52

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

IID, IID954e8e9a_60a3_4f20_b052_9e39e7a77347, xxDummy

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

IID51b22eed_7a65_4037_b2b9_8bcfe354e4c5

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

IID, IIDac7c7879_423e_4571_bc2f_bf5475e287b5, 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.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.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

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

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

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

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

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

IID, IIDfba968bd_33cb_428f_a61c_ddb10003be16, xxDummy

Constructor Summary

NALocationAllocationSolver()
Constructs a NALocationAllocationSolver using ArcGIS Engine.

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

Method Summary

void	applyTravelMode(INAContext context, INetworkTravelMode travelMode) Applies the solver settings that are in the given travel mode instance.
void	assign(IClone src) Assigns the properties of src to the receiver.
void	bind(INAContext context, IDENetworkDataset network, IGPMessages messages) Re-associate the solver with the given network dataset and its schema.
INAContext	createContext(IDENetworkDataset network, java.lang.String name) Creates the analysis context for the solver.
INetworkForwardStarEx	createForwardStar(INAContext context, boolean isForwardTraversal) Creates a network dataset forward star which honors the current solver settings as well as any barriers.
INALayer	createLayer(INAContext context) Makes a new network analysis layer for the solver context.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(java.lang.Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
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.
INamedSet	getClassDefinitions() The inputs and outputs defined by the solver.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
double	getDefaultCapacity() Applies to the maximize capacitated coverage problem, the default capacity for each facility.
java.lang.Object	getDefaultCutoff() Determines the default cutoff beyond which no demand point can be allocated to a facility
java.lang.String	getDisplayName() The display name of the solver.
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.
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.
int	getMaxValueForHierarchy(int level) The maximum value of the hierarchy attribute.
java.lang.String	getName() The name of the solver.
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.
java.lang.Object	getOutputGeometryPrecision() Specifies the precision of the output geometry after generalization.
int	getOutputGeometryPrecisionUnits() Specifies the units of the output geometry precision.
int	getOutputLines() Specifies what if any shape geometry will be output
int	getProblemType() Specifies which location-allocation problem type to solve.
IPropertySet	getProperties() The properties for the solver.
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	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
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isCanAccumulateAttributes() Indicates if the solver supports using accumulate network attributes.
boolean	isCanUseHierarchy() Indicates if the solver supports using a hierarchy network attribute.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
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	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 NALocationAllocationSolver.
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	setDefaultCapacity(double value) Applies to the maximize capacitated coverage problem, the default capacity for each facility.
void	setDefaultCutoff(java.lang.Object value) Determines the default cutoff beyond which no demand point can be allocated to a facility
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	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	setMaxValueForHierarchy(int level, int value) The maximum value of the hierarchy attribute.
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	setOutputGeometryPrecision(java.lang.Object pValue) Specifies the precision of the output geometry after generalization.
void	setOutputGeometryPrecisionUnits(int pValue) Specifies the units of the output geometry precision.
void	setOutputLines(int value) Specifies what if any shape geometry will be output
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	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	setUseHierarchy(boolean useHierarchy) Indicates if the hierarchy attribute for the network should be used in analysis.
boolean	solve(INAContext nAContext, IGPMessages messages, ITrackCancel trackCancel) Perform the network analysis and construct results.
void	updateContext(INAContext nAContext, IDENetworkDataset network, IGPMessages messages) Update the analysis context for the solver.
boolean	updateLayer(INALayer layer) Updates the layer and indicates if the layer was updated.
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

NALocationAllocationSolver

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

Constructs a NALocationAllocationSolver using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NALocationAllocationSolver

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

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

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

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

Specified by:

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

getName

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

The name of the solver.

Specified by:

getName in interface INASolver

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDisplayName

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

The display name of the solver.

Specified by:

getDisplayName in interface INASolver

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassDefinitions

public INamedSet getClassDefinitions()
                              throws java.io.IOException,
                                     AutomationException

The inputs and outputs defined by the solver.

Specified by:

getClassDefinitions in interface INASolver

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanUseHierarchy

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

Indicates if the solver supports using a hierarchy network attribute.

Specified by:

isCanUseHierarchy in interface INASolver

Returns:

The canUseHierarchy

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isCanAccumulateAttributes

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

Indicates if the solver supports using accumulate network attributes.

Specified by:

isCanAccumulateAttributes in interface INASolver

Returns:

The canAccumulateAttrs

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getProperties

public IPropertySet getProperties()
                           throws java.io.IOException,
                                  AutomationException

The properties for the solver.

Specified by:

getProperties in interface INASolver

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createLayer

public INALayer createLayer(INAContext context)
                     throws java.io.IOException,
                            AutomationException

Makes a new network analysis layer for the solver context.

Specified by:

createLayer in interface INASolver

Parameters:

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

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateLayer

public boolean updateLayer(INALayer layer)
                    throws java.io.IOException,
                           AutomationException

Updates the layer and indicates if the layer was updated.

Specified by:

updateLayer in interface INASolver

Parameters:

layer - A reference to a com.esri.arcgis.networkanalyst.INALayer (in)

Returns:

The layerUpdated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

solve

public boolean solve(INAContext nAContext,
                     IGPMessages messages,
                     ITrackCancel trackCancel)
              throws java.io.IOException,
                     AutomationException

Perform the network analysis and construct results.

Specified by:

solve in interface INASolver

Parameters:

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

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

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

Returns:

The isPartialSolution

Throws:

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

AutomationException - If the ArcObject component throws an exception.

createContext

public INAContext createContext(IDENetworkDataset network,
                                java.lang.String name)
                         throws java.io.IOException,
                                AutomationException

Creates the analysis context for the solver.

Specified by:

createContext in interface INASolver

Parameters:

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

name - The name (in)

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

updateContext

public void updateContext(INAContext nAContext,
                          IDENetworkDataset network,
                          IGPMessages messages)
                   throws java.io.IOException,
                          AutomationException

Update the analysis context for the solver.

Specified by:

updateContext in interface INASolver

Parameters:

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

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

bind

public void bind(INAContext context,
                 IDENetworkDataset network,
                 IGPMessages messages)
          throws java.io.IOException,
                 AutomationException

Re-associate the solver with the given network dataset and its schema.

Specified by:

bind in interface INASolver

Parameters:

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

network - A reference to a com.esri.arcgis.geodatabase.IDENetworkDataset (in)

messages - A reference to a com.esri.arcgis.geodatabase.IGPMessages (in)

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.

applyTravelMode

public void applyTravelMode(INAContext context,
                            INetworkTravelMode travelMode)
                     throws java.io.IOException,
                            AutomationException

Applies the solver settings that are in the given travel mode instance.

Specified by:

applyTravelMode in interface INASolverSettings3

Parameters:

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

travelMode - A reference to a com.esri.arcgis.geodatabase.INetworkTravelMode (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.

getDefaultCapacity

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

Applies to the maximize capacitated coverage problem, the default capacity for each facility.

Specified by:

getDefaultCapacity in interface INALocationAllocationSolver2

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultCapacity

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

Applies to the maximize capacitated coverage problem, the default capacity for each facility.

Specified by:

setDefaultCapacity in interface INALocationAllocationSolver2

Parameters:

value - The value (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputGeometryPrecision

public void setOutputGeometryPrecision(java.lang.Object pValue)
                                throws java.io.IOException,
                                       AutomationException

Specifies the precision of the output geometry after generalization.

Specified by:

setOutputGeometryPrecision in interface INASolverOutputGeneralization

Parameters:

pValue - A Variant (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputGeometryPrecision

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

Specifies the precision of the output geometry after generalization.

Specified by:

getOutputGeometryPrecision in interface INASolverOutputGeneralization

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setOutputGeometryPrecisionUnits

public void setOutputGeometryPrecisionUnits(int pValue)
                                     throws java.io.IOException,
                                            AutomationException

Specifies the units of the output geometry precision.

Specified by:

setOutputGeometryPrecisionUnits in interface INASolverOutputGeneralization

Parameters:

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

getOutputGeometryPrecisionUnits

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

Specifies the units of the output geometry precision.

Specified by:

getOutputGeometryPrecisionUnits in interface INASolverOutputGeneralization

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.

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.

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.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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.

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.

createForwardStar

public INetworkForwardStarEx createForwardStar(INAContext context,
                                               boolean isForwardTraversal)
                                        throws java.io.IOException,
                                               AutomationException

Creates a network dataset forward star which honors the current solver settings as well as any barriers.

Specified by:

createForwardStar in interface INASolverForwardStar

Parameters:

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

isForwardTraversal - The isForwardTraversal (in)

Returns:

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

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