com.esri.arcgis.controls
Class MyPlaceCollection

java.lang.Object
  com.esri.arcgis.controls.MyPlaceCollection

All Implemented Interfaces:

IEnumPlace, IPlaceCollection, IConnectionPointContainer, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class MyPlaceCollection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IPlaceCollection, IPersistStream, IPersist, IConnectionPointContainer, IEnumPlace, java.io.Externalizable

COM Class 'MyPlaceCollection'. Generated 3/19/2015 1:20:47 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description 'A singleton class that manage the collection of my places.' 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.controls.IPlaceCollection

IID, IIDc1f4283d_618f_4f9c_bda9_2c9e5f6a0e69, xxDummy

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

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

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

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.display.IConnectionPointContainer

IID, IIDb196b284_bab4_101a_b69c_00aa00341d07, xxDummy

Fields inherited from interface com.esri.arcgis.controls.IEnumPlace

IID, IIDc2ee7c64_1d31_4e0e_8902_d4e4b8cbd223, xxDummy

Constructor Summary

MyPlaceCollection()
Constructs a MyPlaceCollection using ArcGIS Engine.

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

Method Summary

boolean	add(IPlace pPlace, boolean allowChangeName) Add to place collection.
void	enumConnectionPoints(IEnumConnectionPoints[] ppEnum) enumConnectionPoints
boolean	equals(java.lang.Object o) Compare this object with another
void	findConnectionPoint(GUID riid, IConnectionPoint[] ppCP) findConnectionPoint
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCount() The number of places in the enumeration.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
IPlace	next() Returns the next place in the enumeration.
void	readExternal(java.io.ObjectInput in)
void	release() Release a MyPlaceCollection.
void	removeAll() Remove all places.
int	removeByName(java.lang.String name, boolean removeMatching) Remove from place collection.
void	reset() Reset the enumeration to start from beginning.
void	save(IStream pstm, int fClearDirty) save
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

MyPlaceCollection

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

Constructs a MyPlaceCollection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

MyPlaceCollection

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

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

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

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

Specified by:

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

add

public boolean add(IPlace pPlace,
                   boolean allowChangeName)
            throws java.io.IOException,
                   AutomationException

Add to place collection. If allowChangeName is true and place with the same name exists, unique name will be assigned, the place will not be added otherwise.

Specified by:

add in interface IPlaceCollection

Parameters:

pPlace - A reference to a com.esri.arcgis.controls.IPlace (in)

allowChangeName - The allowChangeName (in)

Returns:

The pAdded

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeByName

public int removeByName(java.lang.String name,
                        boolean removeMatching)
                 throws java.io.IOException,
                        AutomationException

Remove from place collection. If RemoveMatching is true, all places will be removed whose name matches the unique name generation pattern. Otherwise place is removed if the name is an exact match.

Specified by:

removeByName in interface IPlaceCollection

Parameters:

name - The name (in)

removeMatching - The removeMatching (in)

Returns:

The pRemovedCount

Throws:

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

AutomationException - If the ArcObject component throws an exception.

removeAll

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

Remove all places.

Specified by:

removeAll in interface IPlaceCollection

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.

enumConnectionPoints

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

enumConnectionPoints

Specified by:

enumConnectionPoints in interface IConnectionPointContainer

Parameters:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findConnectionPoint

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

findConnectionPoint

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:

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

AutomationException - If the ArcObject component throws an exception.

next

public IPlace next()
            throws java.io.IOException,
                   AutomationException

Returns the next place in the enumeration.

Specified by:

next in interface IEnumPlace

Returns:

A reference to a com.esri.arcgis.controls.IPlace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

reset

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

Reset the enumeration to start from beginning.

Specified by:

reset in interface IEnumPlace

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCount

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

The number of places in the enumeration.

Specified by:

getCount in interface IEnumPlace

Returns:

The placeCount

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