com.esri.arcgis.geodatabase
Class RecordNumberSet

java.lang.Object
  extended by com.esri.arcgis.geodatabase.RecordNumberSet
All Implemented Interfaces:
IFIDSet, IFIDSet2, IFIDSetOperator, IRecordNumberSet, com.esri.arcgis.interop.RemoteObjRef, IClone, Serializable

public class RecordNumberSet
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IFIDSet, IFIDSet2, IFIDSetOperator, IClone, IRecordNumberSet

A collection of record numbers. Record number sets are used in selections with file based data.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
RecordNumberSet()
          Constructs a RecordNumberSet using ArcGIS Engine.
RecordNumberSet(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RecordNumberSet theRecordNumberSet = (RecordNumberSet) obj;
 
Method Summary
 void add(int fID)
          Adds a feature id to the set.
 void addRange(int minRecord, int maxRecord)
          Adds a range of record numbers to the collection starting with the minRecord and ending with the maxRecord.
 IRecordNumberSet and(IRecordNumberSet otherRecordNumberSet)
          Combines the record numbers that are common to both collections into a single collection.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void clearAll()
          Clear all record numbers.
 int count()
          The number of elements in the FID set.
 void delete(int fID)
          Deletes a feature id from the set.
 IFIDSet difference(IFIDSet otherFIDSet)
          Returns the feature IDs that are not in the collection, but are present in the input collection.
 IRecordNumberSet difference(IRecordNumberSet otherRecordNumberSet)
          Returns the record numbers 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.
static String getClsid()
          getClsid.
 IEnumIDs getIDs()
          Enumerates the object ids in the FID set.
 int getMaximumRecordNumber()
          The maximum record in the record number collection.
 int getMinimumRecordNumber()
          The minimum record in the record number collection.
 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.
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 IRecordNumberSet negate()
          Inverts the collection; selected records become unselected and unselected records become selected.
 void next(int[] fID)
          Gets the next feature id from the set.
 IRecordNumberSet or(IRecordNumberSet otherRecordNumberSet)
          Combines all the record numbers that are in one or the other collection into a single collection.
 void reset()
          Resets the internal cursor.
 void setAll()
          Set all record numbers.
 void setBounds(int startRecordNumber, int maxRecordNumber)
          Sets the starting and ending record numbers for the record number collection, then adds all record numbers between those values to the collection.
 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.
 IRecordNumberSet xOr(IRecordNumberSet otherRecordNumberSet)
          Combines the record numbers that are in one of the collections, but not both collections, into a single collection.
 
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

RecordNumberSet

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

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

RecordNumberSet

public RecordNumberSet(Object obj)
                throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
RecordNumberSet theRecordNumberSet = (RecordNumberSet) obj;

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

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
Specified by:
add in interface IRecordNumberSet
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
Specified by:
delete in interface IRecordNumberSet
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
Specified by:
getIDs in interface IRecordNumberSet
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.

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
Returns TRUE when 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
Returns TRUE when 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.

setBounds

public void setBounds(int startRecordNumber,
                      int maxRecordNumber)
               throws IOException,
                      AutomationException
Sets the starting and ending record numbers for the record number collection, then adds all record numbers between those values to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setBounds in interface IRecordNumberSet
Parameters:
startRecordNumber - The startRecordNumber (in)
maxRecordNumber - The maxRecordNumber (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumRecordNumber

public int getMinimumRecordNumber()
                           throws IOException,
                                  AutomationException
The minimum record in the record number collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaximumRecordNumber

public int getMaximumRecordNumber()
                           throws IOException,
                                  AutomationException
The maximum record in the record number collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

addRange

public void addRange(int minRecord,
                     int maxRecord)
              throws IOException,
                     AutomationException
Adds a range of record numbers to the collection starting with the minRecord and ending with the maxRecord.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addRange in interface IRecordNumberSet
Parameters:
minRecord - The minRecord (in)
maxRecord - The maxRecord (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAll

public void setAll()
            throws IOException,
                   AutomationException
Set all record numbers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

clearAll

public void clearAll()
              throws IOException,
                     AutomationException
Clear all record numbers.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

and

public IRecordNumberSet and(IRecordNumberSet otherRecordNumberSet)
                     throws IOException,
                            AutomationException
Combines the record numbers 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:
and in interface IRecordNumberSet
Parameters:
otherRecordNumberSet - A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

or

public IRecordNumberSet or(IRecordNumberSet otherRecordNumberSet)
                    throws IOException,
                           AutomationException
Combines all the record numbers 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:
or in interface IRecordNumberSet
Parameters:
otherRecordNumberSet - A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

xOr

public IRecordNumberSet xOr(IRecordNumberSet otherRecordNumberSet)
                     throws IOException,
                            AutomationException
Combines the record numbers 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:
xOr in interface IRecordNumberSet
Parameters:
otherRecordNumberSet - A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

difference

public IRecordNumberSet difference(IRecordNumberSet otherRecordNumberSet)
                            throws IOException,
                                   AutomationException
Returns the record numbers 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 IRecordNumberSet
Parameters:
otherRecordNumberSet - A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IRecordNumberSet
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

negate

public IRecordNumberSet negate()
                        throws IOException,
                               AutomationException
Inverts the collection; selected records become unselected and unselected records become selected.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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