com.esri.arcgis.geodatabase
Interface IIndex

All Superinterfaces:
Serializable
All Known Subinterfaces:
IIndexEdit
All Known Implementing Classes:
Index, XMLIndex

public interface IIndex
extends Serializable

Provides access to members that return information about the index.

Remarks

The IIndex interface is used for read-only access to the properties of an index.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IField

Method Summary
 IFields getFields()
          The fields collection for this index.
 String getName()
          The name of the index.
 boolean isAscending()
          Indicates if the index is based on ascending order.
 boolean isUnique()
          Indicates if the index is unique.
 

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException
The name of the index.

Remarks

ArcGIS imposes a limit on the length of 16 characters on the length of attribute index names. This limit is based on the smallest allowable length within supported databases in order to facilitate distribution and sharing of data between different geodatabases.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isUnique

boolean isUnique()
                 throws IOException,
                        AutomationException
Indicates if the index is unique.

Remarks

If IsUnique is true, the field the Index was created for must not have duplicate values.



Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The isUnique
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isAscending

boolean isAscending()
                    throws IOException,
                           AutomationException
Indicates if the index is based on ascending order.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The isAscending
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFields

IFields getFields()
                  throws IOException,
                         AutomationException
The fields collection for this index.

Remarks

An Index cannot have more than 10 fields in an index.


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.IFields
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.