com.esri.arcgis.carto
Class SQLSyntaxInfo

java.lang.Object
  com.esri.arcgis.carto.SQLSyntaxInfo

All Implemented Interfaces:

ISQLSyntaxInfo, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class SQLSyntaxInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, ISQLSyntaxInfo, IXMLSerialize, IPersistStream, IPersist, Externalizable

The SQL Syntax Info coclass supplies information about SQL functionality.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:

Serialized Form

Constructor Summary

SQLSyntaxInfo()
Constructs a SQLSyntaxInfo using ArcGIS Engine.

SQLSyntaxInfo(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SQLSyntaxInfo theSQLSyntaxInfo = (SQLSyntaxInfo) obj;

Method Summary

void	deserialize(IXMLSerializeData data) Deserializes an object from XML.
boolean	equals(Object o) Compare this object with another
void	getClassID(GUID[] pClassID) getClassID
static String	getClsid() getClsid.
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.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
IPropertySet	getSpecialCharacters() Special DBMS dependent SQL characters.
IStringArray	getSupportedClauses() Supported SQL clauses.
IStringArray	getSupportedPredicates() Supported SQL predicates.
int	hashCode() the hashcode for this object
boolean	isDelimitedIdentifierCase() Indicates whether DBMS's quoted identifiers are case sensitive.
void	isDirty() isDirty
boolean	isIdentifierCase() Indicates whether DBMS's identifiers are case sensitive.
boolean	isStringComparisonCase() Indicates whether string comparisons are case sensitive.
void	load(IStream pstm) load
void	readExternal(ObjectInput in)
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

SQLSyntaxInfo

public SQLSyntaxInfo()
              throws IOException,
                     UnknownHostException

Constructs a SQLSyntaxInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

SQLSyntaxInfo

public SQLSyntaxInfo(Object obj)
              throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
SQLSyntaxInfo theSQLSyntaxInfo = (SQLSyntaxInfo) obj;

Construct a SQLSyntaxInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to SQLSyntaxInfo.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getFunctionNames

public 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

Specified by:

getFunctionNames in interface ISQLSyntaxInfo

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

public 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

Specified by:

getSpecialCharacters in interface ISQLSyntaxInfo

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

public IStringArray getSupportedPredicates()
                                    throws IOException,
                                           AutomationException

Supported SQL predicates.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedPredicates in interface ISQLSyntaxInfo

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

public IStringArray getSupportedClauses()
                                 throws IOException,
                                        AutomationException

Supported SQL clauses.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSupportedClauses in interface ISQLSyntaxInfo

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

public 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

Specified by:

isIdentifierCase in interface ISQLSyntaxInfo

Returns:

The caseSensitive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDelimitedIdentifierCase

public 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

Specified by:

isDelimitedIdentifierCase in interface ISQLSyntaxInfo

Returns:

The caseSensitive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isStringComparisonCase

public 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

Specified by:

isStringComparisonCase in interface ISQLSyntaxInfo

Returns:

The caseSensitive

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getKeywords

public 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

Specified by:

getKeywords in interface ISQLSyntaxInfo

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

public 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

Specified by:

getInvalidCharacters in interface ISQLSyntaxInfo

Returns:

The characters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getInvalidStartingCharacters

public 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

Specified by:

getInvalidStartingCharacters in interface ISQLSyntaxInfo

Returns:

The characters

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException

Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException

Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException

isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isDirty in interface IPersistStream

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException

load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException

save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException

getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException

getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException