File	Doc	Category	Size	Date	Package
Platform.java	API Doc	Glassfish v2 API	8115	Tue May 22 16:54:22 BST 2007	oracle.toplink.essentials.internal.databaseaccess

Platform

Fields Summary

Constructors Summary

Methods Summary
public void	addSequence(oracle.toplink.essentials.sequencing.Sequence sequence) Add sequence. The sequence should have a unique name that shouldn't be altered after the sequence has been added - don't do: getSequence(name).setName(newName))
public void	appendParameter(oracle.toplink.essentials.queryframework.Call call, java.io.Writer writer, java.lang.Object parameter) Add the parameter. Convert the parameter to a string and write it.
public java.lang.Object	clone()
public 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 param object - the object that must be converted param javaClass - the class that the object must be converted to exception - ConversionException, all exceptions will be thrown as this type. return - the newly converted object
public void	copyInto(oracle.toplink.essentials.internal.databaseaccess.Platform platform) Copy the state into the new platform.
public oracle.toplink.essentials.internal.helper.ConversionManager	getConversionManager() The platform hold its own instance of conversion manager to allow customization.
public java.lang.Object	getCustomModifyValueForCall(oracle.toplink.essentials.queryframework.Call call, java.lang.Object value, oracle.toplink.essentials.internal.helper.DatabaseField field, boolean shouldBind) Allow for the platform to handle the representation of parameters specially.
public oracle.toplink.essentials.sequencing.Sequence	getDefaultSequence() Get default sequence. Sequence name shouldn't be altered - don't do: getDefaultSequence().setName(newName).
public oracle.toplink.essentials.sequencing.Sequence	getDefaultSequenceToWrite() INTERNAL: Used only for writing into XML or Java.
public oracle.toplink.essentials.sequencing.Sequence	getSequence(java.lang.String seqName) Get sequence corresponding to the name. The name shouldn't be altered - don't do: getSequence(name).setName(newName)
public java.util.Map	getSequences() INTERNAL: Returns a map of sequence names to Sequences (may be null).
public java.util.Map	getSequencesToWrite() INTERNAL: Used only for writing into XML or Java.
public java.lang.String	getTableQualifier() Return the qualifier for the table. Required by some databases such as Oracle and DB2
public java.sql.Timestamp	getTimestampFromServer(oracle.toplink.essentials.internal.sessions.AbstractSession session, java.lang.String sessionName) Answer the timestamp from the server.
public oracle.toplink.essentials.queryframework.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.
public boolean	isAccess()
public boolean	isAttunity()
public boolean	isCloudscape()
public boolean	isDB2()
public boolean	isDBase()
public boolean	isDerby()
public boolean	isHSQL()
public boolean	isInformix()
public boolean	isMySQL()
public boolean	isODBC()
public boolean	isOracle()
public boolean	isPointBase()
public boolean	isPostgreSQL()
public boolean	isSQLAnywhere()
public boolean	isSQLServer()
public boolean	isSybase()
public boolean	isTimesTen()
public void	platformSpecificSequencingInitialization(oracle.toplink.essentials.sessions.DatabaseSession session) INTERNAL: Platform specific sequencing initialization. This internal method should only be called by SequencingManager.
public void	removeAllSequences() Remove all sequences that were added throud addSequence method.
public oracle.toplink.essentials.sequencing.Sequence	removeSequence(java.lang.String seqName) Remove sequence corresponding to the name (the sequence was added through addSequence method)
public void	setConversionManager(oracle.toplink.essentials.internal.helper.ConversionManager conversionManager) The platform hold its own instance of conversion manager to allow customization.
public void	setDefaultSequence(oracle.toplink.essentials.sequencing.Sequence sequence) Set default sequence. The sequence should have a unique name that shouldn't be altered after the sequence has been set: don't do: getDefaultSequence().setName(newName)). Default constructors for Sequence subclasses set name to "SEQ".
public void	setSequences(java.util.Map sequences) INTERNAL: Used only for reading from XML.
public void	setTableQualifier(java.lang.String qualifier) Set the qualifier for the table. Required by some databases such as Oracle and DB2
public void	setTimestampQuery(oracle.toplink.essentials.queryframework.ValueReadQuery tsQuery) Can override the default query for returning a timestamp from the server. See: getTimestampFromServer
public boolean	shouldUseCustomModifyForCall(oracle.toplink.essentials.internal.helper.DatabaseField field) Allow for the platform to handle the representation of parameters specially.
public boolean	usesPlatformDefaultSequence() INTERNAL: Indicates whether defaultSequence is the same as platform default sequence.