com.metamatrix.dqp.message
Class RequestMessage

java.lang.Object
  com.metamatrix.dqp.message.RequestMessage

All Implemented Interfaces:

java.io.Serializable

public class RequestMessage
extends java.lang.Object
implements java.io.Serializable

Request Message, used by MMXStatement for submitting queries.

See Also:

Serialized Form

Field Summary

static int

DEFAULT_FETCH_SIZE

Constructor Summary

RequestMessage()

RequestMessage(java.lang.String command)

Method Summary

java.lang.String[]	getCommands()
java.lang.String	getCommandString()
int	getCursorType()
long	getExecutionId()
java.io.Serializable	getExecutionPayload()
int	getFetchSize()
java.util.List	getParameterValues()
java.util.Date	getProcessingTimestamp() Get time that the request was assigned a unique ID by the server.
java.lang.Boolean	getRequireResultSet()
int	getRowLimit()
boolean	getShowPlan()
java.lang.String	getStyleSheet()
java.util.Date	getSubmittedTimestamp() Get time that the time when the command was created by the client.
java.lang.String	getTxnAutoWrapMode()
boolean	getValidationMode()
java.lang.String	getXMLFormat()
boolean	isBatchedUpdate()
boolean	isCallableStatement()
boolean	isDoubleQuotedVariableAllowed()
boolean	isPreparedBatchUpdate()
boolean	isPreparedStatement()
boolean	isQueryPlanAllowed()
void	markProcessingStart() Start the clock on processing times - this should be called when the query hits the QueryService or SubscriptionService.
void	markSubmissionStart() Start the clock on submission start - this should be called when the request is originally created.
void	setBatchedUpdate(boolean isBatchedUpdate)
void	setCallableStatement(boolean isCallableStatement)
void	setCommands(java.lang.String... batchedCommands)
void	setCursorType(int cursorType) Sets the cursorType.
void	setDoubleQuotedVariableAllowed(boolean allowed)
void	setExecutionId(long executionId)
void	setExecutionPayload(java.io.Serializable executionPayload)
void	setFetchSize(int fetchSize)
void	setParameterValues(java.util.List values)
void	setPartialResults(boolean partial)
void	setPreparedBatchUpdate(boolean isPreparedBatchUpdate)
void	setPreparedStatement(boolean isPreparedStatement)
void	setProcessingTimestamp(java.util.Date processingTimestamp) Set time that the request is submitted on the server.
void	setQueryPlanAllowed(boolean allowed)
void	setRequireResultSet(java.lang.Boolean requireResultSet)
void	setRowLimit(int rowLimit)
void	setShowPlan(boolean showPlan)
void	setStyleSheet(java.lang.String styleSheet) Sets the styleSheet.
void	setSubmittedTimestamp(java.util.Date submittedTimestamp) Set time that the time when the command was created by the client.
void	setTxnAutoWrapMode(java.lang.String txnAutoWrapMode) Sets the txnAutoWrapMode.
void	setUseResultSetCache(boolean useResultSetCacse)
void	setValidationMode(boolean validationMode) Sets the validationMode.
void	setXMLFormat(java.lang.String xMLFormat) Sets the xMLFormat.
boolean	supportsPartialResults()
boolean	useResultSetCache()

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

Constructor Detail

RequestMessage

public RequestMessage()

RequestMessage

public RequestMessage(java.lang.String command)

Method Detail

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.

setPreparedStatement

public void setPreparedStatement(boolean isPreparedStatement)

Parameters:

isPreparedStatement -

setCallableStatement

public void setCallableStatement(boolean isCallableStatement)

Parameters:

isCallableStatement -

getParameterValues

public java.util.List getParameterValues()

Returns:

A list of parameter values. May be null.

setParameterValues

public void setParameterValues(java.util.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 java.lang.String getXMLFormat()

Returns:

String

setValidationMode

public void setValidationMode(boolean validationMode)

Sets the validationMode.

Parameters:

validationMode - The validationMode to set

setXMLFormat

public void setXMLFormat(java.lang.String xMLFormat)

Sets the xMLFormat.

Parameters:

xMLFormat - The xMLFormat to set

getTxnAutoWrapMode

public java.lang.String getTxnAutoWrapMode()

Returns:

String

setTxnAutoWrapMode

public void setTxnAutoWrapMode(java.lang.String txnAutoWrapMode)
                        throws MetaMatrixProcessingException

Sets the txnAutoWrapMode.

Parameters:

txnAutoWrapMode - The txnAutoWrapMode to set

Throws:

MetaMatrixProcessingException

getStyleSheet

public java.lang.String getStyleSheet()

Returns:

String

setStyleSheet

public void setStyleSheet(java.lang.String styleSheet)

Sets the styleSheet.

Parameters:

styleSheet - The styleSheet to set

getSubmittedTimestamp

public java.util.Date getSubmittedTimestamp()

Get time that the time when the command was created by the client.

Returns:

timestamp in millis

setSubmittedTimestamp

public void setSubmittedTimestamp(java.util.Date submittedTimestamp)

Set time that the time when the command was created by the client. NOTE: By default, this gets set to the current time by the constructor.

Parameters:

submittedTimestamp - Time submitted to server.

markSubmissionStart

public void markSubmissionStart()

Start the clock on submission start - this should be called when the request is originally created.

getProcessingTimestamp

public java.util.Date getProcessingTimestamp()

Get time that the request was assigned a unique ID by the server.

Returns:

timestamp in millis

setProcessingTimestamp

public void setProcessingTimestamp(java.util.Date processingTimestamp)

Set time that the request is submitted on the server.

Parameters:

processingTimestamp - Time submitted to server.

markProcessingStart

public void markProcessingStart()

Start the clock on processing times - this should be called when the query hits the QueryService or SubscriptionService.

useResultSetCache

public boolean useResultSetCache()

setUseResultSetCache

public void setUseResultSetCache(boolean useResultSetCacse)

getCommandString

public java.lang.String getCommandString()

setDoubleQuotedVariableAllowed

public void setDoubleQuotedVariableAllowed(boolean allowed)

isDoubleQuotedVariableAllowed

public boolean isDoubleQuotedVariableAllowed()

setQueryPlanAllowed

public void setQueryPlanAllowed(boolean allowed)

isQueryPlanAllowed

public boolean isQueryPlanAllowed()

getShowPlan

public boolean getShowPlan()

Returns:

Returns the showPlan.

Since:

4.3

setShowPlan

public void setShowPlan(boolean showPlan)

Parameters:

showPlan - The showPlan to set.

Since:

4.3

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 java.lang.String[] getCommands()

setCommands

public void setCommands(java.lang.String... batchedCommands)

isPreparedBatchUpdate

public boolean isPreparedBatchUpdate()

setPreparedBatchUpdate

public void setPreparedBatchUpdate(boolean isPreparedBatchUpdate)

setExecutionPayload

public void setExecutionPayload(java.io.Serializable executionPayload)

getExecutionPayload

public java.io.Serializable getExecutionPayload()

getExecutionId

public long getExecutionId()

setExecutionId

public void setExecutionId(long executionId)

setBatchedUpdate

public void setBatchedUpdate(boolean isBatchedUpdate)

isBatchedUpdate

public boolean isBatchedUpdate()

getRequireResultSet

public java.lang.Boolean getRequireResultSet()

setRequireResultSet

public void setRequireResultSet(java.lang.Boolean requireResultSet)