PATH  WebObjects 4.0 Documentation > ODBCEOAdaptor Reference



ODBCAdaptor

Inherits From:
EOAdaptor : NSObject

Inherits From:
com.apple.yellow.odbceoadaptor


Class Description

An ODBCAdaptor represents a single connection to an ODBC database server, and is responsible for keeping login and model information, performing ODBC-specific formatting of SQL expressions, and reporting errors.

ODBC (Open Data Base Connectivity) defines a standard interface that Windows applications can use to access any data source. Unlike the other Enterprise Objects Frameworks adaptors that support a single type of database, the ODBC adaptor supports any data source that has an ODBC driver. Consequently, in addition to having standard adaptor features, the ODBC adaptor also manages information relating to the driver and to the data types defined by the data source the driver supports.

The ODBCAdaptor class doesn't support nested transactions.


Method Types

Mapping external types to internal types
externalTypeForOdbcType
getOdbcInfoWithConnectionDictionary
odbcTypeForExternalType
odbcTypeForStringRepresentation
resetOdbcInfoWithConnectionDictionary
stringRepresentationForOdbcType
Access information in the connection dictionary
driverInfoForModel
typeInfoForModel
driverInfo
typeInfo
Testing the connection dictionary
odbcConnectionString



driverInfoForModel

public static com.apple.yellow.foundation.NSDictionary driverInfoForModel(com.apple.yellow.eoaccess.EOModel model)

Returns an NSDictionary containing the driver information cached in the connection dictionary of model. If the information is not yet cached in model, connects to the database to get it.

See also: typeInfoForModel, driverInfo, typeInfo


externalTypeForOdbcType

public static java.lang.String externalTypeForOdbcType(int type, com.apple.yellow.eoaccess.EOModel model)

Returns the external type that represents the best match for an ODBC type in model.


getOdbcInfoWithConnectionDictionary

public static com.apple.yellow.foundation.NSDictionary getOdbcInfoWithConnectionDictionary(com.apple.yellow.foundation.NSDictionary connectionDictionary)

Sets up the typeInfo and driverInfo dictionaries in connectionDictionary, and returns an updated connection dictionary. Creates an ODBCAdaptor, ODBCContext, and ODBCChannel, and connects to the database to get the information for the typeInfo and driverInfo dictionaries.


odbcTypeForExternalType

public static java.lang.String odbcTypeForExternalType(java.lang.String externalType, com.apple.yellow.eoaccess.EOModel model)

Returns the ODBC type for externalType, as defined in the typeInfo dictionary in model's connection dictionary.


odbcTypeForStringRepresentation

public static int odbcTypeForStringRepresentation(java.lang.String type)

Returns the ODBC type (such as SQL_CHAR) for type (such as @"CHAR"). The method stringRepresentationForOdbcType performs the opposite function: returning a string for a specified ODBC type. These methods are used in conjunction to encode ODBC types in the typeInfo dictionary.


resetOdbcInfoWithConnectionDictionary

public static com.apple.yellow.foundation.NSDictionary resetOdbcInfoWithConnectionDictionary(com.apple.yellow.foundation.NSDictionary connectionDictionary)

Removes the typeInfo and driverInfo dictionaries from a copy of connectionDictionary and returns the modified connection dictionary.


stringRepresentationForOdbcType

public static java.lang.String stringRepresentationForOdbcType(int type)

Returns the string representation of type-for example, for the type SQL_CHAR this method would return the string @"CHAR". The method odbcTypeForStringRepresentation performs the opposite function: returning the ODBC type for a specified string. These methods are used in conjunction to encode ODBC types in the typeInfo dictionary.


typeInfoForModel

public static com.apple.yellow.foundation.NSDictionary typeInfoForModel(com.apple.yellow.eoaccess.EOModel model)

Returns an NSDictionary containing the type information cached in the connection dictionary of model. If the information is not yet cached in model, connects to the database to get it.

See also: driverInfoForModel, driverInfo, typeInfo


Instance Methods


driverInfo

public com.apple.yellow.foundation.NSDictionary driverInfo()

Returns an NSDictionary containing the driver information cached in the receiver's model's connection dictionary. If the information is not yet cached in the model, connects to the database to get it.

See also: typeInfo


odbcConnectionString

public java.lang.String odbcConnectionString()

Returns the user name, password, and data source as a string that's used to connect to the database.


typeInfo

public com.apple.yellow.foundation.NSDictionary typeInfo()

Returns an NSDictionary containing the type information cached in the receiver's model's connection dictionary. If the information is not yet cached in the model, connects to the database to get it.

See also: driverInfo, driverInfoForModel, typeInfoForModel





Copyright © 1998, Apple Computer, Inc. All rights reserved.