org.hsqldb.result
Class Result
- java.lang.Object
-
- org.hsqldb.result.Result
-
- Direct Known Subclasses:
- ResultLob
public class Result extends java.lang.ObjectThe primary unit of communication between Connection, Server and Session objects. An HSQLDB Result object encapsulates all requests (such as to alter or query session settings, to allocate and execute statements, etc.) and all responses (such as exception indications, update counts, result sets and result set metadata). It also implements the HSQL wire protocol for comunicating all such requests and responses across the network. Uses a navigator for data.- Since:
- 1.9.0
-
-
Field Summary
Fields Modifier and Type Field and Description static ResultemptyGeneratedResultResultMetaDatageneratedMetaDataAdditional meta data for required generated columnsResultMetaDatametaDataA Result object's metadatabytemodeRowSetNavigatornavigatorResultMetaDataparameterMetaDataAdditional meta data for parameters used in PREPARE_ACK resultsintqueryTimeoutintrsPropertiesstatic ResultMetaDatasessionAttributesMetaDataStatementstatementintupdateCountstatic ResultupdateOneResultstatic ResultupdateZeroResultjava.lang.ObjectvalueData
-
Constructor Summary
Constructors Constructor and Description Result(int mode, int count)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method and Description voidaddBatchedPreparedExecuteRequest(java.lang.Object[] parameterValues)voidaddChainedResult(Result result)voidaddLobResult(ResultLob result)voidaddWarnings(HsqlException[] warnings)voidclearLobResults()intgetActionType()ResultgetChainedResult()intgetConnectionAttrType()intgetDatabaseId()java.lang.StringgetDatabaseName()intgetErrorCode()HsqlExceptiongetException()intgetExecuteProperties()initially, only used for updatabilityintgetFetchSize()ResultMetaDatagetGeneratedResultMetaData()intgetGeneratedResultType()intgetLobCount()ResultLobgetLOBResult()java.lang.StringgetMainString()RowSetNavigatorgetNavigator()java.lang.Object[]getParameterData()longgetResultId()java.lang.Object[]getSessionAttributes()longgetSessionId()java.lang.Object[]getSingleRowData()StatementgetStatement()longgetStatementID()intgetStatementType()java.lang.StringgetSubString()intgetType()ResultgetUnlinkChainedResult()intgetUpdateCount()java.lang.ObjectgetValueObject()java.lang.StringgetZoneString()booleanhasGeneratedKeys()RowSetNavigatorinitialiseNavigator()booleanisData()booleanisError()booleanisSimpleValue()booleanisUpdateCount()booleanisWarning()static ResultnewBatchedExecuteRequest()For BATCHEXECDIRECTstatic ResultnewBatchedExecuteResponse(int[] updateCounts, Result generatedResult, Result e)For BATCHEXERESPONSE for a BATCHEXECUTE or BATCHEXECDIRECTstatic ResultnewCallResponse(Type[] types, long statementId, java.lang.Object[] values)For CALL_RESPONSE For execution of SQL callable statements.static ResultnewConnectionAcknowledgeResponse(Database database, long sessionID, int databaseID)static ResultnewConnectionAttemptRequest(java.lang.String user, java.lang.String password, java.lang.String database, java.lang.String zoneString, int timeZoneSeconds)static ResultnewDataHeadResult(SessionInterface session, Result source, int offset, int count)static ResultnewDataResult(ResultMetaData md)static ResultnewDataRowsResult(Result source, int offset, int count)static ResultnewDataRowsResult(RowSetNavigator navigator)static ResultnewErrorResult(java.lang.Throwable t)static ResultnewErrorResult(java.lang.Throwable t, java.lang.String statement)static ResultnewExecuteDirectRequest()For direct execution of SQL statements.static ResultnewFreeStmtRequest(long statementID)static ResultnewGeneratedDataResult(ResultMetaData md)static ResultnewPreparedExecuteRequest(Type[] types, long statementId)For SQLEXECUTE For execution of SQL prepared statements.static ResultnewPrepareResponse(Statement statement)static ResultnewPrepareStatementRequest()For SQLPREPARE For parparation of SQL parepared statements.static ResultnewPSMResult(int type, java.lang.String label, java.lang.Object value)For interval PSM return valuesstatic ResultnewPSMResult(java.lang.Object value)For interval PSM return valuesstatic ResultnewRequestDataResult(long id, int offset, int count)static ResultnewResetSessionRequest()static ResultnewResult(java.io.DataInput dataInput, RowInputBinary in)static ResultnewResult(int type)static ResultnewResult(RowSetNavigator nav)static ResultnewResult(Session session, int mode, java.io.DataInput dataInput, RowInputBinary in)static ResultnewSessionAttributesResult()Result structure used for set/get session attributesstatic ResultnewSetSavepointRequest(java.lang.String name)static ResultnewSingleColumnResult(ResultMetaData meta)static ResultnewSingleColumnResult(java.lang.String colName)static ResultnewSingleColumnStringResult(java.lang.String colName, java.lang.String contents)static ResultnewUpdateCountResult(int count)static ResultnewUpdateCountResult(ResultMetaData meta, int count)static ResultnewUpdateResultRequest(Type[] types, long id)For UPDATE_RESULT The parameters are set afterwards as the Result is reusedstatic ResultnewUpdateZeroResult()static ResultnewWarningResult(HsqlException w)voidreadAdditionalResults(SessionInterface session, java.io.DataInputStream inputStream, RowInputBinary in)voidreadLobResults(SessionInterface session, java.io.DataInputStream inputStream, RowInputBinary in)voidsetActionType(int type)voidsetAsTransactionEndRequest(int subType, java.lang.String savepoint)voidsetBatchedPreparedExecuteRequest()For BATCHEXECUTEvoidsetConnectionAttrType(int type)voidsetDatabaseId(int id)voidsetFetchSize(int count)voidsetMainString(java.lang.String sql)voidsetMaxRows(int count)voidsetNavigator(RowSetNavigator navigator)voidsetPreparedExecuteProperties(java.lang.Object[] parameterValues, int maxRows, int fetchSize, int resultProps, int timeout)For SQLEXECUTE results The parameters are set by this method as the Result is reusedvoidsetPreparedResultUpdateProperties(java.lang.Object[] parameterValues)For UPDATE_RESULT results The parameters are set by this method as the Result is reusedvoidsetPrepareOrExecuteProperties(java.lang.String sql, int maxRows, int fetchSize, int statementReturnType, int timeout, int resultSetProperties, int keyMode, int[] generatedIndexes, java.lang.String[] generatedNames)For both EXECDIRECT and PREPAREvoidsetResultId(long id)voidsetResultType(int type)voidsetSession(SessionInterface session)voidsetSessionId(long id)voidsetStatement(Statement statement)voidsetStatementID(long statementId)voidsetStatementType(int type)voidsetUpdateCount(int count)voidsetValueObject(java.lang.Object value)voidwrite(SessionInterface session, DataOutputStream dataOut, RowOutputInterface rowOut)
-
-
-
Field Detail
-
sessionAttributesMetaData
public static final ResultMetaData sessionAttributesMetaData
-
emptyGeneratedResult
public static final Result emptyGeneratedResult
-
updateZeroResult
public static final Result updateZeroResult
-
updateOneResult
public static final Result updateOneResult
-
mode
public byte mode
-
updateCount
public int updateCount
-
metaData
public ResultMetaData metaData
A Result object's metadata
-
parameterMetaData
public ResultMetaData parameterMetaData
Additional meta data for parameters used in PREPARE_ACK results
-
generatedMetaData
public ResultMetaData generatedMetaData
Additional meta data for required generated columns
-
rsProperties
public int rsProperties
-
queryTimeout
public int queryTimeout
-
valueData
public java.lang.Object valueData
-
statement
public Statement statement
-
navigator
public RowSetNavigator navigator
-
-
Method Detail
-
newResult
public static Result newResult(RowSetNavigator nav)
-
newResult
public static Result newResult(int type)
-
newResult
public static Result newResult(java.io.DataInput dataInput, RowInputBinary in) throws java.io.IOException, HsqlException
- Throws:
java.io.IOExceptionHsqlException
-
newResult
public static Result newResult(Session session, int mode, java.io.DataInput dataInput, RowInputBinary in) throws java.io.IOException, HsqlException
- Throws:
java.io.IOExceptionHsqlException
-
readAdditionalResults
public void readAdditionalResults(SessionInterface session, java.io.DataInputStream inputStream, RowInputBinary in) throws java.io.IOException, HsqlException
- Throws:
java.io.IOExceptionHsqlException
-
readLobResults
public void readLobResults(SessionInterface session, java.io.DataInputStream inputStream, RowInputBinary in) throws java.io.IOException, HsqlException
- Throws:
java.io.IOExceptionHsqlException
-
newPSMResult
public static Result newPSMResult(int type, java.lang.String label, java.lang.Object value)
For interval PSM return values
-
newPSMResult
public static Result newPSMResult(java.lang.Object value)
For interval PSM return values
-
newPrepareStatementRequest
public static Result newPrepareStatementRequest()
For SQLPREPARE For parparation of SQL parepared statements.
-
newPreparedExecuteRequest
public static Result newPreparedExecuteRequest(Type[] types, long statementId)
For SQLEXECUTE For execution of SQL prepared statements. The parameters are set afterwards as the Result is reused
-
newCallResponse
public static Result newCallResponse(Type[] types, long statementId, java.lang.Object[] values)
For CALL_RESPONSE For execution of SQL callable statements.
-
newUpdateResultRequest
public static Result newUpdateResultRequest(Type[] types, long id)
For UPDATE_RESULT The parameters are set afterwards as the Result is reused
-
setPreparedResultUpdateProperties
public void setPreparedResultUpdateProperties(java.lang.Object[] parameterValues)
For UPDATE_RESULT results The parameters are set by this method as the Result is reused
-
setPreparedExecuteProperties
public void setPreparedExecuteProperties(java.lang.Object[] parameterValues, int maxRows, int fetchSize, int resultProps, int timeout)For SQLEXECUTE results The parameters are set by this method as the Result is reused
-
setBatchedPreparedExecuteRequest
public void setBatchedPreparedExecuteRequest()
For BATCHEXECUTE
-
addBatchedPreparedExecuteRequest
public void addBatchedPreparedExecuteRequest(java.lang.Object[] parameterValues)
-
newBatchedExecuteRequest
public static Result newBatchedExecuteRequest()
For BATCHEXECDIRECT
-
newBatchedExecuteResponse
public static Result newBatchedExecuteResponse(int[] updateCounts, Result generatedResult, Result e)
For BATCHEXERESPONSE for a BATCHEXECUTE or BATCHEXECDIRECT
-
newResetSessionRequest
public static Result newResetSessionRequest()
-
newConnectionAttemptRequest
public static Result newConnectionAttemptRequest(java.lang.String user, java.lang.String password, java.lang.String database, java.lang.String zoneString, int timeZoneSeconds)
-
newConnectionAcknowledgeResponse
public static Result newConnectionAcknowledgeResponse(Database database, long sessionID, int databaseID)
-
newUpdateZeroResult
public static Result newUpdateZeroResult()
-
newUpdateCountResult
public static Result newUpdateCountResult(int count)
-
newUpdateCountResult
public static Result newUpdateCountResult(ResultMetaData meta, int count)
-
newSingleColumnResult
public static Result newSingleColumnResult(ResultMetaData meta)
-
newSingleColumnResult
public static Result newSingleColumnResult(java.lang.String colName)
-
newSingleColumnStringResult
public static Result newSingleColumnStringResult(java.lang.String colName, java.lang.String contents)
-
newFreeStmtRequest
public static Result newFreeStmtRequest(long statementID)
-
newExecuteDirectRequest
public static Result newExecuteDirectRequest()
For direct execution of SQL statements. The statement and other parameters are set afterwards as the Result is reused
-
setPrepareOrExecuteProperties
public void setPrepareOrExecuteProperties(java.lang.String sql, int maxRows, int fetchSize, int statementReturnType, int timeout, int resultSetProperties, int keyMode, int[] generatedIndexes, java.lang.String[] generatedNames)For both EXECDIRECT and PREPARE
-
newSetSavepointRequest
public static Result newSetSavepointRequest(java.lang.String name)
-
newRequestDataResult
public static Result newRequestDataResult(long id, int offset, int count)
-
newDataResult
public static Result newDataResult(ResultMetaData md)
-
newGeneratedDataResult
public static Result newGeneratedDataResult(ResultMetaData md)
-
getExecuteProperties
public int getExecuteProperties()
initially, only used for updatability
-
newDataHeadResult
public static Result newDataHeadResult(SessionInterface session, Result source, int offset, int count)
-
newDataRowsResult
public static Result newDataRowsResult(RowSetNavigator navigator)
-
newSessionAttributesResult
public static Result newSessionAttributesResult()
Result structure used for set/get session attributes
-
newWarningResult
public static Result newWarningResult(HsqlException w)
-
newErrorResult
public static Result newErrorResult(java.lang.Throwable t)
-
newErrorResult
public static Result newErrorResult(java.lang.Throwable t, java.lang.String statement)
-
write
public void write(SessionInterface session, DataOutputStream dataOut, RowOutputInterface rowOut) throws java.io.IOException, HsqlException
- Throws:
java.io.IOExceptionHsqlException
-
getType
public int getType()
-
isData
public boolean isData()
-
isError
public boolean isError()
-
isWarning
public boolean isWarning()
-
isUpdateCount
public boolean isUpdateCount()
-
isSimpleValue
public boolean isSimpleValue()
-
hasGeneratedKeys
public boolean hasGeneratedKeys()
-
getException
public HsqlException getException()
-
getStatementID
public long getStatementID()
-
setStatementID
public void setStatementID(long statementId)
-
getMainString
public java.lang.String getMainString()
-
setMainString
public void setMainString(java.lang.String sql)
-
getSubString
public java.lang.String getSubString()
-
getZoneString
public java.lang.String getZoneString()
-
getErrorCode
public int getErrorCode()
-
getValueObject
public java.lang.Object getValueObject()
-
setValueObject
public void setValueObject(java.lang.Object value)
-
getStatement
public Statement getStatement()
-
setStatement
public void setStatement(Statement statement)
-
getDatabaseName
public java.lang.String getDatabaseName()
-
setMaxRows
public void setMaxRows(int count)
-
getFetchSize
public int getFetchSize()
-
setFetchSize
public void setFetchSize(int count)
-
getUpdateCount
public int getUpdateCount()
-
getConnectionAttrType
public int getConnectionAttrType()
-
setConnectionAttrType
public void setConnectionAttrType(int type)
-
getActionType
public int getActionType()
-
setActionType
public void setActionType(int type)
-
getSessionId
public long getSessionId()
-
setSessionId
public void setSessionId(long id)
-
setSession
public void setSession(SessionInterface session)
-
getDatabaseId
public int getDatabaseId()
-
setDatabaseId
public void setDatabaseId(int id)
-
getResultId
public long getResultId()
-
setResultId
public void setResultId(long id)
-
setUpdateCount
public void setUpdateCount(int count)
-
setAsTransactionEndRequest
public void setAsTransactionEndRequest(int subType, java.lang.String savepoint)
-
getSingleRowData
public java.lang.Object[] getSingleRowData()
-
getParameterData
public java.lang.Object[] getParameterData()
-
getSessionAttributes
public java.lang.Object[] getSessionAttributes()
-
setResultType
public void setResultType(int type)
-
setStatementType
public void setStatementType(int type)
-
getStatementType
public int getStatementType()
-
getGeneratedResultType
public int getGeneratedResultType()
-
getGeneratedResultMetaData
public ResultMetaData getGeneratedResultMetaData()
-
getChainedResult
public Result getChainedResult()
-
getUnlinkChainedResult
public Result getUnlinkChainedResult()
-
addChainedResult
public void addChainedResult(Result result)
-
addWarnings
public void addWarnings(HsqlException[] warnings)
-
getLobCount
public int getLobCount()
-
getLOBResult
public ResultLob getLOBResult()
-
addLobResult
public void addLobResult(ResultLob result)
-
clearLobResults
public void clearLobResults()
-
getNavigator
public RowSetNavigator getNavigator()
-
setNavigator
public void setNavigator(RowSetNavigator navigator)
-
initialiseNavigator
public RowSetNavigator initialiseNavigator()
-
-
DataMelt 3.0 © DataMelt by jWork.ORG