com.esri.arcgis.carto
Interface ISQLSyntaxInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

SQLSyntaxInfo

public interface ISQLSyntaxInfo
extends Serializable

Provides access to the SQL Syntax Info Interface.

Remarks

The members of the ISQLSyntaxInfo interface provide information regarding the SQL functionality for the DBMS underlying a map layer.

When To Use

Use ISQLSyntaxInfo to access information regarding the SQL functionality for the DBMS underlying a map layer.

Product Availability

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

Method Summary

IPropertySet	getFunctionNames() DBMS dependent SQL function names.
String	getInvalidCharacters() The list of invalid characters used in literals (if any).
String	getInvalidStartingCharacters() The list of invalid starting characters used in literals (if any).
IStringArray	getKeywords() The list of DBMS specific reserved keywords.
IPropertySet	getSpecialCharacters() Special DBMS dependent SQL characters.
IStringArray	getSupportedClauses() Supported SQL clauses.
IStringArray	getSupportedPredicates() Supported SQL predicates.
boolean	isDelimitedIdentifierCase() Indicates whether DBMS's quoted identifiers are case sensitive.
boolean	isIdentifierCase() Indicates whether DBMS's identifiers are case sensitive.
boolean	isStringComparisonCase() Indicates whether string comparisons are case sensitive.

Method Detail

getFunctionNames

IPropertySet getFunctionNames()
                              throws IOException,
                                     AutomationException

DBMS dependent SQL function names.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpecialCharacters

IPropertySet getSpecialCharacters()
                                  throws IOException,
                                         AutomationException

Special DBMS dependent SQL characters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedPredicates

IStringArray getSupportedPredicates()
                                    throws IOException,
                                           AutomationException

Supported SQL predicates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedClauses

IStringArray getSupportedClauses()
                                 throws IOException,
                                        AutomationException

Supported SQL clauses.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentifierCase

boolean isIdentifierCase()
                         throws IOException,
                                AutomationException

Indicates whether DBMS's identifiers are case sensitive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The caseSensitive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDelimitedIdentifierCase

boolean isDelimitedIdentifierCase()
                                  throws IOException,
                                         AutomationException

Indicates whether DBMS's quoted identifiers are case sensitive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The caseSensitive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStringComparisonCase

boolean isStringComparisonCase()
                               throws IOException,
                                      AutomationException

Indicates whether string comparisons are case sensitive.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The caseSensitive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeywords

IStringArray getKeywords()
                         throws IOException,
                                AutomationException

The list of DBMS specific reserved keywords.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.system.IStringArray

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidCharacters

String getInvalidCharacters()
                            throws IOException,
                                   AutomationException

The list of invalid characters used in literals (if any).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The characters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidStartingCharacters

String getInvalidStartingCharacters()
                                    throws IOException,
                                           AutomationException

The list of invalid starting characters used in literals (if any).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The characters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.