com.esri.arcgis.geodatabase

Interface ISQLSyntax

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

ISQLSyntax2, ISQLSyntax3

All Known Implementing Classes:

ISQLSyntax2Proxy, ISQLSyntax3Proxy, ISQLSyntaxProxy, SqlWorkspace, Workspace

public interface ISQLSyntax
extends java.io.Serializable

COM Interface 'ISQLSyntax'. Generated 9/21/2023 10:01:46 AM from 'X:\ArcGIS\com\server\esriGeoDatabase.tlb'

Description: 'Provides access to members that supply information about SQL functionality.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	IID Deprecated. Internal use only
static int	IID18e2854e_edc8_11d2_aaef_00c04fa37849
static int	xxDummy Deprecated. Internal use only

Method Summary

Modifier and Type	Method and Description
boolean	getDelimitedIdentifierCase() True if DBMS's quoted identifiers are case sensitive.
java.lang.String	getFunctionName(int sqlFunc) DBMS dependent SQL function names.
boolean	getIdentifierCase() True if DBMS's identifiers are case sensitive.
java.lang.String	getInvalidCharacters() The list of invalid characters used in literals (if any).
java.lang.String	getInvalidStartingCharacters() The list of invalid characters used in literals (if any).
IEnumBSTR	getKeywords() The list of DBMS specific reserved keywords.
java.lang.String	getSpecialCharacter(int sqlSC) Special DBMS dependent SQL characters.
boolean	getStringComparisonCase() True if string comparisons are case sensitive.
int	getSupportedClauses() Supported SQL clauses.
int	getSupportedPredicates() Supported SQL predicates.
void	parseColumnName(java.lang.String fullName, java.lang.String[] dbName, java.lang.String[] ownerName, java.lang.String[] tableName, java.lang.String[] columnName) Given a column name, determine its qualification parts.
void	parseTableName(java.lang.String fullName, java.lang.String[] dbName, java.lang.String[] ownerName, java.lang.String[] tableName) Given a table name, determine its qualification parts.
java.lang.String	qualifyColumnName(java.lang.String tableName, java.lang.String columnName) Given a table name and column name, returns its fully qualified name.
java.lang.String	qualifyTableName(java.lang.String dbName, java.lang.String ownerName, java.lang.String tableName) Given a database, owner, and table name, return its fully qualified name.

Field Detail

IID18e2854e_edc8_11d2_aaef_00c04fa37849

static final int IID18e2854e_edc8_11d2_aaef_00c04fa37849

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

qualifyTableName

java.lang.String qualifyTableName(java.lang.String dbName,
                                  java.lang.String ownerName,
                                  java.lang.String tableName)
                           throws java.io.IOException,
                                  AutomationException

Given a database, owner, and table name, return its fully qualified name.

Parameters:

dbName - The dbName (in)

ownerName - The ownerName (in)

tableName - The tableName (in)

Returns:

The fullName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

qualifyColumnName

java.lang.String qualifyColumnName(java.lang.String tableName,
                                   java.lang.String columnName)
                            throws java.io.IOException,
                                   AutomationException

Given a table name and column name, returns its fully qualified name.

Parameters:

tableName - The tableName (in)

columnName - The columnName (in)

Returns:

The fullName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parseTableName

void parseTableName(java.lang.String fullName,
                    java.lang.String[] dbName,
                    java.lang.String[] ownerName,
                    java.lang.String[] tableName)
             throws java.io.IOException,
                    AutomationException

Given a table name, determine its qualification parts.

Parameters:

fullName - The fullName (in)

dbName - The dbName (out: use single element array)

ownerName - The ownerName (out: use single element array)

tableName - The tableName (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

parseColumnName

void parseColumnName(java.lang.String fullName,
                     java.lang.String[] dbName,
                     java.lang.String[] ownerName,
                     java.lang.String[] tableName,
                     java.lang.String[] columnName)
              throws java.io.IOException,
                     AutomationException

Given a column name, determine its qualification parts.

Parameters:

fullName - The fullName (in)

dbName - The dbName (out: use single element array)

ownerName - The ownerName (out: use single element array)

tableName - The tableName (out: use single element array)

columnName - The columnName (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFunctionName

java.lang.String getFunctionName(int sqlFunc)
                          throws java.io.IOException,
                                 AutomationException

DBMS dependent SQL function names.

Parameters:

sqlFunc - A com.esri.arcgis.geodatabase.esriSQLFunctionName constant (in)

Returns:

The sqlFunctionName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpecialCharacter

java.lang.String getSpecialCharacter(int sqlSC)
                              throws java.io.IOException,
                                     AutomationException

Special DBMS dependent SQL characters.

Parameters:

sqlSC - A com.esri.arcgis.geodatabase.esriSQLSpecialCharacters constant (in)

Returns:

The specialChar

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedPredicates

int getSupportedPredicates()
                    throws java.io.IOException,
                           AutomationException

Supported SQL predicates.

Returns:

The predicates

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSupportedClauses

int getSupportedClauses()
                 throws java.io.IOException,
                        AutomationException

Supported SQL clauses.

Returns:

The clauses

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifierCase

boolean getIdentifierCase()
                   throws java.io.IOException,
                          AutomationException

True if DBMS's identifiers are case sensitive.

Returns:

The isCaseSensitive

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDelimitedIdentifierCase

boolean getDelimitedIdentifierCase()
                            throws java.io.IOException,
                                   AutomationException

True if DBMS's quoted identifiers are case sensitive.

Returns:

The isCaseSensitive

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStringComparisonCase

boolean getStringComparisonCase()
                         throws java.io.IOException,
                                AutomationException

True if string comparisons are case sensitive.

Returns:

The isCaseSensitive

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeywords

IEnumBSTR getKeywords()
               throws java.io.IOException,
                      AutomationException

The list of DBMS specific reserved keywords.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidCharacters

java.lang.String getInvalidCharacters()
                               throws java.io.IOException,
                                      AutomationException

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

Returns:

The invalidChars

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidStartingCharacters

java.lang.String getInvalidStartingCharacters()
                                       throws java.io.IOException,
                                              AutomationException

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

Returns:

The invalidChars

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.