com.esri.arcgis.geodatabase
Class FIDSet

java.lang.Object
  com.esri.arcgis.geodatabase.FIDSet

All Implemented Interfaces:

IFIDSet, IFIDSet2, IFIDSetOperator, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class FIDSet
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFIDSet, IFIDSet2, IFIDSetOperator, IXMLSerialize, IPersist, IPersistStream, IClone, Externalizable

ESRI FID Set object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

FIDSet()
Constructs a FIDSet using ArcGIS Engine.

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

Method Summary

void	add(int fID) Adds a feature id to the set.
void	assign(IClone src) Assigns the properties of src to the receiver.
int	count() The number of elements in the FID set.
void	delete(int fID) Deletes a feature id from the set.
void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
IFIDSet	difference(IFIDSet otherFIDSet) Returns the feature IDs that are not in the collection, but are present in the input collection.
boolean	equals(Object o) Compare this object with another
IClone	esri_clone() Clones the receiver and assigns the result to *clone.
void	find(int fID, boolean[] doesExist) Finds a feature id in the set.
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
IEnumIDs	getIDs() Enumerates the object ids in the FID set.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
IFIDSet	intersect(IFIDSet otherFIDSet) Combines the feature IDs that are common to both collections into a single collection.
void	isDirty() isDirty
boolean	isEqual(IClone other) Indicates if the receiver and other have the same properties.
boolean	isIdentical(IClone other) Indicates if the receiver and other are the same object.
void	load(IStream pstm) load
void	next(int[] fID) Gets the next feature id from the set.
void	readExternal(ObjectInput in)
void	reset() Resets the internal cursor.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setEmpty() Empties the FID set.
IFIDSet	symmetricDifference(IFIDSet otherFIDSet) Combines the feature IDs that are in one of the collections, but not both collections, into a single collection.
IFIDSet	union(IFIDSet otherFIDSet) Combines all the feature IDs that are in one or the other collection into a single collection.
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

FIDSet

public FIDSet()
       throws IOException,
              UnknownHostException

Constructs a FIDSet using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

FIDSet

public FIDSet(Object obj)
       throws IOException

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

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

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

add

public void add(int fID)
         throws IOException,
                AutomationException

Adds a feature id to the set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

add in interface IFIDSet

Parameters:

fID - The fID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

public void delete(int fID)
            throws IOException,
                   AutomationException

Deletes a feature id from the set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

delete in interface IFIDSet

Parameters:

fID - The fID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

find

public void find(int fID,
                 boolean[] doesExist)
          throws IOException,
                 AutomationException

Finds a feature id in the set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

find in interface IFIDSet

Parameters:

fID - The fID (in)

doesExist - The doesExist (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

public void next(int[] fID)
          throws IOException,
                 AutomationException

Gets the next feature id from the set.

Remarks

Calling Next when there are no more IDs in the FIDset will return -1.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

next in interface IFIDSet

Parameters:

fID - The fID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws IOException,
                  AutomationException

Resets the internal cursor.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

reset in interface IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

count

public int count()
          throws IOException,
                 AutomationException

The number of elements in the FID set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

count in interface IFIDSet

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEmpty

public void setEmpty()
              throws IOException,
                     AutomationException

Empties the FID set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

setEmpty in interface IFIDSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIDs

public IEnumIDs getIDs()
                throws IOException,
                       AutomationException

Enumerates the object ids in the FID set.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getIDs in interface IFIDSet2

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

union

public IFIDSet union(IFIDSet otherFIDSet)
              throws IOException,
                     AutomationException

Combines all the feature IDs that are in one or the other collection into a single collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

union in interface IFIDSetOperator

Parameters:

otherFIDSet - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

intersect

public IFIDSet intersect(IFIDSet otherFIDSet)
                  throws IOException,
                         AutomationException

Combines the feature IDs that are common to both collections into a single collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

intersect in interface IFIDSetOperator

Parameters:

otherFIDSet - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

difference

public IFIDSet difference(IFIDSet otherFIDSet)
                   throws IOException,
                          AutomationException

Returns the feature IDs that are not in the collection, but are present in the input collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

difference in interface IFIDSetOperator

Parameters:

otherFIDSet - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

symmetricDifference

public IFIDSet symmetricDifference(IFIDSet otherFIDSet)
                            throws IOException,
                                   AutomationException

Combines the feature IDs that are in one of the collections, but not both collections, into a single collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

symmetricDifference in interface IFIDSetOperator

Parameters:

otherFIDSet - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

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.

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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:

esri_clone in interface IClone

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

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