com.esri.arcgis.carto
Class ElementCollection

java.lang.Object
  com.esri.arcgis.carto.ElementCollection

All Implemented Interfaces:

IElementCollection, IElementCollection2, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class ElementCollection
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IElementCollection, IElementCollection2, IPersist, IPersistStream, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'ElementCollection'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'Collection of elements.' 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.carto.IElementCollection

IID, IIDce8f3971_e9be_11d1_a232_080009b6f22b, xxDummy

Fields inherited from interface com.esri.arcgis.carto.IElementCollection2

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

ElementCollection()
Constructs a ElementCollection using ArcGIS Engine.

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

Method Summary

void	add(IElement element, int linkedFeatureID) Adds an element to the collection.
void	add(IElement element, int linkedFeatureID, int annotationClassID, int status) Adds an element to the collection.
void	clear() Removes all the elements in the collection.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
int	getCount() Number of elements in the collection.
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
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	queryItem(int index, IElement[] element, int[] linkedFeatureID) Element at the given index.
void	queryItem(int index, IElement[] element, int[] linkedFeatureID, int[] annotationClassID, int[] status) Element at the given index.
void	readExternal(java.io.ObjectInput in)
void	release() Release a ElementCollection.
void	remove(IElement element) Remove an element from the collection.
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

ElementCollection

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

Constructs a ElementCollection using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ElementCollection

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

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

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

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

Specified by:

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

add

public void add(IElement element,
                int linkedFeatureID)
         throws java.io.IOException,
                AutomationException

Adds an element to the collection.

Specified by:

add in interface IElementCollection

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

linkedFeatureID - The linkedFeatureID (in, optional, pass -1 if not required)

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

Number of elements in the collection.

Specified by:

getCount in interface IElementCollection

Specified by:

getCount in interface IElementCollection2

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryItem

public void queryItem(int index,
                      IElement[] element,
                      int[] linkedFeatureID)
               throws java.io.IOException,
                      AutomationException

Element at the given index.

Specified by:

queryItem in interface IElementCollection

Parameters:

index - The index (in)

element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

linkedFeatureID - The linkedFeatureID (out: use single element array, optional, pass single element of null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clear

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

Removes all the elements in the collection.

Specified by:

clear in interface IElementCollection

Specified by:

clear in interface IElementCollection2

Throws:

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

AutomationException - If the ArcObject component throws an exception.

remove

public void remove(IElement element)
            throws java.io.IOException,
                   AutomationException

Remove an element from the collection.

Specified by:

remove in interface IElementCollection

Specified by:

remove in interface IElementCollection2

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

add

public void add(IElement element,
                int linkedFeatureID,
                int annotationClassID,
                int status)
         throws java.io.IOException,
                AutomationException

Adds an element to the collection.

Specified by:

add in interface IElementCollection2

Parameters:

element - A reference to a com.esri.arcgis.carto.IElement (in)

linkedFeatureID - The linkedFeatureID (in, optional, pass 0 if not required)

annotationClassID - The annotationClassID (in, optional, pass -1 if not required)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (in, optional, pass 0 if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

queryItem

public void queryItem(int index,
                      IElement[] element,
                      int[] linkedFeatureID,
                      int[] annotationClassID,
                      int[] status)
               throws java.io.IOException,
                      AutomationException

Element at the given index.

Specified by:

queryItem in interface IElementCollection2

Parameters:

index - The index (in)

element - A reference to a com.esri.arcgis.carto.IElement (out: use single element array)

linkedFeatureID - The linkedFeatureID (out: use single element array, optional, pass single element of null if not required)

annotationClassID - The annotationClassID (out: use single element array, optional, pass single element of null if not required)

status - A com.esri.arcgis.carto.esriAnnotationStatus constant (out: use single element array, optional, pass single element of null if not required)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isDirty

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

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

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

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

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