oracle.toplink.essentials.internal.databaseaccess

Class DatasourcePlatform

java.lang.Object

oracle.toplink.essentials.internal.databaseaccess.DatasourcePlatform

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Platform

Direct Known Subclasses:

DatabasePlatform

public class DatasourcePlatform
extends java.lang.Object
implements Platform

DatasourcePlatform is private to TopLink. It encapsulates behavior specific to a datasource platform (eg. Oracle, Sybase, DB2, Attunity, MQSeries), and provides protocol for TopLink to access this behavior.

Since:

OracleAS TopLink 10g (10.0.3)

See Also:

DatabasePlatform, oracle.toplink.essentials.eis.EISPlatform, oracle.toplink.essentials.xml.XMLPlatform, oracle.toplink.essentials.sdk.SDKPlatform, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ConversionManager	conversionManager Allow for conversion to be customized in the platform.
protected java.util.Hashtable	dataTypesConvertedFromAClass Store the list of Classes that can be converted to from the key.
protected java.util.Hashtable	dataTypesConvertedToAClass Store the list of Classes that can be converted from to the key.
protected Sequence	defaultSequence Store default sequence
protected java.util.Map	platformOperators Operators specific to this platform
protected java.util.Map	sequences Store map of sequence names to sequences
protected java.lang.String	tableQualifier Supporting name scopes in database by prefixing the table names with the table qualifier/creator.
protected ValueReadQuery	timestampQuery Store the query use to query the current server time.

Constructor Summary

Constructors

Constructor and Description
DatasourcePlatform()

Method Summary

Modifier and Type	Method and Description
protected void	addOperator(ExpressionOperator operator)
void	addSequence(Sequence sequence) Add sequence corresponding to the name
void	appendParameter(Call call, java.io.Writer writer, java.lang.Object parameter) Add the parameter.
java.lang.Object	clone()
java.lang.Object	convertObject(java.lang.Object sourceObject, java.lang.Class javaClass) Convert the object to the appropriate type by invoking the appropriate ConversionManager method
void	copyInto(Platform platform) Copy the state into the new platform.
protected Sequence	createPlatformDefaultSequence() INTERNAL: Create platform-default Sequence
protected void	createSequences()
ConversionManager	getConversionManager() The platform hold its own instance of conversion manager to allow customization.
java.lang.Object	getCustomModifyValueForCall(Call call, java.lang.Object value, DatabaseField field, boolean shouldBind) Allow for the platform to handle the representation of parameters specially.
java.util.Vector	getDataTypesConvertedFrom(java.lang.Class javaClass) PUBLIC: Return the list of Classes that can be converted to from the passed in javaClass.
java.util.Vector	getDataTypesConvertedTo(java.lang.Class javaClass) PUBLIC: Return the list of Classes that can be converted from to the passed in javaClass.
Sequence	getDefaultSequence() Get default sequence
Sequence	getDefaultSequenceToWrite() INTERNAL: Used only for writing into XML or Java.
ExpressionOperator	getOperator(int selector) Return the operator for the operator constant defined in ExpressionOperator.
java.util.Map	getPlatformOperators() Return any platform-specific operators
Sequence	getSequence(java.lang.String seqName) Get sequence corresponding to the name
int	getSequencePreallocationSize()
java.util.Map	getSequences() INTERNAL: Returns a map of sequence names to Sequences (may be null).
java.util.Map	getSequencesToWrite() INTERNAL: Used only for writing into XML or Java.
java.lang.String	getTableQualifier() Return the qualifier for the table.
java.sql.Timestamp	getTimestampFromServer(AbstractSession session, java.lang.String sessionName) Answer the timestamp from the server.
ValueReadQuery	getTimestampQuery() This method can be overridden by subclasses to return a query that will return the timestamp from the server.
boolean	hasDefaultSequence() Get default sequence
protected void	initializePlatformOperators() Initialize any platform-specific operators
boolean	isAccess()
boolean	isAttunity()
boolean	isCloudscape()
boolean	isDB2()
boolean	isDBase()
boolean	isDerby()
boolean	isHSQL()
boolean	isInformix()
boolean	isMySQL()
boolean	isODBC()
boolean	isOracle()
boolean	isPointBase()
boolean	isPostgreSQL()
boolean	isSQLAnywhere()
boolean	isSQLServer()
boolean	isSybase()
boolean	isTimesTen()
void	platformSpecificSequencingInitialization(DatabaseSession session) INTERNAL: Platform specific sequencing initialization.
void	removeAllSequences() Remove all sequences, but the default one.
Sequence	removeSequence(java.lang.String seqName) Remove sequence corresponding to name.
protected void	sequencesAfterCloneCleanup()
void	setConversionManager(ConversionManager conversionManager) The platform hold its own instance of conversion manager to allow customization.
void	setDefaultSequence(Sequence sequence) Set default sequence.
void	setSequences(java.util.Map sequences) INTERNAL: Sets sequences - for XML support only
void	setTableQualifier(java.lang.String qualifier) Set the qualifier for the table.
void	setTimestampQuery(ValueReadQuery tsQuery) Can override the default query for returning a timestamp from the server.
boolean	shouldUseCustomModifyForCall(DatabaseField field) Used by SQLCall.appendModify(..) If the field should be passed to customModifyInDatabaseCall, retun true, otherwise false.
java.lang.String	toString()
boolean	usesPlatformDefaultSequence() INTERNAL: Indicates whether defaultSequence is the same as platform default sequence.

Methods inherited from class java.lang.Object

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

Field Detail

tableQualifier

protected java.lang.String tableQualifier

Supporting name scopes in database by prefixing the table names with the table qualifier/creator.

conversionManager

protected transient ConversionManager conversionManager

Allow for conversion to be customized in the platform.

timestampQuery

protected ValueReadQuery timestampQuery

Store the query use to query the current server time.

platformOperators

protected transient java.util.Map platformOperators

Operators specific to this platform

dataTypesConvertedFromAClass

protected java.util.Hashtable dataTypesConvertedFromAClass

Store the list of Classes that can be converted to from the key.

dataTypesConvertedToAClass

protected java.util.Hashtable dataTypesConvertedToAClass

Store the list of Classes that can be converted from to the key.

defaultSequence

protected Sequence defaultSequence

Store default sequence

sequences

protected java.util.Map sequences

Store map of sequence names to sequences

Constructor Detail

DatasourcePlatform

public DatasourcePlatform()

Method Detail

addOperator

protected void addOperator(ExpressionOperator operator)

appendParameter

public void appendParameter(Call call,
                            java.io.Writer writer,
                            java.lang.Object parameter)

Add the parameter. Convert the parameter to a string and write it.

Specified by:

appendParameter in interface Platform

getCustomModifyValueForCall

public java.lang.Object getCustomModifyValueForCall(Call call,
                                                    java.lang.Object value,
                                                    DatabaseField field,
                                                    boolean shouldBind)

Allow for the platform to handle the representation of parameters specially.

Specified by:

getCustomModifyValueForCall in interface Platform

shouldUseCustomModifyForCall

public boolean shouldUseCustomModifyForCall(DatabaseField field)

Used by SQLCall.appendModify(..) If the field should be passed to customModifyInDatabaseCall, retun true, otherwise false. Methods shouldCustomModifyInDatabaseCall and customModifyInDatabaseCall should be kept in sync: shouldCustomModifyInDatabaseCall should return true if and only if the field is handled by customModifyInDatabaseCall.

Specified by:

shouldUseCustomModifyForCall in interface Platform

clone

public java.lang.Object clone()

Specified by:

clone in interface Platform

Overrides:

clone in class java.lang.Object

sequencesAfterCloneCleanup

protected void sequencesAfterCloneCleanup()

convertObject

public java.lang.Object convertObject(java.lang.Object sourceObject,
                                      java.lang.Class javaClass)
                               throws ConversionException

Convert the object to the appropriate type by invoking the appropriate ConversionManager method

Specified by:

convertObject in interface Platform

Parameters:

object - - the object that must be converted

javaClass - - the class that the object must be converted to

Returns:

- the newly converted object

Throws:

- - ConversionException, all exceptions will be thrown as this type.

ConversionException

copyInto

public void copyInto(Platform platform)

Copy the state into the new platform.

Specified by:

copyInto in interface Platform

getConversionManager

public ConversionManager getConversionManager()

The platform hold its own instance of conversion manager to allow customization.

Specified by:

getConversionManager in interface Platform

setConversionManager

public void setConversionManager(ConversionManager conversionManager)

The platform hold its own instance of conversion manager to allow customization.

Specified by:

setConversionManager in interface Platform

getOperator

public ExpressionOperator getOperator(int selector)

Return the operator for the operator constant defined in ExpressionOperator.

getPlatformOperators

public java.util.Map getPlatformOperators()

Return any platform-specific operators

getSequencePreallocationSize

public int getSequencePreallocationSize()

getTableQualifier

public java.lang.String getTableQualifier()

Return the qualifier for the table. Required by some databases such as Oracle and DB2

Specified by:

getTableQualifier in interface Platform

getTimestampFromServer

public java.sql.Timestamp getTimestampFromServer(AbstractSession session,
                                                 java.lang.String sessionName)

Answer the timestamp from the server.

Specified by:

getTimestampFromServer in interface Platform

getTimestampQuery

public ValueReadQuery getTimestampQuery()

This method can be overridden by subclasses to return a query that will return the timestamp from the server. return null if the time should be the local time.

Specified by:

getTimestampQuery in interface Platform

initializePlatformOperators

protected void initializePlatformOperators()

Initialize any platform-specific operators

isAccess

public boolean isAccess()

Specified by:

isAccess in interface Platform

isAttunity

public boolean isAttunity()

Specified by:

isAttunity in interface Platform

isCloudscape

public boolean isCloudscape()

Specified by:

isCloudscape in interface Platform

isDerby

public boolean isDerby()

Specified by:

isDerby in interface Platform

isDB2

public boolean isDB2()

Specified by:

isDB2 in interface Platform

isDBase

public boolean isDBase()

Specified by:

isDBase in interface Platform

isHSQL

public boolean isHSQL()

Specified by:

isHSQL in interface Platform

isInformix

public boolean isInformix()

Specified by:

isInformix in interface Platform

isMySQL

public boolean isMySQL()

Specified by:

isMySQL in interface Platform

isODBC

public boolean isODBC()

Specified by:

isODBC in interface Platform

isOracle

public boolean isOracle()

Specified by:

isOracle in interface Platform

isPointBase

public boolean isPointBase()

Specified by:

isPointBase in interface Platform

isSQLAnywhere

public boolean isSQLAnywhere()

Specified by:

isSQLAnywhere in interface Platform

isSQLServer

public boolean isSQLServer()

Specified by:

isSQLServer in interface Platform

isSybase

public boolean isSybase()

Specified by:

isSybase in interface Platform

isTimesTen

public boolean isTimesTen()

Specified by:

isTimesTen in interface Platform

isPostgreSQL

public boolean isPostgreSQL()

Specified by:

isPostgreSQL in interface Platform

setTableQualifier

public void setTableQualifier(java.lang.String qualifier)

Set the qualifier for the table. Required by some databases such as Oracle and DB2

Specified by:

setTableQualifier in interface Platform

setTimestampQuery

public void setTimestampQuery(ValueReadQuery tsQuery)

Can override the default query for returning a timestamp from the server. See: getTimestampFromServer

Specified by:

setTimestampQuery in interface Platform

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDataTypesConvertedFrom

public java.util.Vector getDataTypesConvertedFrom(java.lang.Class javaClass)

PUBLIC: Return the list of Classes that can be converted to from the passed in javaClass.

Parameters:

javaClass - - the class that is converted from

Returns:

- a vector of classes

getDataTypesConvertedTo

public java.util.Vector getDataTypesConvertedTo(java.lang.Class javaClass)

PUBLIC: Return the list of Classes that can be converted from to the passed in javaClass.

Parameters:

javaClass - - the class that is converted to

Returns:

- a vector of classes

getDefaultSequence

public Sequence getDefaultSequence()

Get default sequence

Specified by:

getDefaultSequence in interface Platform

hasDefaultSequence

public boolean hasDefaultSequence()

Get default sequence

setDefaultSequence

public void setDefaultSequence(Sequence sequence)

Set default sequence. In case the passed sequence is of type DefaultSequence - use platformDefaultSequence with name and size of the passed sequence.

Specified by:

setDefaultSequence in interface Platform

addSequence

public void addSequence(Sequence sequence)

Add sequence corresponding to the name

Specified by:

addSequence in interface Platform

getSequence

public Sequence getSequence(java.lang.String seqName)

Get sequence corresponding to the name

Specified by:

getSequence in interface Platform

createPlatformDefaultSequence

protected Sequence createPlatformDefaultSequence()

INTERNAL: Create platform-default Sequence

createSequences

protected void createSequences()

removeSequence

public Sequence removeSequence(java.lang.String seqName)

Remove sequence corresponding to name. Doesn't remove default sequence.

Specified by:

removeSequence in interface Platform

removeAllSequences

public void removeAllSequences()

Remove all sequences, but the default one.

Specified by:

removeAllSequences in interface Platform

getSequences

public java.util.Map getSequences()

INTERNAL: Returns a map of sequence names to Sequences (may be null).

Specified by:

getSequences in interface Platform

getSequencesToWrite

public java.util.Map getSequencesToWrite()

INTERNAL: Used only for writing into XML or Java.

Specified by:

getSequencesToWrite in interface Platform

getDefaultSequenceToWrite

public Sequence getDefaultSequenceToWrite()

INTERNAL: Used only for writing into XML or Java.

Specified by:

getDefaultSequenceToWrite in interface Platform

setSequences

public void setSequences(java.util.Map sequences)

INTERNAL: Sets sequences - for XML support only

Specified by:

setSequences in interface Platform

usesPlatformDefaultSequence

public boolean usesPlatformDefaultSequence()

INTERNAL: Indicates whether defaultSequence is the same as platform default sequence.

Specified by:

usesPlatformDefaultSequence in interface Platform

platformSpecificSequencingInitialization

public void platformSpecificSequencingInitialization(DatabaseSession session)

INTERNAL: Platform specific sequencing initialization. This internal method should only be called by SequencingManager. By default does nothing.

Specified by:

platformSpecificSequencingInitialization in interface Platform