com.esri.arcgis.geodatabase
Interface ISqlKeywordDictionary

All Superinterfaces:
Serializable
All Known Implementing Classes:
ISqlKeywordDictionaryProxy

public interface ISqlKeywordDictionary
extends Serializable

Provides access to the members that control the dictionary for SQL Keywords.

Description

ISqlKeywordDictionary references can be accessed through the IFieldChecker.ValidateDictionary property. This interface can be used to determine whether a word is a keyword in SQL.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void add(String reservedWord)
          Adds a new illegal field name.
 void empty()
          Clears all the invalid field names.
 boolean findKeyword(String keyword)
          Indicates if the word is illegal (Legal = false, Illegal = true).
 void getCount(int[] reservedWordCount)
          Number of invalid field names.
 void remove(String reservedWord)
          Removes a illegal field name form the list.
 void reset()
          Resets the invalid field names to the state before you called Clear, Add, or Remove.
 void setName(String rhs1)
          Provides access to members that maintain a list of SQL Keywords.
 

Method Detail

setName

void setName(String rhs1)
             throws IOException,
                    AutomationException
Provides access to members that maintain a list of SQL Keywords.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
rhs1 - The rhs1 (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

void getCount(int[] reservedWordCount)
              throws IOException,
                     AutomationException
Number of invalid field names.

Product Availability

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

Parameters:
reservedWordCount - The reservedWordCount (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

add

void add(String reservedWord)
         throws IOException,
                AutomationException
Adds a new illegal field name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
reservedWord - The reservedWord (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

remove

void remove(String reservedWord)
            throws IOException,
                   AutomationException
Removes a illegal field name form the list.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
reservedWord - The reservedWord (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException
Resets the invalid field names to the state before you called Clear, Add, or Remove.

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.

empty

void empty()
           throws IOException,
                  AutomationException
Clears all the invalid field names.

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.

findKeyword

boolean findKeyword(String keyword)
                    throws IOException,
                           AutomationException
Indicates if the word is illegal (Legal = false, Illegal = true).

Remarks

Returns true if the string provided is a keyword; false otherwise. If false is returned, it does not necessarily mean the word is a valid field or table name, only that it is not reserved.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
keyword - The keyword (in)
Returns:
The pbFound
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.