com.esri.arcgis.networkanalyst
Class NAODCostMatrixResult

java.lang.Object
  extended by com.esri.arcgis.networkanalyst.NAODCostMatrixResult
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, INAODCostMatrix, INAODCostMatrixResult, INAResult, INAResult2, IPersist, IPersistStream, Externalizable, Serializable

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

Contains an origin-destination cost matrix.

Description

This object is new at ArcGIS 9.3.

Remarks

The NAODCostMatrixResult object is created by both the NAVRPSolver and NAODCostMatrixSolver objects after a successful Solve operation. This object may be used to access origin-destination cost information associated with the NALocation instances currently populated within the associated VRP/OD NAContext.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:
Serialized Form

Constructor Summary
NAODCostMatrixResult()
          Constructs a NAODCostMatrixResult using ArcGIS Engine.
NAODCostMatrixResult(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAODCostMatrixResult theNAODCostMatrixResult = (NAODCostMatrixResult) obj;
 
Method Summary
 void create(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(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 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.
 INAContext getNAContext()
          The context for the result.
 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(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(ObjectInput in)
           
 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(ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef
getJintegraDispatch, release
 

Constructor Detail

NAODCostMatrixResult

public NAODCostMatrixResult()
                     throws IOException,
                            UnknownHostException
Constructs a NAODCostMatrixResult using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

NAODCostMatrixResult

public NAODCostMatrixResult(Object obj)
                     throws 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:
IOException - if there are interop problems
Method Detail

getClsid

public static String getClsid()
getClsid.


equals

public boolean equals(Object o)
Compare this object with another

Overrides:
equals in class Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class Object

initialize

public void initialize(String name,
                       INAContext nAContext,
                       boolean isScratch)
                throws IOException,
                       AutomationException
Set up for a new analysis.

Remarks

This method has been deprecated and should not be used. Instead, use INAResult2.Create to initialize a result object after creating it.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutputProperties

public IPropertySet getOutputProperties()
                                 throws IOException,
                                        AutomationException
The properties of the output.

Remarks

The OutputProperties property returns a PropertySet that may contain information about the results of the network analysis.

The contents of the property set is up to the individual solver. For the solvers that ESRI has released, HasGapsInEdgeCumulativeImpedances returns True if there are impedance values on the junction elements that were traversed. This is important because measures are not generated on the resulting polyline feature class (Route, CFLines, SALines) in this case.

Closest Facility:

HasGapsInEdgeCumulativeImpedances True/False

Route:

HasGapsInEdgeCumulativeImpedances True/False

Service Area:

HasGapsInEdgeCumulativeImpedances True/False
TravelDirection TRAVEL_FROM/TRAVEL_TO

Origin Destination Cost Matrix:

** No TraversalResult generated

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getOutputProperties in interface INAResult
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasValidResult

public boolean isHasValidResult()
                         throws IOException,
                                AutomationException
Indicates if the current result is valid.

Remarks

The HasValidResult property denotes if network analysis has been performed and the result object has been populated with valid information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isHasValidResult in interface INAResult
Returns:
The pFlag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHasValidResult

public void setHasValidResult(boolean pFlag)
                       throws IOException,
                              AutomationException
Indicates if the current result is valid.

Remarks

The HasValidResult property denotes if network analysis has been performed and the result object has been populated with valid information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setHasValidResult in interface INAResult
Parameters:
pFlag - The pFlag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

emptyAll

public void emptyAll()
              throws IOException,
                     AutomationException
Clear out all existing rows from any previous analysis.

Remarks

Clears the traversal result.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
emptyAll in interface INAResult
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getName

public String getName()
               throws IOException,
                      AutomationException
The name of the result.

Remarks

The Name property returns the name of the traversal result that was set during the call to Create.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getName in interface INAResult
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNAContext

public INAContext getNAContext()
                        throws IOException,
                               AutomationException
The context for the result.

Remarks

The NAContext returns the context that this traversal result was based upon.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getNAContext in interface INAResult
Returns:
A reference to a com.esri.arcgis.networkanalyst.INAContext
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

create

public void create(String name,
                   INAContextHelper nAContextHelper,
                   boolean isScratch)
            throws IOException,
                   AutomationException
Set up for a new analysis.

Remarks

The method Create is called by the solver when it creates a new result object.

The isScratch parameter specifies if the result feature classes should be kept in memory (false) or saved on disk (true).

The NAContextHelper object passed in is used to get back to the NAContext. You can maintain a strong reference to the NAContextHelper object within your custom result object, but do not hold onto a strong reference to the NAContext itself as this will create a circular reference.

This method should be called instead of INAResult.Initialize.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

initializeEx

public void initializeEx(INAContextHelper nAContextHelper)
                  throws IOException,
                         AutomationException
Provides the result object with a reference to the context.

Remarks

The InitializeEx method is called after the result object has been deserialized as part of the NAContext being loaded. It is called to pass to the result object a backpointer reference to the NAContext that it's bound to.

The NAContextHelper object passed in is used to get back to the NAContext. You can maintain a strong reference to the NAContextHelper object within your custom result object, but do not hold onto a strong reference to the NAContext itself as this will create a circular reference.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
initializeEx in interface INAResult2
Parameters:
nAContextHelper - A reference to a com.esri.arcgis.networkanalyst.INAContextHelper (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNetworkDatasetName

public IName getNetworkDatasetName()
                            throws IOException,
                                   AutomationException
The name of the network dataset.

Remarks

Returns the IName interface of the underlying network dataset associated with the matrix object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getNetworkDatasetName in interface INAODCostMatrix
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCostAttributeNames

public IStringArray getCostAttributeNames()
                                   throws IOException,
                                          AutomationException
The names of the network cost attributes.

Remarks

Returns the names of the cost attributes that are present in the matrix object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getCostAttributeNames in interface INAODCostMatrix
Returns:
A reference to a com.esri.arcgis.system.IStringArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOriginCount

public int getOriginCount()
                   throws IOException,
                          AutomationException
The number of origin locations.

Remarks

Returns the number of origin locations associated with the matrix object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getOriginCount in interface INAODCostMatrix
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestinationCount

public int getDestinationCount()
                        throws IOException,
                               AutomationException
The number of destination locations.

Remarks

Returns the number of destination locations associated with the matrix object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDestinationCount in interface INAODCostMatrix
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAreOriginsIdenticalToDestinations

public boolean isAreOriginsIdenticalToDestinations()
                                            throws 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.

Remarks

Returns True if the set of origin locations is identical to the set of destination locations in index sequence.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isAreOriginsIdenticalToDestinations in interface INAODCostMatrix
Returns:
The areIdentical
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSymmetric

public boolean isSymmetric()
                    throws IOException,
                           AutomationException
Indicates if the matrix has symmetric values.

Remarks

Returns True if the INAODCostMatrix.AreOriginsIdenticalToDestinations property returns True and the matrix values are symmetric (i.e., for each cost attribute and each origin-destination pair of locations, the matrix value for traveling from the first location to the second is the same as the value for traveling from the second location to the first).

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isSymmetric in interface INAODCostMatrix
Returns:
The isSymmetric
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findOriginIndex

public int findOriginIndex(INALocation location,
                           int curbApproach)
                    throws IOException,
                           AutomationException
Finds the origin corresponding to the given network location.

Remarks

Given a network location and curb approach, this method returns the internal index of a matching origin location. The internal index values range from 0 through INAODCostMatrix.OriginCount - 1. There may be more than one matching origin location, in which case an arbitrary index value is returned.

If a matching origin index cannot be determined, the integer value -1 is returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findDestinationIndex

public int findDestinationIndex(INALocation location,
                                int curbApproach)
                         throws IOException,
                                AutomationException
Finds the destination corresponding to the given network location.

Remarks

Given a network location and curb approach, this method returns the internal index of a matching destination location. The internal index values range from 0 through INAODCostMatrix.DestinationCount - 1. There may be more than one matching destination location, in which case an arbitrary index value is returned.

If a matching destination index cannot be determined, the integer value -1 is returned.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public double getDefaultValue(int attributeIndex)
                       throws IOException,
                              AutomationException
The value returned for un-populated matrix enteries.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDefaultValue in interface INAODCostMatrix
Parameters:
attributeIndex - The attributeIndex (in)
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPopulatedDestinationCount

public int getPopulatedDestinationCount(int originIndex)
                                 throws IOException,
                                        AutomationException
For a given origin, retrieves the number of destinations with populated matrix values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getPopulatedDestinationCount in interface INAODCostMatrix
Parameters:
originIndex - The originIndex (in)
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryPopulatedDestinationIndices

public void queryPopulatedDestinationIndices(int originIndex,
                                             ILongArray[] destinationIndices)
                                      throws IOException,
                                             AutomationException
For a given origin, retrieves the indices of populated destinations.

Remarks

For a given origin (passed in by index), QueryPopulatedDestinationIndices retrieves the indices of the populated destinations in an ILongArray. "Populated destinations" are the destinations for which a valid network path from the specified origin to the specified destination has been determined.

An origin's index can be retrieved via the FindOriginIndex method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isPopulated

public boolean isPopulated(int originIndex,
                           int destinationIndex)
                    throws IOException,
                           AutomationException
Indicates if the matrix entry for given origin, destination index is populated.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isPopulated in interface INAODCostMatrix
Parameters:
originIndex - The originIndex (in)
destinationIndex - The destinationIndex (in)
Returns:
The isPopulated
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isHasRankingAttribute

public boolean isHasRankingAttribute()
                              throws IOException,
                                     AutomationException
Indicates if the matrix has an attribute for ranking values.

Remarks

This returns True if the populated destinations for each origin are ranked by their values for some cost attributes. For example, the destinations may be ranked in increasing travel time away from the origin.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isHasRankingAttribute in interface INAODCostMatrix
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRankingAttributeIndex

public int getRankingAttributeIndex()
                             throws IOException,
                                    AutomationException
The index of the cost attribute used to rank the populated destinations for each origin.

Remarks

If the matrix has a ranking attribute then this returns the index of the cost attribute used to rank the populated destinations for each origin.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getRankingAttributeIndex in interface INAODCostMatrix
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDestinationIndexByRank

public int getDestinationIndexByRank(int originIndex,
                                     int rank)
                              throws 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.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getDestinationIndexByRank in interface INAODCostMatrix
Parameters:
originIndex - The originIndex (in)
rank - The rank (in)
Returns:
The destinationIndex
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

queryRankedDestinationIndices

public void queryRankedDestinationIndices(int originIndex,
                                          ILongArray[] destinationIndices)
                                   throws IOException,
                                          AutomationException
For a given origin, retrieves the indices of the populated destinations in increasing rank.

Remarks

For a given origin (passed in by index), QueryRankedDestinationIndices retrieves the indices of the populated destinations in increasing rank as an ILongArray. "Populated destinations" are the destinations for which a valid network path from the specified origin to the specified destination has been determined. The destinations are ranked increasingly from least to greatest total cost of the network path from the origin to the destination.

An origin's index can be retrieved via the FindOriginIndex method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
getValue in interface INAODCostMatrix
Parameters:
originIndex - The originIndex (in)
destinationIndex - The destinationIndex (in)
attributeIndex - The attributeIndex (in)
Returns:
The value
Throws:
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 IOException,
                        AutomationException
Retrieves the cost values of all cost attributes for the given origin and destination.

Remarks

QueryValues populates an IDoubleArray with the values of all associated cost attributes for a given origin and destination. Each value is the total accumulated cost of travel along the network dataset from the origin to the destination for a specific cost attribute.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSaveMatrixOnPersist

public boolean isSaveMatrixOnPersist()
                              throws IOException,
                                     AutomationException
Indicates if the matrix entries are to be saved.

Remarks

When SaveMatrixOnPersist is set to True, any persistance of the NAODCostMatrixResult object will include all of the matrix entries from the most recent solve. This is useful if, for example, you want to persist your OD Cost Matrix results to a Layer File, or to a map document.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
isSaveMatrixOnPersist in interface INAODCostMatrixResult
Returns:
The value
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSaveMatrixOnPersist

public void setSaveMatrixOnPersist(boolean value)
                            throws IOException,
                                   AutomationException
Indicates if the matrix entries are to be saved.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Specified by:
setSaveMatrixOnPersist in interface INAODCostMatrixResult
Parameters:
value - The value (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

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

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException