com.metamatrix.dqp.message
Class ResultsMessage

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

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable

public class ResultsMessage
extends java.lang.Object
implements java.io.Externalizable

Results Message, used by MMStatement to get the query results.

See Also:

Serialized Form

Constructor Summary

ResultsMessage()

ResultsMessage(RequestMessage requestMsg)
Instantiate and copy relevant information from the original request message.

ResultsMessage(RequestMessage requestMsg, java.util.List[] results, java.lang.String[] columnNames, java.lang.String[] dataTypes)

Method Summary

java.util.Collection	getAnnotations()
java.lang.String[]	getColumnNames()
java.util.Date	getCompletedTimestamp()
java.lang.String[]	getDataTypes()
java.lang.String	getDebugLog()
MetaMatrixException	getException()
int	getFinalRow()
int	getFirstRow()
int	getLastRow()
java.util.List	getParameters()
java.util.Map	getPlanDescription()
java.util.Date	getProcessingTimestamp()
java.util.List[]	getResults()
java.util.Collection	getSchemas()
java.util.List	getWarnings()
boolean	isUpdateResult()
void	readExternal(java.io.ObjectInput in)
void	setAnnotations(java.util.Collection collection)
void	setColumnNames(java.lang.String[] columnNames)
void	setDataTypes(java.lang.String[] dataTypes)
void	setDebugLog(java.lang.String string)
void	setException(java.lang.Throwable e)
void	setFinalRow(int i)
void	setFirstRow(int i)
void	setLastRow(int i)
void	setParameters(java.util.List list)
void	setPlanDescription(java.util.Map object)
void	setResults(java.util.List[] results)
void	setSchemas(java.util.Collection collection)
void	setUpdateResult(boolean isUpdateResult)
void	setWarnings(java.util.List<java.lang.Throwable> list)
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultsMessage

public ResultsMessage()

ResultsMessage

public ResultsMessage(RequestMessage requestMsg)

Instantiate and copy relevant information from the original request message. Typically, the transaction context should only be copied if this results message is being returned from the connector to the query engine. Clients will be unable to deserialize this object.

Parameters:

requestMsg -

copyTransactionContext - true if the transaction context should be copied; false otherwise.

Since:

4.2

ResultsMessage

public ResultsMessage(RequestMessage requestMsg,
                      java.util.List[] results,
                      java.lang.String[] columnNames,
                      java.lang.String[] dataTypes)

Method Detail

getResults

public java.util.List[] getResults()

setResults

public void setResults(java.util.List[] results)

getColumnNames

public java.lang.String[] getColumnNames()

getDataTypes

public java.lang.String[] getDataTypes()

getException

public MetaMatrixException getException()

Returns:

getFinalRow

public int getFinalRow()

Returns:

getFirstRow

public int getFirstRow()

Returns:

getLastRow

public int getLastRow()

Returns:

getPlanDescription

public java.util.Map getPlanDescription()

Returns:

getSchemas

public java.util.Collection getSchemas()

Returns:

getWarnings

public java.util.List getWarnings()

Returns:

setException

public void setException(java.lang.Throwable e)

Parameters:

exception -

setFinalRow

public void setFinalRow(int i)

Parameters:

i -

setFirstRow

public void setFirstRow(int i)

Parameters:

i -

setLastRow

public void setLastRow(int i)

Parameters:

i -

setPlanDescription

public void setPlanDescription(java.util.Map object)

Parameters:

object -

setSchemas

public void setSchemas(java.util.Collection collection)

Parameters:

collection -

setWarnings

public void setWarnings(java.util.List<java.lang.Throwable> list)

Parameters:

list -

getParameters

public java.util.List getParameters()

Returns:

setParameters

public void setParameters(java.util.List list)

Parameters:

list -

getProcessingTimestamp

public java.util.Date getProcessingTimestamp()

getCompletedTimestamp

public java.util.Date getCompletedTimestamp()

setColumnNames

public void setColumnNames(java.lang.String[] columnNames)

Parameters:

strings -

setDataTypes

public void setDataTypes(java.lang.String[] dataTypes)

Parameters:

strings -

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

getAnnotations

public java.util.Collection getAnnotations()

Returns:

getDebugLog

public java.lang.String getDebugLog()

Returns:

setAnnotations

public void setAnnotations(java.util.Collection collection)

Parameters:

collection -

setDebugLog

public void setDebugLog(java.lang.String string)

Parameters:

string -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setUpdateResult

public void setUpdateResult(boolean isUpdateResult)

isUpdateResult

public boolean isUpdateResult()