com.webobjects.jdbcadaptor

Class ERMicrosoftPlugIn

java.lang.Object

com.webobjects.jdbcadaptor.JDBCPlugIn

com.webobjects.jdbcadaptor.MicrosoftPlugIn

com.webobjects.jdbcadaptor.ERMicrosoftPlugIn

public class ERMicrosoftPlugIn
extends MicrosoftPlugIn

The ERMicrosoftPlugIn is a JDBCPlugIn implementation for Microsoft SQL Server database. This class extends the standard MicrosoftPlugIn to use features available on newer versions of SQL Server.

See Also:

JDBCPlugIn, MicrosoftPlugIn

Author:

hprange

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.jdbcadaptor.MicrosoftPlugIn

MicrosoftPlugIn.MicrosoftExpression, MicrosoftPlugIn.MicrosoftSynchronizationFactory

Nested classes/interfaces inherited from class com.webobjects.jdbcadaptor.JDBCPlugIn

JDBCPlugIn.LobEntry

Field Summary

Fields inherited from class com.webobjects.jdbcadaptor.JDBCPlugIn

_adaptor, _expressionClass, _expressionFactory, _pkTableName, _subprotocolRegistry, _syncFactory, DefaultPlugInClassName, DefaultPlugInSuffix

Constructor Summary

Constructors

Constructor and Description
ERMicrosoftPlugIn(JDBCAdaptor adaptor)

Method Summary

Modifier and Type	Method and Description
String	connectionURL() The original implementation of the MicrosoftPlugIn forcibly adds the SelectMethod=cursor parameter to the connection URL.
String	defaultDriverName() The SQL Server driver name has changed over time.
Class	defaultExpressionClass() Uses the enhanced ERMicrosoftExpression as the expression class.
protected static boolean	isPrimaryKeyGenerationSupported(EOEntity entity) Checks whether primary key generation can be supported for entity.
NSDictionary<String,Object>	jdbcInfo() This is usually extracted from the database using JDBC, but this is really inconvenient for users who are trying to generate SQL at some.
NSArray<NSDictionary<String,Object>>	newPrimaryKeys(int count, EOEntity entity, JDBCChannel channel) Generates a batch of new primary keys for the given entity.
protected String	sequenceNameForEntity(EOEntity entity) Utility method that returns the name of the sequence associated with entity.
protected boolean	shouldUseBundledJdbcInfo() This method returns true if the connection URL for the database has a special flag on it which indicates to the system that the jdbcInfo which has been bundled into the plugin is acceptable to use in place of actually going to the database and getting it.

Methods inherited from class com.webobjects.jdbcadaptor.MicrosoftPlugIn

createSchemaSynchronizationFactory, databaseProductName, isDroppedConnectionException, name, newPrimaryKeySelectString

Methods inherited from class com.webobjects.jdbcadaptor.JDBCPlugIn

_attributeForPath, _couldIgnoreException, _relationshipForPath, _takeValueForKeyPath, adaptor, assignTypeForAttribute, canDescribeStoredProcedure, connectionPropertiesForConnectionDictionary, createAttributeForRow, createExpressionFactory, createSynchronizationFactory, databaseInformation, expressionFactory, fetchBLOB, fetchCLOB, isPseudoColumnName, jdbcTypeForUnknownExternalType, plugInNameForURL, plugInValueForValue, primaryKeyLockString, primaryKeyTableCreateString, primaryKeyTableName, removePlugInNameForSubprotocol, schemaNameForEntity, schemaSynchronizationFactory, setPlugInNameForSubprotocol, sqlStatementForGettingProcedureNames, sqlStatementForGettingTableNames, sqlStatementForTableNamed, storedProcedureCatalogPattern, storedProcedureNamed, storedProcedureSchemaPattern, synchronizationFactory, tableTypes, updateLOBs, wildcardPatternForAttributes, wildcardPatternForSchema, wildcardPatternForTables

Methods inherited from class java.lang.Object

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

Constructor Detail

ERMicrosoftPlugIn

public ERMicrosoftPlugIn(JDBCAdaptor adaptor)

Method Detail

connectionURL

public String connectionURL()

The original implementation of the MicrosoftPlugIn forcibly adds the SelectMethod=cursor parameter to the connection URL. Even though this option may be useful in some scenarios, it may also cause undesirable side effects. Each application may have different requirements regarding how and when to use adaptive buffering. For this reason, the ERMicrosoftPlugin lets the user decide how to configure adaptive buffering if needed.

See Microsoft documentation for more information about adaptive buffering

Overrides:

connectionURL in class MicrosoftPlugIn

defaultDriverName

public String defaultDriverName()

The SQL Server driver name has changed over time. This method returns the fully qualified name of the newest JDBC driver class that this plugin prefers to use.

Overrides:

defaultDriverName in class MicrosoftPlugIn

defaultExpressionClass

public Class defaultExpressionClass()

Uses the enhanced ERMicrosoftExpression as the expression class.

Overrides:

defaultExpressionClass in class MicrosoftPlugIn

newPrimaryKeys

public NSArray<NSDictionary<String,Object>> newPrimaryKeys(int count,
                                                           EOEntity entity,
                                                           JDBCChannel channel)

Generates a batch of new primary keys for the given entity. Overrides the default implementation to provide a more efficient mechanism for generating primary keys using database sequences.

Overrides:

newPrimaryKeys in class JDBCPlugIn

Parameters:

count - the batch size

entity - the entity requesting primary keys

channel - an open JDBCChannel

Returns:

Returns an NSArray of NSDictionary where each dictionary corresponds to a unique primary key value.

jdbcInfo

public NSDictionary<String,Object> jdbcInfo()

This is usually extracted from the database using JDBC, but this is really inconvenient for users who are trying to generate SQL at some. A specific version of the data has been written into the property list of the framework and this can be used as a hard-coded equivalent.

Overrides:

jdbcInfo in class MicrosoftPlugIn

Returns:

JDBC info

shouldUseBundledJdbcInfo

protected boolean shouldUseBundledJdbcInfo()

This method returns true if the connection URL for the database has a special flag on it which indicates to the system that the jdbcInfo which has been bundled into the plugin is acceptable to use in place of actually going to the database and getting it.

Returns:

true if bundled jdbcInfo should be used

sequenceNameForEntity

protected String sequenceNameForEntity(EOEntity entity)

Utility method that returns the name of the sequence associated with entity.

Parameters:

entity - the entity

Returns:

the name of the sequence.

isPrimaryKeyGenerationSupported

protected static boolean isPrimaryKeyGenerationSupported(EOEntity entity)

Checks whether primary key generation can be supported for entity.

Parameters:

entity - the entity to be checked

Returns:

Returns true if supported or false otherwise.