com.esri.arcgis.geodatabase
Interface IRecordNumberSet

All Superinterfaces:

Serializable

All Known Implementing Classes:

RecordNumberSet

public interface IRecordNumberSet
extends Serializable

Provides access to members that control the collection of record numbers, and to compare record number collections. Record number sets are used in selections with file based data.

Product Availability

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

Method Summary

void	add(int recordNumber) Adds a record number to the collection.
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	clearAll() Clear all record numbers.
void	delete(int recordNumber) Removes a record number from the collection.
IRecordNumberSet	difference(IRecordNumberSet otherRecordNumberSet) Returns the record numbers that are not in the collection, but are present in the input collection.
IEnumIDs	getIDs() Enumerates the record numbers in the record number collection.
int	getMaximumRecordNumber() The maximum record in the record number collection.
int	getMinimumRecordNumber() The minimum record in the record number collection.
IRecordNumberSet	negate() Inverts the collection; selected records become unselected and unselected records become selected.
IRecordNumberSet	or(IRecordNumberSet otherRecordNumberSet) Combines all the record numbers that are in one or the other collection into a single collection.
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.
IRecordNumberSet	xOr(IRecordNumberSet otherRecordNumberSet) Combines the record numbers that are in one of the collections, but not both collections, into a single collection.

Method Detail

setBounds

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

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

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

Returns:

The startRecordNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaximumRecordNumber

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

Returns:

The maxRecordNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(int recordNumber)
         throws IOException,
                AutomationException

Adds a record number to the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

recordNumber - The recordNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete(int recordNumber)
            throws IOException,
                   AutomationException

Removes a record number from the collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

recordNumber - The recordNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addRange

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

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

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clearAll

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

and

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

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

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

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

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

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

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

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

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

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.

getIDs

IEnumIDs getIDs()
                throws IOException,
                       AutomationException

Enumerates the record numbers in the record number collection.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.