com.esri.arcgis.networkanalyst
Class NAODCostMatrixResult

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

All Implemented Interfaces:

com.esri.arcgis.interop.RemoteObjRef, INAODCostMatrix, INAODCostMatrixResult, INAResult, INAResult2, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class NAODCostMatrixResult
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, INAResult, INAResult2, INAODCostMatrix, INAODCostMatrixResult, IPersistStream, java.io.Externalizable

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

Description 'Contains an origin-destination cost matrix.' 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.INAResult2

IID, IID0718bd10_a86e_4014_865d_305d69af7ad9, xxDummy

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

IID9e92a2ad_551e_4be0_bf57_aac552789dae

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

IID, IID640f6408_3868_4990_8699_cde0042f5d17, xxDummy

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

IID, IID0cfd38da_a7fc_4163_a5e6_a0bd229297e7, 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

Constructor Summary

NAODCostMatrixResult()
Constructs a NAODCostMatrixResult using ArcGIS Engine.

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

Method Summary

void	create(java.lang.String name, INAContextHelper nAContextHelper, boolean isScratch) Set up for a new analysis.
void	emptyAll() Clear out all existing rows from any previous analysis.
boolean	equals(java.lang.Object o) Compare this object with another
int	findDestinationIndex(INALocation location, int curbApproach) Finds the destination corresponding to the given network location.
int	findOriginIndex(INALocation location, int curbApproach) Finds the origin corresponding to the given network location.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
IStringArray	getCostAttributeNames() The names of the network cost attributes.
double	getDefaultValue(int attributeIndex) The value returned for un-populated matrix enteries.
int	getDestinationCount() The number of destination locations.
int	getDestinationIndexByRank(int originIndex, int rank) For a given origin, retrieves the index of the populated destination for a given rank.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
INAContext	getNAContext() The context for the result.
java.lang.String	getName() The name of the result.
IName	getNetworkDatasetName() The name of the network dataset.
int	getOriginCount() The number of origin locations.
IPropertySet	getOutputProperties() The properties of the output.
int	getPopulatedDestinationCount(int originIndex) For a given origin, retrieves the number of destinations with populated matrix values.
int	getRankingAttributeIndex() The index of the cost attribute used to rank the populated destinations for each origin.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
double	getValue(int originIndex, int destinationIndex, int attributeIndex) Retrieves the cost value for a given origin and destination.
int	hashCode() the hashcode for this object
void	initialize(java.lang.String name, INAContext nAContext, boolean isScratch) Set up for a new analysis.
void	initializeEx(INAContextHelper nAContextHelper) Provides the result object with a reference to the context.
boolean	isAreOriginsIdenticalToDestinations() Indicates if the origin set is identical to the destination set, i.e.
void	isDirty() isDirty
boolean	isHasRankingAttribute() Indicates if the matrix has an attribute for ranking values.
boolean	isHasValidResult() Indicates if the current result is valid.
boolean	isPopulated(int originIndex, int destinationIndex) Indicates if the matrix entry for given origin, destination index is populated.
boolean	isSaveMatrixOnPersist() Indicates if the matrix entries are to be saved.
boolean	isSymmetric() Indicates if the matrix has symmetric values.
void	load(IStream pstm) load
void	queryPopulatedDestinationIndices(int originIndex, ILongArray[] destinationIndices) For a given origin, retrieves the indices of populated destinations.
void	queryRankedDestinationIndices(int originIndex, ILongArray[] destinationIndices) For a given origin, retrieves the indices of the populated destinations in increasing rank.
void	queryValues(int originIndex, int destinationIndex, IDoubleArray[] values) Retrieves the cost values of all cost attributes for the given origin and destination.
void	readExternal(java.io.ObjectInput in)
void	release() Release a NAODCostMatrixResult.
void	save(IStream pstm, int fClearDirty) save
void	setHasValidResult(boolean pFlag) Indicates if the current result is valid.
void	setSaveMatrixOnPersist(boolean value) Indicates if the matrix entries are to be saved.
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

NAODCostMatrixResult

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

Constructs a NAODCostMatrixResult using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

NAODCostMatrixResult

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

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

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

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

Specified by:

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

initialize

public void initialize(java.lang.String name,
                       INAContext nAContext,
                       boolean isScratch)
                throws java.io.IOException,
                       AutomationException

Set up for a new analysis.

Specified by:

initialize in interface INAResult

Parameters:

name - The name (in)

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

isScratch - The isScratch (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOutputProperties

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

The properties of the output.

Specified by:

getOutputProperties in interface INAResult

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.

isHasValidResult

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

Indicates if the current result is valid.

Specified by:

isHasValidResult in interface INAResult

Returns:

The pFlag

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setHasValidResult

public void setHasValidResult(boolean pFlag)
                       throws java.io.IOException,
                              AutomationException

Indicates if the current result is valid.

Specified by:

setHasValidResult in interface INAResult

Parameters:

pFlag - The pFlag (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

emptyAll

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

Clear out all existing rows from any previous analysis.

Specified by:

emptyAll in interface INAResult

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getName

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

The name of the result.

Specified by:

getName in interface INAResult

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNAContext

public INAContext getNAContext()
                        throws java.io.IOException,
                               AutomationException

The context for the result.

Specified by:

getNAContext in interface INAResult

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.

create

public void create(java.lang.String name,
                   INAContextHelper nAContextHelper,
                   boolean isScratch)
            throws java.io.IOException,
                   AutomationException

Set up for a new analysis.

Specified by:

create in interface INAResult2

Parameters:

name - The name (in)

nAContextHelper - A reference to a com.esri.arcgis.networkanalyst.INAContextHelper (in)

isScratch - The isScratch (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

initializeEx

public void initializeEx(INAContextHelper nAContextHelper)
                  throws java.io.IOException,
                         AutomationException

Provides the result object with a reference to the context.

Specified by:

initializeEx in interface INAResult2

Parameters:

nAContextHelper - A reference to a com.esri.arcgis.networkanalyst.INAContextHelper (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getNetworkDatasetName

public IName getNetworkDatasetName()
                            throws java.io.IOException,
                                   AutomationException

The name of the network dataset.

Specified by:

getNetworkDatasetName in interface INAODCostMatrix

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCostAttributeNames

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

The names of the network cost attributes.

Specified by:

getCostAttributeNames in interface INAODCostMatrix

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.

getOriginCount

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

The number of origin locations.

Specified by:

getOriginCount in interface INAODCostMatrix

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationCount

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

The number of destination locations.

Specified by:

getDestinationCount in interface INAODCostMatrix

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isAreOriginsIdenticalToDestinations

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

Indicates if the origin set is identical to the destination set, i.e. that every origin network location also exists as a destination network location.

Specified by:

isAreOriginsIdenticalToDestinations in interface INAODCostMatrix

Returns:

The areIdentical

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSymmetric

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

Indicates if the matrix has symmetric values.

Specified by:

isSymmetric in interface INAODCostMatrix

Returns:

The isSymmetric

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findOriginIndex

public int findOriginIndex(INALocation location,
                           int curbApproach)
                    throws java.io.IOException,
                           AutomationException

Finds the origin corresponding to the given network location.

Specified by:

findOriginIndex in interface INAODCostMatrix

Parameters:

location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)

curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findDestinationIndex

public int findDestinationIndex(INALocation location,
                                int curbApproach)
                         throws java.io.IOException,
                                AutomationException

Finds the destination corresponding to the given network location.

Specified by:

findDestinationIndex in interface INAODCostMatrix

Parameters:

location - A reference to a com.esri.arcgis.networkanalyst.INALocation (in)

curbApproach - A com.esri.arcgis.networkanalyst.esriNACurbApproachType constant (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public double getDefaultValue(int attributeIndex)
                       throws java.io.IOException,
                              AutomationException

The value returned for un-populated matrix enteries.

Specified by:

getDefaultValue in interface INAODCostMatrix

Parameters:

attributeIndex - The attributeIndex (in)

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPopulatedDestinationCount

public int getPopulatedDestinationCount(int originIndex)
                                 throws java.io.IOException,
                                        AutomationException

For a given origin, retrieves the number of destinations with populated matrix values.

Specified by:

getPopulatedDestinationCount in interface INAODCostMatrix

Parameters:

originIndex - The originIndex (in)

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryPopulatedDestinationIndices

public void queryPopulatedDestinationIndices(int originIndex,
                                             ILongArray[] destinationIndices)
                                      throws java.io.IOException,
                                             AutomationException

For a given origin, retrieves the indices of populated destinations.

Specified by:

queryPopulatedDestinationIndices in interface INAODCostMatrix

Parameters:

originIndex - The originIndex (in)

destinationIndices - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isPopulated

public boolean isPopulated(int originIndex,
                           int destinationIndex)
                    throws java.io.IOException,
                           AutomationException

Indicates if the matrix entry for given origin, destination index is populated.

Specified by:

isPopulated in interface INAODCostMatrix

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

Returns:

The isPopulated

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isHasRankingAttribute

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

Indicates if the matrix has an attribute for ranking values.

Specified by:

isHasRankingAttribute in interface INAODCostMatrix

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getRankingAttributeIndex

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

The index of the cost attribute used to rank the populated destinations for each origin.

Specified by:

getRankingAttributeIndex in interface INAODCostMatrix

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDestinationIndexByRank

public int getDestinationIndexByRank(int originIndex,
                                     int rank)
                              throws java.io.IOException,
                                     AutomationException

For a given origin, retrieves the index of the populated destination for a given rank. The index is returned only if the HasRankingAttribute is true.

Specified by:

getDestinationIndexByRank in interface INAODCostMatrix

Parameters:

originIndex - The originIndex (in)

rank - The rank (in)

Returns:

The destinationIndex

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryRankedDestinationIndices

public void queryRankedDestinationIndices(int originIndex,
                                          ILongArray[] destinationIndices)
                                   throws java.io.IOException,
                                          AutomationException

For a given origin, retrieves the indices of the populated destinations in increasing rank.

Specified by:

queryRankedDestinationIndices in interface INAODCostMatrix

Parameters:

originIndex - The originIndex (in)

destinationIndices - A reference to a com.esri.arcgis.system.ILongArray (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getValue

public double getValue(int originIndex,
                       int destinationIndex,
                       int attributeIndex)
                throws java.io.IOException,
                       AutomationException

Retrieves the cost value for a given origin and destination. The attribute index is with respect to the array of cost attribute names returned by CostAttributeNames.

Specified by:

getValue in interface INAODCostMatrix

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

attributeIndex - The attributeIndex (in)

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryValues

public void queryValues(int originIndex,
                        int destinationIndex,
                        IDoubleArray[] values)
                 throws java.io.IOException,
                        AutomationException

Retrieves the cost values of all cost attributes for the given origin and destination.

Specified by:

queryValues in interface INAODCostMatrix

Parameters:

originIndex - The originIndex (in)

destinationIndex - The destinationIndex (in)

values - A reference to a com.esri.arcgis.system.IDoubleArray (in/out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSaveMatrixOnPersist

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

Indicates if the matrix entries are to be saved.

Specified by:

isSaveMatrixOnPersist in interface INAODCostMatrixResult

Returns:

The value

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setSaveMatrixOnPersist

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

Indicates if the matrix entries are to be saved.

Specified by:

setSaveMatrixOnPersist in interface INAODCostMatrixResult

Parameters:

value - The value (in)

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.

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.

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