Top Description Fields Constructors Methods
org.hsqldb.result

public Class Result

extends Object
Class Inheritance
Known Direct Subclasses
org.hsqldb.result.ResultLob
Imports
java.io.DataInput, .DataInputStream, .IOException, .LineNumberReader, .StringReader, org.hsqldb.ColumnBase, .HsqlException, .Session, .SessionInterface, .SessionInterface.AttributePos, .SqlInvariants, .Statement, org.hsqldb.error.Error, .ErrorCode, org.hsqldb.lib.ArrayUtil, .DataOutputStream, .List, org.hsqldb.map.ValuePool, org.hsqldb.navigator.RowSetNavigator, .RowSetNavigatorClient, org.hsqldb.rowio.RowInputInterface, .RowOutputInterface, org.hsqldb.types.Charset, .Collation, .Type

The 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 communicating all such requests and responses across the network. Uses a navigator for data.
Authors
Campbell Burnet (campbell-burnet@users dot sourceforge.net), Fred Toussi (fredt@users dot sourceforge.net)
Since
1.9.0
Version
2.7.4

Field Summary

Modifier and TypeField and Description
private Result
pack-priv int
private String
public static final Result[]
public static final Result
private static final ResultMetaData
pack-priv int
private HsqlException
private int
public ResultMetaData
generatedMetaData

Additional meta data for required generated columns

pack-priv int
private long
private int
pack-priv ResultLob
private String
public ResultMetaData
metaData

A Result object's metadata

public byte
public ResultMetaData
parameterMetaData

Additional meta data for parameters used in PREPARE_ACK results

public int
public int
public static final ResultMetaData
pack-priv long
public Statement
pack-priv long
pack-priv int
private String
public int
public static final Result
public static final Result
public Object
private String

Constructor Summary

AccessConstructor and Description
pack-priv
Result(int mode)

public
Result(int mode, int count)

Method Summary

Modifier and TypeMethod and Description
public void
public void
public void
public void
addRows(List<String> sqlArray)

public void
public void
public int
public Result
public int
public int
public String
public int
public HsqlException
public int
getExecuteProperties()

initially, only used for updatability

public int
public ResultMetaData
public int
public int
public ResultLob
public String
public RowSetNavigator
public Object[]
public long
public Object[]
public long
public int
public Object[]
public Statement
public long
public int
public String
public int
public Result
public int
public Object
public String
public boolean
public RowSetNavigator
public boolean
public boolean
public boolean
public boolean
public boolean
public static Result
newBatchedExecuteRequest()

For BATCHEXECDIRECT

public static Result
newBatchedExecuteResponse(int[] updateCounts, Result generatedResult, Result e)

For BATCHEXERESPONSE for a BATCHEXECUTE or BATCHEXECDIRECT

public static Result
newCallResponse(Type[] types, long statementId, Object[] values)

For CALL_RESPONSE For execution of SQL callable statements.

public static Result
newCancelRequest(int randomId, long statementId, String sql)

public static Result
public static Result
newConnectionAttemptRequest(String user, String password, String database, String zoneString, int timeZoneSeconds)

public static Result
newDataHeadResult(SessionInterface session, Result source, int offset, int count)

public static Result
public static Result
newDataRowsResult(Result source, int offset, int count)

public static Result
public static Result
public static Result
public static Result
newExecuteDirectRequest()

For direct execution of SQL statements.

public static Result
newFreeStmtRequest(long statementID)

public static Result
public static Result
newMultiColumnResult(String[] names, Type[] types)

public static Result
newPreparedExecuteRequest(Type[] types, long statementId)

For SQLEXECUTE For execution of SQL prepared statements.

public static Result
public static Result
newPrepareStatementRequest()

For SQLPREPARE For preparation of SQL prepared statements.

public static Result
newPSMResult(int type, String label, Object value)

For interval PSM return values

public static Result
newPSMResult(Object value)

For interval PSM return values

public static Result
newRequestDataResult(long id, int offset, int count)

public static Result
public static Result
public static Result
newResult(int type)

public static Result
public static Result
newResult(Session session, int mode, DataInputStream dataInput, RowInputInterface in)

private static Result
newResult(Session session, DataInput dataInput, RowInputInterface in, int mode)

public static Result
newSessionAttributesResult()

Result structure used for set/get session attributes

public static Result
public static Result
public static Result
public static Result
public static Result
public static Result
public static Result
newUpdateResultRequest(Type[] types, long id)

For UPDATE_RESULT The parameters are set afterwards as the Result is reused

public static Result
public static Result
public void
public Result
readLobResults(Session session, DataInputStream inputStream)

private static Object[]
public void
setActionType(int type)

public void
setAsTransactionEndRequest(int subType, String savepoint)

public void
public void
public void
setDatabaseId(int id)

public void
setFetchSize(int count)

public void
public void
setMaxRows(int count)

public void
public void
setPreparedExecuteProperties(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

public void
setPreparedResultUpdateProperties(Object[] parameterValues)

For UPDATE_RESULT results The parameters are set by this method as the Result is reused

public void
setPrepareOrExecuteProperties(String sql, int maxRows, int fetchSize, int statementReturnType, int timeout, int resultSetProperties, int keyMode, int[] generatedIndexes, String[] generatedNames)

For both EXECDIRECT and PREPARE

public void
setResultId(long id)

public void
setResultType(int type)

public void
public void
setSessionId(long id)

public void
public void
public void
setStatementID(long statementId)

public void
setStatementType(int type)

public void
setUpdateCount(int count)

public void
public void
private static void
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

chainedResultback to summary
private Result chainedResult
databaseIDback to summary
pack-priv int databaseID
databaseNameback to summary
private String databaseName
emptyArrayback to summary
public static final Result[] emptyArray
emptyGeneratedResultback to summary
public static final Result emptyGeneratedResult
emptyMetaback to summary
private static final ResultMetaData emptyMeta
errorCodeback to summary
pack-priv int errorCode
exceptionback to summary
private HsqlException exception
fetchSizeback to summary
private int fetchSize
generatedMetaDataback to summary
public ResultMetaData generatedMetaData

Additional meta data for required generated columns

generateKeysback to summary
pack-priv int generateKeys
idback to summary
private long id
lobCountback to summary
private int lobCount
lobResultsback to summary
pack-priv ResultLob lobResults
mainStringback to summary
private String mainString
metaDataback to summary
public ResultMetaData metaData

A Result object's metadata

modeback to summary
public byte mode
parameterMetaDataback to summary
public ResultMetaData parameterMetaData

Additional meta data for parameters used in PREPARE_ACK results

queryTimeoutback to summary
public int queryTimeout
rsPropertiesback to summary
public int rsProperties
sessionAttributesMetaDataback to summary
public static final ResultMetaData sessionAttributesMetaData
sessionIDback to summary
pack-priv long sessionID
statementback to summary
public Statement statement
statementIDback to summary
pack-priv long statementID
statementReturnTypeback to summary
pack-priv int statementReturnType
subStringback to summary
private String subString
updateCountback to summary
public int updateCount
updateOneResultback to summary
public static final Result updateOneResult
updateZeroResultback to summary
public static final Result updateZeroResult
valueDataback to summary
public Object valueData
zoneStringback to summary
private String zoneString

Constructor Detail

Resultback to summary
pack-priv Result(int mode)
Resultback to summary
public Result(int mode, int count)

Method Detail

addBatchedPreparedExecuteRequestback to summary
public void addBatchedPreparedExecuteRequest(Object[] parameterValues)
addChainedResultback to summary
public void addChainedResult(Result result)
addLobResultback to summary
public void addLobResult(ResultLob result)
addRowsback to summary
public void addRows(List<String> sqlArray)
addWarningsback to summary
public void addWarnings(HsqlException[] warnings)
clearLobResultsback to summary
public void clearLobResults()
getActionTypeback to summary
public int getActionType()
getChainedResultback to summary
public Result getChainedResult()
getConnectionAttrTypeback to summary
public int getConnectionAttrType()
getDatabaseIdback to summary
public int getDatabaseId()
getDatabaseNameback to summary
public String getDatabaseName()
getErrorCodeback to summary
public int getErrorCode()
getExceptionback to summary
public HsqlException getException()
getExecutePropertiesback to summary
public int getExecuteProperties()

initially, only used for updatability

getFetchSizeback to summary
public int getFetchSize()
getGeneratedResultMetaDataback to summary
public ResultMetaData getGeneratedResultMetaData()
getGeneratedResultTypeback to summary
public int getGeneratedResultType()
getLobCountback to summary
public int getLobCount()
getLOBResultback to summary
public ResultLob getLOBResult()
getMainStringback to summary
public String getMainString()
getNavigatorback to summary
public RowSetNavigator getNavigator()
getParameterDataback to summary
public Object[] getParameterData()
getResultIdback to summary
public long getResultId()
getSessionAttributesback to summary
public Object[] getSessionAttributes()
getSessionIdback to summary
public long getSessionId()
getSessionRandomIDback to summary
public int getSessionRandomID()
getSingleRowDataback to summary
public Object[] getSingleRowData()
getStatementback to summary
public Statement getStatement()
getStatementIDback to summary
public long getStatementID()
getStatementTypeback to summary
public int getStatementType()
getSubStringback to summary
public String getSubString()
getTypeback to summary
public int getType()
getUnlinkChainedResultback to summary
public Result getUnlinkChainedResult()
getUpdateCountback to summary
public int getUpdateCount()
getValueObjectback to summary
public Object getValueObject()
getZoneStringback to summary
public String getZoneString()
hasGeneratedKeysback to summary
public boolean hasGeneratedKeys()
initialiseNavigatorback to summary
public RowSetNavigator initialiseNavigator()
isDataback to summary
public boolean isData()
isErrorback to summary
public boolean isError()
isSimpleValueback to summary
public boolean isSimpleValue()
isUpdateCountback to summary
public boolean isUpdateCount()
isWarningback to summary
public boolean isWarning()
newBatchedExecuteRequestback to summary
public static Result newBatchedExecuteRequest()

For BATCHEXECDIRECT

newBatchedExecuteResponseback to summary
public static Result newBatchedExecuteResponse(int[] updateCounts, Result generatedResult, Result e)

For BATCHEXERESPONSE for a BATCHEXECUTE or BATCHEXECDIRECT

newCallResponseback to summary
public static Result newCallResponse(Type[] types, long statementId, Object[] values)

For CALL_RESPONSE For execution of SQL callable statements.

newCancelRequestback to summary
public static Result newCancelRequest(int randomId, long statementId, String sql)
newConnectionAcknowledgeResponseback to summary
public static Result newConnectionAcknowledgeResponse(Session session)
newConnectionAttemptRequestback to summary
public static Result newConnectionAttemptRequest(String user, String password, String database, String zoneString, int timeZoneSeconds)
newDataHeadResultback to summary
public static Result newDataHeadResult(SessionInterface session, Result source, int offset, int count)
newDataResultback to summary
public static Result newDataResult(ResultMetaData md)
newDataRowsResultback to summary
public static Result newDataRowsResult(Result source, int offset, int count)
newDataRowsResultback to summary
public static Result newDataRowsResult(RowSetNavigator navigator)
newErrorResultback to summary
public static Result newErrorResult(Throwable t)
newErrorResultback to summary
public static Result newErrorResult(Throwable t, String statement)
newExecuteDirectRequestback to summary
public static Result newExecuteDirectRequest()

For direct execution of SQL statements. The statement and other parameters are set afterwards as the Result is reused

newFreeStmtRequestback to summary
public static Result newFreeStmtRequest(long statementID)
newGeneratedDataResultback to summary
public static Result newGeneratedDataResult(ResultMetaData md)
newMultiColumnResultback to summary
public static Result newMultiColumnResult(String[] names, Type[] types)
newPreparedExecuteRequestback to summary
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

newPrepareResponseback to summary
public static Result newPrepareResponse(Statement statement)
newPrepareStatementRequestback to summary
public static Result newPrepareStatementRequest()

For SQLPREPARE For preparation of SQL prepared statements.

newPSMResultback to summary
public static Result newPSMResult(int type, String label, Object value)

For interval PSM return values

newPSMResultback to summary
public static Result newPSMResult(Object value)

For interval PSM return values

newRequestDataResultback to summary
public static Result newRequestDataResult(long id, int offset, int count)
newResetSessionRequestback to summary
public static Result newResetSessionRequest()
newResultback to summary
public static Result newResult(RowSetNavigator nav)
newResultback to summary
public static Result newResult(int type)
newResultback to summary
public static Result newResult(DataInputStream dataInput, RowInputInterface in) throws IOException
newResultback to summary
public static Result newResult(Session session, int mode, DataInputStream dataInput, RowInputInterface in)
newResultback to summary
private static Result newResult(Session session, DataInput dataInput, RowInputInterface in, int mode) throws IOException
newSessionAttributesResultback to summary
public static Result newSessionAttributesResult()

Result structure used for set/get session attributes

newSetSavepointRequestback to summary
public static Result newSetSavepointRequest(String name)
newSingleColumnResultback to summary
public static Result newSingleColumnResult(ResultMetaData meta)
newSingleColumnResultback to summary
public static Result newSingleColumnResult(String colName)
newSingleColumnStringResultback to summary
public static Result newSingleColumnStringResult(String colName, String contents)
newUpdateCountResultback to summary
public static Result newUpdateCountResult(int count)
newUpdateCountResultback to summary
public static Result newUpdateCountResult(ResultMetaData meta, int count)
newUpdateResultRequestback to summary
public static Result newUpdateResultRequest(Type[] types, long id)

For UPDATE_RESULT The parameters are set afterwards as the Result is reused

newUpdateZeroResultback to summary
public static Result newUpdateZeroResult()
newWarningResultback to summary
public static Result newWarningResult(HsqlException w)
readAdditionalResultsback to summary
public void readAdditionalResults(SessionInterface session, DataInputStream inputStream, RowInputInterface in) throws IOException
readLobResultsback to summary
public Result readLobResults(Session session, DataInputStream inputStream) throws IOException
readSimpleback to summary
private static Object[] readSimple(RowInputInterface in, ResultMetaData meta)
setActionTypeback to summary
public void setActionType(int type)
setAsTransactionEndRequestback to summary
public void setAsTransactionEndRequest(int subType, String savepoint)
setBatchedPreparedExecuteRequestback to summary
public void setBatchedPreparedExecuteRequest()

For BATCHEXECUTE

setConnectionAttrTypeback to summary
public void setConnectionAttrType(int type)
setDatabaseIdback to summary
public void setDatabaseId(int id)
setFetchSizeback to summary
public void setFetchSize(int count)
setMainStringback to summary
public void setMainString(String sql)
setMaxRowsback to summary
public void setMaxRows(int count)
setNavigatorback to summary
public void setNavigator(RowSetNavigator navigator)
setPreparedExecutePropertiesback to summary
public void setPreparedExecuteProperties(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

setPreparedResultUpdatePropertiesback to summary
public void setPreparedResultUpdateProperties(Object[] parameterValues)

For UPDATE_RESULT results The parameters are set by this method as the Result is reused

setPrepareOrExecutePropertiesback to summary
public void setPrepareOrExecuteProperties(String sql, int maxRows, int fetchSize, int statementReturnType, int timeout, int resultSetProperties, int keyMode, int[] generatedIndexes, String[] generatedNames)

For both EXECDIRECT and PREPARE

setResultIdback to summary
public void setResultId(long id)
setResultTypeback to summary
public void setResultType(int type)
setSessionback to summary
public void setSession(SessionInterface session)
setSessionIdback to summary
public void setSessionId(long id)
setSessionRandomIDback to summary
public void setSessionRandomID(int id)
setStatementback to summary
public void setStatement(Statement statement)
setStatementIDback to summary
public void setStatementID(long statementId)
setStatementTypeback to summary
public void setStatementType(int type)
setUpdateCountback to summary
public void setUpdateCount(int count)
setValueObjectback to summary
public void setValueObject(Object value)
writeback to summary
public void write(SessionInterface session, DataOutputStream dataOut, RowOutputInterface rowOut) throws IOException
writeSimpleback to summary
private static void writeSimple(RowOutputInterface out, ResultMetaData meta, Object[] data)