org.teiid.client

Class RequestMessage

java.lang.Object

org.teiid.client.RequestMessage

All Implemented Interfaces:

Externalizable, Serializable

public class RequestMessage
extends Object
implements Externalizable

Request Message, used by MMXStatement for submitting queries.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RequestMessage.ResultsMode
static class	RequestMessage.ShowPlan
static class	RequestMessage.StatementType

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_FETCH_SIZE
static String	TXN_WRAP_DETECT Transaction auto wrap constant - checks if a command requires a transaction and will be automatically wrap it.
static String	TXN_WRAP_OFF Transaction auto wrap constant - never wrap a command execution in a transaction
static String	TXN_WRAP_ON Transaction auto wrap constant - always wrap commands in a transaction.

Constructor Summary

Constructors

Constructor and Description
RequestMessage()
RequestMessage(String command)

Method Summary

Methods

Modifier and Type	Method and Description
String[]	getCommands()
String	getCommandString()
int	getCursorType()
long	getExecutionId()
Serializable	getExecutionPayload()
int	getFetchSize()
List<?>	getParameterValues()
RequestOptions	getRequestOptions()
RequestMessage.ResultsMode	getResultsMode()
int	getRowLimit()
RequestMessage.ShowPlan	getShowPlan()
String	getStyleSheet()
int	getTransactionIsolation()
String	getTxnAutoWrapMode()
boolean	getValidationMode()
String	getXMLFormat()
boolean	isAnsiQuotedIdentifiers()
boolean	isBatchedUpdate()
boolean	isCallableStatement()
boolean	isNoExec()
boolean	isPreparedStatement()
boolean	isSync()
void	readExternal(ObjectInput in)
void	setAnsiQuotedIdentifiers(boolean ansiQuotedIdentifiers)
void	setBatchedUpdate(boolean isBatchedUpdate)
void	setCommands(String... batchedCommands)
void	setCursorType(int cursorType) Sets the cursorType.
void	setExecutionId(long executionId)
void	setExecutionPayload(Serializable executionPayload)
void	setFetchSize(int fetchSize)
void	setNoExec(boolean noExec)
void	setParameterValues(List<?> values)
void	setPartialResults(boolean partial)
void	setRequestOptions(RequestOptions requestOptions)
void	setResultsMode(RequestMessage.ResultsMode resultsMode)
void	setRowLimit(int rowLimit)
void	setShowPlan(RequestMessage.ShowPlan showPlan)
void	setStatementType(RequestMessage.StatementType statementType)
void	setStyleSheet(String styleSheet) Sets the styleSheet.
void	setSync(boolean sync)
void	setTransactionIsolation(int transactionIsolation)
void	setTxnAutoWrapMode(String txnAutoWrapMode) Sets the txnAutoWrapMode.
void	setUseResultSetCache(boolean useResultSetCacse)
void	setValidationMode(boolean validationMode) Sets the validationMode.
void	setXMLFormat(String xMLFormat) Sets the xMLFormat.
boolean	supportsPartialResults()
boolean	useResultSetCache()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FETCH_SIZE

public static final int DEFAULT_FETCH_SIZE

See Also:

Constant Field Values

TXN_WRAP_OFF

public static final String TXN_WRAP_OFF

Transaction auto wrap constant - never wrap a command execution in a transaction

See Also:

Constant Field Values

TXN_WRAP_ON

public static final String TXN_WRAP_ON

Transaction auto wrap constant - always wrap commands in a transaction.

See Also:

Constant Field Values

TXN_WRAP_DETECT

public static final String TXN_WRAP_DETECT

Transaction auto wrap constant - checks if a command requires a transaction and will be automatically wrap it.

See Also:

Constant Field Values

Constructor Detail

RequestMessage

public RequestMessage()

RequestMessage

public RequestMessage(String command)

Method Detail

isSync

public boolean isSync()

setSync

public void setSync(boolean sync)

getFetchSize

public int getFetchSize()

supportsPartialResults

public boolean supportsPartialResults()

setFetchSize

public void setFetchSize(int fetchSize)

Parameters:

i -

setPartialResults

public void setPartialResults(boolean partial)

Parameters:

partial -

isPreparedStatement

public boolean isPreparedStatement()

Returns:

True if this request includes a prepared statement.

isCallableStatement

public boolean isCallableStatement()

Returns:

True if this request includes a callable statement.

setStatementType

public void setStatementType(RequestMessage.StatementType statementType)

getParameterValues

public List<?> getParameterValues()

Returns:

A list of parameter values. May be null.

setParameterValues

public void setParameterValues(List<?> values)

Parameters:

values -

getCursorType

public int getCursorType()

Returns:

String

setCursorType

public void setCursorType(int cursorType)

Sets the cursorType.

Parameters:

cursorType - The cursorType to set

getValidationMode

public boolean getValidationMode()

Returns:

boolean

getXMLFormat

public String getXMLFormat()

Returns:

String

setValidationMode

public void setValidationMode(boolean validationMode)

Sets the validationMode.

Parameters:

validationMode - The validationMode to set

setXMLFormat

public void setXMLFormat(String xMLFormat)

Sets the xMLFormat.

Parameters:

xMLFormat - The xMLFormat to set

getTxnAutoWrapMode

public String getTxnAutoWrapMode()

Returns:

String

setTxnAutoWrapMode

public void setTxnAutoWrapMode(String txnAutoWrapMode)
                        throws org.teiid.core.TeiidProcessingException

Sets the txnAutoWrapMode.

Parameters:

txnAutoWrapMode - The txnAutoWrapMode to set

Throws:

org.teiid.core.TeiidProcessingException

getStyleSheet

public String getStyleSheet()

Returns:

String

setStyleSheet

public void setStyleSheet(String styleSheet)

Sets the styleSheet.

Parameters:

styleSheet - The styleSheet to set

useResultSetCache

public boolean useResultSetCache()

setUseResultSetCache

public void setUseResultSetCache(boolean useResultSetCacse)

getCommandString

public String getCommandString()

isAnsiQuotedIdentifiers

public boolean isAnsiQuotedIdentifiers()

setAnsiQuotedIdentifiers

public void setAnsiQuotedIdentifiers(boolean ansiQuotedIdentifiers)

getShowPlan

public RequestMessage.ShowPlan getShowPlan()

setShowPlan

public void setShowPlan(RequestMessage.ShowPlan showPlan)

getRowLimit

public int getRowLimit()

Returns:

Returns the rowLimit.

Since:

4.3

setRowLimit

public void setRowLimit(int rowLimit)

Parameters:

rowLimit - The rowLimit to set.

Since:

4.3

getCommands

public String[] getCommands()

setCommands

public void setCommands(String... batchedCommands)

setExecutionPayload

public void setExecutionPayload(Serializable executionPayload)

getExecutionPayload

public Serializable getExecutionPayload()

getExecutionId

public long getExecutionId()

setExecutionId

public void setExecutionId(long executionId)

setBatchedUpdate

public void setBatchedUpdate(boolean isBatchedUpdate)

isBatchedUpdate

public boolean isBatchedUpdate()

getResultsMode

public RequestMessage.ResultsMode getResultsMode()

setResultsMode

public void setResultsMode(RequestMessage.ResultsMode resultsMode)

getTransactionIsolation

public int getTransactionIsolation()

setTransactionIsolation

public void setTransactionIsolation(int transactionIsolation)

isNoExec

public boolean isNoExec()

setNoExec

public void setNoExec(boolean noExec)

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getRequestOptions

public RequestOptions getRequestOptions()

setRequestOptions

public void setRequestOptions(RequestOptions requestOptions)