com.esri.arcgis.networkanalyst
Class NAContext

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

All Implemented Interfaces:

IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, INAContext, INAContextEdit, IPersist, IPersistStream, Externalizable, Serializable

public class NAContext
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, INAContext, INAContextEdit, IPersistStream, IConnectionPointContainer, Externalizable

The analysis and problem definition container.

Remarks

The NAContext is the center of the constellation of objects that are used during network analysis.

The NAContext is initially created by calling CreateContext on the INASolver interface of a network solver object. It is then generally accessed by getting the Context property from the INALayer interface on the NALayer object. The INAContext interface can be used to obtain references to the NetworkDataset, NASolver, NAClasses, NATraversalResult, NALocator, and any extra objects that implement INAAgent. The INAContextEdit interface is used to set up some of the internal references to objects and to manage edit operations within the NAClasses. The INAContextEvents interface is an outgoing interface that notifies clients when the NAContext is modified.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

NAContext()
Constructs a NAContext using ArcGIS Engine.

NAContext(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
NAContext theNAContext = (NAContext) obj;

Method Summary

void	abortEditOperation() Cancels an edit operation in progress.
void	addINAContextEvents2Listener(INAContextEvents2 theListener) addINAContextEvents2Listener.
void	addINAContextEventsListener(INAContextEvents theListener) addINAContextEventsListener.
void	bind(INetworkDataset pNetworkDataset, IGPMessages pGPMessages) Prepare the context for analysis based upon the current network dataset schema.
void	clearInputNAObjects() Empty NAClasses that are defined as input or input/output.
void	clearOutputNAObjects() Empty NAClasses that are defined as output only.
void	contextChanged() Message all of the network analysis agents that the analysis context has changed.
INAClass	createAnalysisClass(INAClassDefinition classDef) Create a new analysis class based upon the given class definition.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
INamedSet	getAgents() The collection of agents associated with the analysis.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
INALocator	getLocator() The locator used for finding network locations for class items.
INamedSet	getNAClasses() The collection of classes associated with the analysis.
String	getName() The name of the analysis.
INetworkDataset	getNetworkDataset() The associated network dataset.
IName	getNetworkDatasetName() The associated network dataset name.
INAResult	getResult() The result for the analysis.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
INASolver	getSolver() The function used for the analysis.
ISpatialReference	getSpatialReference() The spatial reference of the analysis.
int	hashCode() the hashcode for this object
boolean	hasRedos() Indicates if any redo operations are available.
boolean	hasUndos() Indicates if any undo operations are available.
void	initialize(String name, IDENetworkDataset network) Prepare the context for analysis.
boolean	isBeingEdited() Indicates if the class is currently being edited.
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	redoEditOperation() Repeats the last edit operation.
void	removeINAContextEvents2Listener(INAContextEvents2 theListener) removeINAContextEvents2Listener.
void	removeINAContextEventsListener(INAContextEvents theListener) removeINAContextEventsListener.
void	resultChanged() Message all of the network analysis agents that the analysis results have changed.
void	save(IStream pstm, int fClearDirty) save
void	setLocatorByRef(INALocator rhs1) The locator used for finding network locations.
void	setResultByRef(INAResult rhs1) The result of the analysis.
void	setSolverByRef(INASolver rhs1) The function used for the analysis.
void	startEditing(boolean withUndoRedo) Starts an edit session.
void	startEditOperation() Starts an edit operation.
void	stopEditing(boolean saveEdits) Stops an edit session.
void	stopEditOperation() Stops an edit operation.
void	undoEditOperation() Cancels the last edit operation and returns to the state before it was started.
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

NAContext

public NAContext()
          throws IOException,
                 UnknownHostException

Constructs a NAContext using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

NAContext

public NAContext(Object obj)
          throws IOException

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

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

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

addINAContextEventsListener

public void addINAContextEventsListener(INAContextEvents theListener)
                                 throws IOException

addINAContextEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalyst.INAContextEvents interface.

Throws:

IOException - If there are communications problems.

removeINAContextEventsListener

public void removeINAContextEventsListener(INAContextEvents theListener)
                                    throws IOException

removeINAContextEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalyst.INAContextEvents interface.

Throws:

IOException - If there are communications problems.

addINAContextEvents2Listener

public void addINAContextEvents2Listener(INAContextEvents2 theListener)
                                  throws IOException

addINAContextEvents2Listener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalyst.INAContextEvents2 interface.

Throws:

IOException - If there are communications problems.

removeINAContextEvents2Listener

public void removeINAContextEvents2Listener(INAContextEvents2 theListener)
                                     throws IOException

removeINAContextEvents2Listener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.networkanalyst.INAContextEvents2 interface.

Throws:

IOException - If there are communications problems.

getName

public String getName()
               throws IOException,
                      AutomationException

The name of the analysis.

Remarks

Name returns the name of the NAContext that was specified when the NAContext was created via INASolver.CreateContext.

Product Availability

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

Specified by:

getName in interface INAContext

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialReference

public ISpatialReference getSpatialReference()
                                      throws IOException,
                                             AutomationException

The spatial reference of the analysis.

Remarks

SpatialReference returns the spatial reference of the associated NetworkDataset.

Product Availability

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

Specified by:

getSpatialReference in interface INAContext

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSolver

public INASolver getSolver()
                    throws IOException,
                           AutomationException

The function used for the analysis.

Remarks

Solver returns an object that implements INASolver. This is generally the solver that created the NAContext.

Product Availability

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

Specified by:

getSolver in interface INAContext

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAgents

public INamedSet getAgents()
                    throws IOException,
                           AutomationException

The collection of agents associated with the analysis.

Remarks

Agents returns any custom agents that are attached to the NAContext. Agents are objects that implement INAAgent and perform additional behavior when the NAContext is updated and when the NATraversalResult is updated.

Product Availability

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

Specified by:

getAgents in interface INAContext

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getResult

public INAResult getResult()
                    throws IOException,
                           AutomationException

The result for the analysis.

Remarks

Result returns the NATraversalResult, which is the results of the network analysis.

Product Availability

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

Specified by:

getResult in interface INAContext

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNAClasses

public INamedSet getNAClasses()
                       throws IOException,
                              AutomationException

The collection of classes associated with the analysis.

Remarks

NAClasses returns a NamedSet of the NAClasses (e.g. Stops, Barriers, Routes) that are contained within the NAContext.

Product Availability

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

Specified by:

getNAClasses in interface INAContext

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLocator

public INALocator getLocator()
                      throws IOException,
                             AutomationException

The locator used for finding network locations for class items.

Remarks

Locator returns the default NALocator for the NAClass.

The locator is used by the network analyst loading tools when it tries to locate NALocationObjects. You can set the Locator property on the INAContextEdit interface to change the default locator. You can also override the locator used if you call NAClassLoader programmatically.

Product Availability

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

Specified by:

getLocator in interface INAContext

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkDataset

public INetworkDataset getNetworkDataset()
                                  throws IOException,
                                         AutomationException

The associated network dataset.

Remarks

NetworkDataset returns the NetworkDataset that the NAContext is referencing.

The NetworkDataset is only available after the NAContext has been bound to a NetworkDataset using INAContextEdit::Bind.

Product Availability

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

Specified by:

getNetworkDataset in interface INAContext

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNetworkDatasetName

public IName getNetworkDatasetName()
                            throws IOException,
                                   AutomationException

The associated network dataset name.

Remarks

NetworkDatasetName returns a Name object to the NetworkDataset that the NAContext is referencing.

Product Availability

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

Specified by:

getNetworkDatasetName in interface INAContext

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.

setResultByRef

public void setResultByRef(INAResult rhs1)
                    throws IOException,
                           AutomationException

The result of the analysis.

Remarks

The Result property is set by the solver after performing a network analysis.

This property should only be set by a custom solver after performing network analysis.

Product Availability

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

Specified by:

setResultByRef in interface INAContextEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.networkanalyst.INAResult (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSolverByRef

public void setSolverByRef(INASolver rhs1)
                    throws IOException,
                           AutomationException

The function used for the analysis.

Remarks

The Solver property returns a reference back to the NASolver object that created the NAContext.

This property should only be set by a custom solver during the creation of the NAContext.

Product Availability

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

Specified by:

setSolverByRef in interface INAContextEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.networkanalyst.INASolver (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLocatorByRef

public void setLocatorByRef(INALocator rhs1)
                     throws IOException,
                            AutomationException

The locator used for finding network locations.

Remarks

Use the Locator property to change the default NALocator for the NAContext.

The Locator is used by the network analyst loading tools when it tries to locate NALocationObjects. You can set the Locator property on the INAContextEdit interface to change the default locator. You can also override the locator used if you call NAClassLoader programmatically.

Product Availability

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

Specified by:

setLocatorByRef in interface INAContextEdit

Parameters:

rhs1 - A reference to a com.esri.arcgis.networkanalyst.INALocator (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

initialize

public void initialize(String name,
                       IDENetworkDataset network)
                throws IOException,
                       AutomationException

Prepare the context for analysis.

Remarks

Initialize should be called immediately after the NAContext is first created to create and initialize its internal member variables, including the workspace for the NAClasses, the NamedSet of NAAgents, the NamedSet of NAClasses, and the default NALocator .

Note: This method should only be called by a custom solver during the creation of the NAContext.

Note: If Initialize is called on a NAContext that has already been initialized, an exception will be thrown.

Product Availability

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

Specified by:

initialize in interface INAContextEdit

Parameters:

name - The name (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

bind

public void bind(INetworkDataset pNetworkDataset,
                 IGPMessages pGPMessages)
          throws IOException,
                 AutomationException

Prepare the context for analysis based upon the current network dataset schema.

Remarks

Bind attaches the NAContext to the input NetworkDataset. This ensures the NAContext is properly initialized based on the network dataset specified.

You must call Bind after calling CreateContext on NASolver.

Product Availability

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

Specified by:

bind in interface INAContextEdit

Parameters:

pNetworkDataset - A reference to a com.esri.arcgis.geodatabase.INetworkDataset (in)

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearInputNAObjects

public void clearInputNAObjects()
                         throws IOException,
                                AutomationException

Empty NAClasses that are defined as input or input/output.

Remarks

ClearInputNAObjects is a helper method to quickly go through the NAClasses that are used for input and to remove all of the rows from them.

Product Availability

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

Specified by:

clearInputNAObjects in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearOutputNAObjects

public void clearOutputNAObjects()
                          throws IOException,
                                 AutomationException

Empty NAClasses that are defined as output only.

Remarks

ClearOutputNAObjects is a helper method to quickly go through the NAClasses that are used for output and to remove all of the rows from them.

Product Availability

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

Specified by:

clearOutputNAObjects in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

contextChanged

public void contextChanged()
                    throws IOException,
                           AutomationException

Message all of the network analysis agents that the analysis context has changed.

Remarks

ContextChanged should be called if you have changed a property of the NAContext or have added NALocationObjects and want to fire the event OnNAContextUpdated on the INAContextEvents interface.

Product Availability

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

Specified by:

contextChanged in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resultChanged

public void resultChanged()
                   throws IOException,
                          AutomationException

Message all of the network analysis agents that the analysis results have changed.

Remarks

ResultChanged should be called if a custom solver has performed a network analysis, has updated the NATraversalResult, and wants to fire the event OnNAResultUpdated on the INAContextEvents interface.

Product Availability

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

Specified by:

resultChanged in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createAnalysisClass

public INAClass createAnalysisClass(INAClassDefinition classDef)
                             throws IOException,
                                    AutomationException

Create a new analysis class based upon the given class definition.

Remarks

CreateAnalysisClass creates a new NAClass based on the INAClassDefinition that will be managed by the NAContext.

Product Availability

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

Specified by:

createAnalysisClass in interface INAContextEdit

Parameters:

classDef - A reference to a com.esri.arcgis.networkanalyst.INAClassDefinition (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startEditing

public void startEditing(boolean withUndoRedo)
                  throws IOException,
                         AutomationException

Starts an edit session.

Remarks

StartEditing starts an edit session on the NAContext's NAClasses. The withUndoRedo parameter can be used to suppress undo/redo logging if the workspace supports such suppression.

Product Availability

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

Specified by:

startEditing in interface INAContextEdit

Parameters:

withUndoRedo - The withUndoRedo (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopEditing

public void stopEditing(boolean saveEdits)
                 throws IOException,
                        AutomationException

Stops an edit session.

Remarks

StopEditing stops the edit session on the NAContext's NAClasses. The saveEdits parameter controls if edits are saved or discarded.

Product Availability

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

Specified by:

stopEditing in interface INAContextEdit

Parameters:

saveEdits - The saveEdits (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startEditOperation

public void startEditOperation()
                        throws IOException,
                               AutomationException

Starts an edit operation.

Remarks

StartEditOperation starts an edit operation on the NAContext's NAClasses. This can be used to enable undo and redo operations on changes to the NAClasses.

All related changes to objects in the database within an edit session should be grouped into edit operations. An edit operation is begun using the StartEditOperation method. An edit operation may be thought of as a short transaction nested within the long transaction corresponding to the edit session.

When using StartEditOperation, proper handling of errors, including the use of AbortEditOperation, is necessary.

Product Availability

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

Specified by:

startEditOperation in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopEditOperation

public void stopEditOperation()
                       throws IOException,
                              AutomationException

Stops an edit operation.

Remarks

StopEditOperation stops the edit operation on the NAContext's NAClasses.

Applications are responsible for calling StopEditOperation to mark the end of a successfully completed edit operation. Completed edit operations can be thought of as being pushed onto an undo stack.

When using StopEditOperation, proper handling of errors, including the use of AbortEditOperation, is neccessary.

Product Availability

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

Specified by:

stopEditOperation in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

abortEditOperation

public void abortEditOperation()
                        throws IOException,
                               AutomationException

Cancels an edit operation in progress.

Remarks

AbortEditOperation aborts the edit operation on the NAContext's NAClasses.

Applications are responsible for calling the AbortEditOperation method to abort an edit operation if errors are detected within the methods executed for an edit operation.

Product Availability

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

Specified by:

abortEditOperation in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

undoEditOperation

public void undoEditOperation()
                       throws IOException,
                              AutomationException

Cancels the last edit operation and returns to the state before it was started.

Remarks

UndoEditOperation undoes the edit operation on the NAContext's NAClasses.

Product Availability

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

Specified by:

undoEditOperation in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

redoEditOperation

public void redoEditOperation()
                       throws IOException,
                              AutomationException

Repeats the last edit operation.

Remarks

RedoEditOperation redoes the edit operation on the NAContext's NAClasses.

Product Availability

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

Specified by:

redoEditOperation in interface INAContextEdit

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasRedos

public boolean hasRedos()
                 throws IOException,
                        AutomationException

Indicates if any redo operations are available.

Remarks

HasRedos specifies if there are operations that can be re-executed on the NAContext's NAClasses.

Product Availability

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

Specified by:

hasRedos in interface INAContextEdit

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasUndos

public boolean hasUndos()
                 throws IOException,
                        AutomationException

Indicates if any undo operations are available.

Remarks

HasUndos specifies if there are operations that can be undone on the NAContext's NAClasses.

Product Availability

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

Specified by:

hasUndos in interface INAContextEdit

Returns:

The flag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBeingEdited

public boolean isBeingEdited()
                      throws IOException,
                             AutomationException

Indicates if the class is currently being edited.

Remarks

IsBeingEdited specifies if there is a current active edit session on the NAContext's NAClasses.

Product Availability

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

Specified by:

isBeingEdited in interface INAContextEdit

Returns:

The flag

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.

enumConnectionPoints

public void enumConnectionPoints(IEnumConnectionPoints[] ppEnum)
                          throws IOException,
                                 AutomationException

enumConnectionPoints

Description

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

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

ppEnum - A reference to a com.esri.arcgis.display.IEnumConnectionPoints (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

public void findConnectionPoint(GUID riid,
                                IConnectionPoint[] ppCP)
                         throws IOException,
                                AutomationException

findConnectionPoint

Description

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

findConnectionPoint in interface IConnectionPointContainer

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

ppCP - A reference to a com.esri.arcgis.display.IConnectionPoint (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