com.esri.arcgis.geodatabase
Class ISqlKeywordDictionaryProxy

java.lang.Object
  com.esri.arcgis.interop.Dispatch
      com.esri.arcgis.geodatabase.ISqlKeywordDictionaryProxy

All Implemented Interfaces:

ISqlKeywordDictionary, Externalizable, Serializable

public class ISqlKeywordDictionaryProxy
extends com.esri.arcgis.interop.Dispatch
implements ISqlKeywordDictionary, 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.

See Also:

Serialized Form

Field Summary

boolean

noncastable

Fields inherited from class com.esri.arcgis.interop.Dispatch

DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, objRef

Constructor Summary

	ISqlKeywordDictionaryProxy()
	ISqlKeywordDictionaryProxy(Object obj)
protected	ISqlKeywordDictionaryProxy(Object obj, String iid)

Method Summary

void	add(String reservedWord) Adds a new illegal field name.
void	addListener(String iidStr, Object theListener, Object theSource)
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	removeListener(String iidStr, Object theListener)
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.

Methods inherited from class com.esri.arcgis.interop.Dispatch

bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, optimizedVtblInvoke, queryInterface, readExternal, release, setNativeMode, setPropertyByName, toString, vtblInvoke, writeExternal

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

noncastable

public boolean noncastable

Constructor Detail

ISqlKeywordDictionaryProxy

public ISqlKeywordDictionaryProxy()

ISqlKeywordDictionaryProxy

public ISqlKeywordDictionaryProxy(Object obj)
                           throws IOException

Throws:

IOException

ISqlKeywordDictionaryProxy

protected ISqlKeywordDictionaryProxy(Object obj,
                                     String iid)
                              throws IOException

Throws:

IOException

Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException

Overrides:

addListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException

Overrides:

removeListener in class com.esri.arcgis.interop.Dispatch

Throws:

IOException

setName

public 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

Specified by:

setName in interface ISqlKeywordDictionary

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

public void getCount(int[] reservedWordCount)
              throws IOException,
                     AutomationException

Number of invalid field names.

Product Availability

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

Specified by:

getCount in interface ISqlKeywordDictionary

Parameters:

reservedWordCount - The reservedWordCount (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

public 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

Specified by:

add in interface ISqlKeywordDictionary

Parameters:

reservedWord - The reservedWord (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

public 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

Specified by:

remove in interface ISqlKeywordDictionary

Parameters:

reservedWord - The reservedWord (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public 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

Specified by:

reset in interface ISqlKeywordDictionary

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

empty

public 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

Specified by:

empty in interface ISqlKeywordDictionary

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

findKeyword

public 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

Specified by:

findKeyword in interface ISqlKeywordDictionary

Parameters:

keyword - The keyword (in)

Returns:

The pbFound

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.