- All Implemented Interfaces:
AutoCloseable,FbStatement,ExceptionListenable
- Direct Known Subclasses:
AbstractFbWireStatement
- Since:
- 3.0
- Author:
- Mark Rotteveel
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final ExceptionListenerDispatcherprotected final StatementListenerDispatcher -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionfinal voidaddExceptionListener(ExceptionListener listener) Adds an exception listener to this object.final voidaddStatementListener(StatementListener statementListener) Registers aStatementListener.voidaddWeakStatementListener(StatementListener statementListener) Adds aStatementListenerinstance to this database using a weak reference.voidasyncFetchRows(int fetchSize) Requests the server to perform an asynchronous fetch forfetch size.protected final voidcheckFetchSize(int fetchSize) Validates iffetchSizeis positive, otherwise throws an exception.protected final StatementStateChecks if prepare is allowed, returning the current statement state.protected final voidChecks if statement is valid withcheckStatementValid()and then checks if the current statement state has an open cursor.protected final voidChecks if this statement is not inStatementState.CLOSED,StatementState.CLOSING,StatementState.NEWorStatementState.ERROR, and throws anSQLExceptionif it is.protected final voidcheckStatementValid(StatementState ignoreState) Performs the same check ascheckStatementValid(), but considersignoreStateas valid.voidclose()Close and deallocate this statement.final voidCloses the cursor associated with this statement, leaving the statement itself allocated.final voidcloseCursor(boolean transactionEnd) Closes the cursor associated with this statement, leaving the statement itself allocated.protected ExecutionPlanProcessorprotected SqlCountProcessorfinal voidensureClosedCursor(boolean transactionEnd) Ensures that the statement cursor is closed.final voidfetchScroll(FetchType fetchType, int fetchSize, int position) Requests this statement to fetch rows using the specified fetch type.protected voidfetchScrollImpl(FetchType fetchType, int fetchSize, int position) Implementation offetchScroll(FetchType, int, int).protected voidforceState(StatementState newState) Forces the statement to the specified state without throwing an exception if this is not a valid transition.protected abstract voidfree(int option) Frees the currently allocated statement.protected longfinal byte[]getCursorInfo(byte[] requestItems, int bufferLength) Request cursor info.final <T> TgetCursorInfo(byte[] requestItems, int bufferLength, InfoProcessor<T> infoProcessor) Request cursor info.protected byte[]getCursorInfoImpl(byte[] requestItems, int bufferLength) Implementation ofgetCursorInfo(byte[], int).protected final StringGets the cursor name.final Stringfinal Stringbyte[]final RowDescriptorfinal RowDescriptorRetrieves the SQL counts for the last execution of this statement.final <T> TgetSqlInfo(byte[] requestItems, int bufferLength, InfoProcessor<T> infoProcessor) Request statement info.final StatementStategetState()byte[]protected final WarningMessageCallbacklongGets the current statement timeout for this statement.protected final TransactionListenerGets theTransactionListenerinstance for this statement.final StatementTypegetType()final booleanHas at least one fetch been executed on the current cursor?protected final booleanprotected final booleanprotected final booleanprotected final booleanprotected booleanisPrepareAllowed(StatementState state) Is a call toFbStatement.prepare(String)allowed for the suppliedStatementState.protected abstract booleanisValidTransactionClass(Class<? extends FbTransaction> transactionClass) Method to decide if a transaction implementation class is valid for the statement implementation.protected voidparseStatementInfo(byte[] statementInfoResponse) Parse the statement info response instatementInfoResponse.protected final voidqueueRowData(RowValue rowData) Queues row data for consumptionfinal voidremoveExceptionListener(ExceptionListener listener) Removes an exception listener to this object.final voidremoveStatementListener(StatementListener statementListener) Removes aStatementListener.protected final voidreset()Reset statement state, equivalent to callingreset(boolean)withfalse.protected voidreset(boolean resetAll) Resets the statement for next execution.protected final voidresetAll()Reset statement state and clear parameter description, equivalent to callingreset(boolean)withtrue.protected final voidMarks the cursor position as after-last.protected final voidMarks the cursor position as before-first.final voidsetCursorName(String cursorName) Sets the named cursor name for this statement.protected abstract voidsetCursorNameImpl(String cursorName) Implementation ofsetCursorName(String).protected voidsetParameterDescriptor(RowDescriptor parameterDescriptor) Sets the parameter descriptor.protected voidsetRowDescriptor(RowDescriptor rowDescriptor) Sets the (result set) row descriptor.voidsetTimeout(long statementTimeout) Sets the statement timeout.final voidsetTransaction(FbTransaction newTransaction) Associates a transaction with this statementprotected voidsetType(StatementType type) Sets the StatementTypeprotected final OperationCloseHandleprotected final OperationCloseHandleprotected final OperationCloseHandleSignals the start of an execute for this statement.protected final OperationCloseHandleSignals the start of a fetch for this statement.protected final voidswitchState(StatementState newState) Sets the StatementState.voidAttempts to unprepare the currently prepared statement.final voidvalidateParameters(RowValue parameters) Validates if the number of parameters matches the expected number and types, and if all values have been set.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.firebirdsql.gds.ng.FbStatement
batchCancel, batchExecute, clearCursorFlag, createBatchParameterBuffer, deferredBatchCreate, deferredBatchRelease, deferredBatchSend, emptyRowDescriptor, execute, fetchRows, getDatabase, getDefaultSqlInfoSize, getHandle, getMaxSqlInfoSize, getSqlInfo, isCursorFlagSet, prepare, setCursorFlag, supportBatchUpdates, supportsCursorInfo, supportsFetchScroll, withLock
-
Field Details
-
statementListenerDispatcher
-
exceptionListenerDispatcher
-
-
Constructor Details
-
AbstractFbStatement
protected AbstractFbStatement()
-
-
Method Details
-
getTransactionListener
Gets theTransactionListenerinstance for this statement.This method should only be called by this object itself. Subclasses may provide their own transaction listener, but the instance returned by this method should be the same for the lifetime of this
FbStatement.- Returns:
- The transaction listener instance for this statement.
-
getStatementWarningCallback
-
asyncFetchRows
Description copied from interface:FbStatementRequests the server to perform an asynchronous fetch forfetch size.Asynchronous fetching is an optional feature. If an implementation does not support asynchronous fetching, it should return immediately and do nothing. Although this interface provides a default implementation which does nothing, implementations should override it, to throw an exception when called on a closed statement.
For implementations which do support async fetching, this call should not do anything if one of the following is true:
- an asynchronous fetch is already pending
fetchSizeis1or the statement has a cursor name set- the current statement has a scrollable cursor (flag
CURSOR_TYPE_SCROLLABLEset) - the connection property
asyncFetchisfalse
An asynchronous fetch can be completed explicitly by calling
FbStatement.fetchRows(int), or implicitly by other network operations.- Specified by:
asyncFetchRowsin interfaceFbStatement- Parameters:
fetchSize- number of rows to fetch (must be greater than0)- Throws:
SQLException- for database access errors, when called on a closed statement, when no cursor is open or when the fetch size is not greater than0- See Also:
-
hasFetched
public final boolean hasFetched()Description copied from interface:FbStatementHas at least one fetch been executed on the current cursor?- Specified by:
hasFetchedin interfaceFbStatement- Returns:
trueif at least one fetch has been executed on the current cursor,falseotherwise (including if nothing has been executed, or the current statement has no cursor)
-
checkFetchSize
Validates iffetchSizeis positive, otherwise throws an exception.- Parameters:
fetchSize- fetch size (must be positive)- Throws:
SQLException- iffetchSizeis smaller than1- Since:
- 6
-
close
Description copied from interface:FbStatementClose and deallocate this statement.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceFbStatement- Throws:
SQLException
-
closeCursor
Description copied from interface:FbStatementCloses the cursor associated with this statement, leaving the statement itself allocated.Equivalent to calling
FbStatement.closeCursor(boolean)withfalse.- Specified by:
closeCursorin interfaceFbStatement- Throws:
SQLException
-
closeCursor
Description copied from interface:FbStatementCloses the cursor associated with this statement, leaving the statement itself allocated.When this method is called in preparation of a commit, rollback or another operation which will close the cursor (see
transactionEnd), then implementations may opt to not close the cursor on the server as the server closes the cursor automatically, or the statement as a whole is closed by the implementation.- Specified by:
closeCursorin interfaceFbStatement- Parameters:
transactionEnd- close is in response to a transaction end or another operation which will implicitly close the cursor- Throws:
SQLException
-
ensureClosedCursor
Description copied from interface:FbStatementEnsures that the statement cursor is closed. Resets a statement, so it is ready to be reused for re-execute or prepare.- Specified by:
ensureClosedCursorin interfaceFbStatement- Parameters:
transactionEnd- Close is in response to a transaction end- Throws:
SQLException- If this statement is closed or the cursor could not be closed.
-
unprepare
Description copied from interface:FbStatementAttempts to unprepare the currently prepared statement.For Firebird versions that do not support
DSQL_unprepare, the implementation should attempt to close the cursor (usingFbStatement.closeCursor()).- Specified by:
unpreparein interfaceFbStatement- Throws:
SQLException- If a database access error occurs
-
getState
- Specified by:
getStatein interfaceFbStatement- Returns:
- The current state of this statement
-
switchState
Sets the StatementState.- Parameters:
newState- New state- Throws:
SQLException- When the state is changed to an illegal next state
-
forceState
Forces the statement to the specified state without throwing an exception if this is not a valid transition.Does nothing if current state is CLOSED.
- Parameters:
newState- New state- See Also:
-
getType
- Specified by:
getTypein interfaceFbStatement- Returns:
- The statement type
-
setType
Sets the StatementType- Parameters:
type- New type
-
queueRowData
Queues row data for consumption- Parameters:
rowData- Row data
-
setBeforeFirst
protected final void setBeforeFirst()Marks the cursor position as before-first.All registered
StatementListenerinstances are notified for theStatementListener.beforeFirst(FbStatement)event. -
isBeforeFirst
protected final boolean isBeforeFirst() -
setAfterLast
protected final void setAfterLast()Marks the cursor position as after-last.All registered
StatementListenerinstances are notified for theStatementListener.afterLast(FbStatement)event. -
isAfterLast
protected final boolean isAfterLast() -
reset
protected final void reset()Reset statement state, equivalent to callingreset(boolean)withfalse. -
resetAll
protected final void resetAll()Reset statement state and clear parameter description, equivalent to callingreset(boolean)withtrue. -
reset
protected void reset(boolean resetAll) Resets the statement for next execution. Implementation in derived class must lock onFbStatement.withLock()and callsuper.reset(resetAll)- Parameters:
resetAll- Also reset field and parameter info
-
isPrepareAllowed
Is a call toFbStatement.prepare(String)allowed for the suppliedStatementState.- Parameters:
state- The statement state- Returns:
truecall toprepareis allowed
-
checkPrepareAllowed
Checks if prepare is allowed, returning the current statement state.This method checks if the current transaction is active, and if the current statement state allows preparing a new statement.
- Returns:
- statement state
- Throws:
SQLException- if there is no active transaction, or the current state does not allow statement prepare- Since:
- 6
-
getParameterDescriptor
- Specified by:
getParameterDescriptorin interfaceFbStatement- Returns:
- descriptor of the parameters of this statement
-
setParameterDescriptor
Sets the parameter descriptor.- Parameters:
parameterDescriptor- Parameter descriptor
-
getRowDescriptor
- Specified by:
getRowDescriptorin interfaceFbStatement- Returns:
- descriptor of the row returned by this statement
-
setRowDescriptor
Sets the (result set) row descriptor.- Parameters:
rowDescriptor- Row descriptor
-
getStatementInfoRequestItems
public byte[] getStatementInfoRequestItems()- Returns:
- The (full) statement info request items.
- See Also:
-
getParameterDescriptionInfoRequestItems
public byte[] getParameterDescriptionInfoRequestItems()- Returns:
- The
isc_info_sql_describe_varsinfo request items. - See Also:
-
fetchScroll
Description copied from interface:FbStatementRequests this statement to fetch rows using the specified fetch type.The default implementation only supports
FetchType.NEXTby redirecting toFbStatement.fetchRows(int)and throws anSQLFeatureNotSupportedfor other types.The caller is responsible for tracking and correcting for server-side positional state, taking into account any rows already fetched. For example, if 100 rows have been fetched with
NEXTorPRIOR, and 80 rows are still in the local buffer, the server-side position is actually 80 rows ahead (or behind). The next fetch withRELATIVEwill need to correct this inposition, and aPRIORafter aNEXTor aNEXTafter aPRIORwill need to reposition withRELATIVEorABSOLUTE, or know how many rows to ignore from the fetched batch.If an asynchronous fetch is pending, the behaviour depends on the value of
fetchType: ifFetchType.NEXT, the fetch should be completed instead of performing a new fetch. For any other value, aSQLExceptionshould be thrown. GivenFbStatement.asyncFetchRows(int)should be a no-op for scrollable cursors, this should not normally happen.- Specified by:
fetchScrollin interfaceFbStatement- Parameters:
fetchType- Fetch typefetchSize- Number of rows to fetch (must be> 0) (ignored by server for types other thanFetchType.NEXTandFetchType.PRIOR)position- Absolute or relative position for the row to fetch (ignored by server for types other thanFetchType.ABSOLUTEandFetchType.RELATIVE)- Throws:
SQLFeatureNotSupportedException- For types other thanFetchType.NEXTif the protocol version or the implementation does not support scroll fetchSQLException- For database access errors, when called on a closed statement, when no cursor is open, when an async fetch is pending andfetchTypeis notNEXT, or for server-side error conditions- See Also:
-
fetchScrollImpl
protected void fetchScrollImpl(FetchType fetchType, int fetchSize, int position) throws SQLException Implementation offetchScroll(FetchType, int, int).An implementation should not notify
exceptionListenerDispatcher, as that is already handled infetchScroll(FetchType, int, int).The implementation of
fetchScroll(FetchType, int, int)redirectsFetchType.NEXTtoFbStatement.fetchRows(int). The implementation does need to handleNEXT, but only when actually implementing the other scroll direction.- Throws:
SQLFeatureNotSupportedException- If the protocol version or the implementation does not support scroll fetch (even forNEXT)SQLException- For database access errors, when called on a closed statement, when no cursor is open, or for serverside error conditions- See Also:
-
getSqlInfo
public final <T> T getSqlInfo(byte[] requestItems, int bufferLength, InfoProcessor<T> infoProcessor) throws SQLException Request statement info.- Specified by:
getSqlInfoin interfaceFbStatement- Parameters:
requestItems- Array of info items to requestbufferLength- Response buffer length to useinfoProcessor- Implementation ofInfoProcessorto transform the info response- Returns:
- Transformed info response of type T
- Throws:
SQLException- For errors retrieving or transforming the response.
-
getCursorInfo
public final <T> T getCursorInfo(byte[] requestItems, int bufferLength, InfoProcessor<T> infoProcessor) throws SQLException Description copied from interface:FbStatementRequest cursor info.- Specified by:
getCursorInfoin interfaceFbStatement- Parameters:
requestItems- Array of info items to requestbufferLength- Response buffer length to useinfoProcessor- Implementation ofInfoProcessorto transform the info response- Returns:
- Transformed info response of type T
- Throws:
SQLException- For errors retrieving or transforming the responseSQLFeatureNotSupportedException- If requesting cursor info is not supported (Firebird 4.0 or earlier, or native implementation)- See Also:
-
getCursorInfo
Description copied from interface:FbStatementRequest cursor info.- Specified by:
getCursorInfoin interfaceFbStatement- Parameters:
requestItems- Array of info items to requestbufferLength- Response buffer length to use- Returns:
- Response buffer
- Throws:
SQLException- For errors retrieving or transforming the responseSQLFeatureNotSupportedException- If requesting cursor info is not supported (Firebird 4.0 or earlier, or native implementation)
-
getCursorInfoImpl
Implementation ofgetCursorInfo(byte[], int).An implementation should not notify
exceptionListenerDispatcher, as that is already handled ingetCursorInfo(byte[], int).- Throws:
SQLException- For errors retrieving or transforming the responseSQLFeatureNotSupportedException- If requesting cursor info is not supported (Firebird 4.0 or earlier, or native implementation)- See Also:
-
getExecutionPlan
- Specified by:
getExecutionPlanin interfaceFbStatement- Returns:
- The execution plan of the currently prepared statement
- Throws:
SQLException- If this statement is closed.
-
getExplainedExecutionPlan
- Specified by:
getExplainedExecutionPlanin interfaceFbStatement- Returns:
- The detailed execution plan of the currently prepared statement
- Throws:
SQLException- If this statement is closed.
-
createExecutionPlanProcessor
- Returns:
- New instance of
ExecutionPlanProcessor(or subclass) for this statement.
-
getSqlCounts
Description copied from interface:FbStatementRetrieves the SQL counts for the last execution of this statement.The retrieved SQL counts are also notified to all registered
StatementListeners.In general the
FbStatementwill (should) retrieve and notify listeners of the SQL counts automatically at times where it is relevant (eg after executing a statement that does not produce multiple rows, or after fetching all rows).- Specified by:
getSqlCountsin interfaceFbStatement- Returns:
- The SQL counts of the last execution of this statement
- Throws:
SQLException- If this statement is closed, or if this statement is in stateStatementState.CURSOR_OPENand not all rows have been fetched.
-
createSqlCountProcessor
- Returns:
- New instance of
SqlCountProcessor(or subclass) for this statement.
-
free
Frees the currently allocated statement. Either close the cursor withISCConstants.DSQL_closeor drop the statement handle usingISCConstants.DSQL_drop.- Parameters:
option- Free option- Throws:
SQLException
-
validateParameters
Description copied from interface:FbStatementValidates if the number of parameters matches the expected number and types, and if all values have been set.- Specified by:
validateParametersin interfaceFbStatement- Parameters:
parameters- Parameter values to validate- Throws:
SQLException- When the number or type of parameters does not matchFbStatement.getParameterDescriptor(), or when a parameter has not been set.
-
addStatementListener
Description copied from interface:FbStatementRegisters aStatementListener.- Specified by:
addStatementListenerin interfaceFbStatement- Parameters:
statementListener- The statement listener
-
addWeakStatementListener
Description copied from interface:FbStatementAdds aStatementListenerinstance to this database using a weak reference.If the listener is already strongly referenced, this call will be ignored
- Specified by:
addWeakStatementListenerin interfaceFbStatement- Parameters:
statementListener- statement listener
-
removeStatementListener
Description copied from interface:FbStatementRemoves aStatementListener.- Specified by:
removeStatementListenerin interfaceFbStatement- Parameters:
statementListener- The statement listener
-
addExceptionListener
Description copied from interface:ExceptionListenableAdds an exception listener to this object.Implementations use
WeakReference.- Specified by:
addExceptionListenerin interfaceExceptionListenable- Parameters:
listener- Listener to register
-
removeExceptionListener
Description copied from interface:ExceptionListenableRemoves an exception listener to this object.- Specified by:
removeExceptionListenerin interfaceExceptionListenable- Parameters:
listener- Listener to remove
-
checkStatementValid
Checks if this statement is not inStatementState.CLOSED,StatementState.CLOSING,StatementState.NEWorStatementState.ERROR, and throws anSQLExceptionif it is.- Throws:
SQLException- when this statement is closed or in error state
-
checkStatementValid
Performs the same check ascheckStatementValid(), but considersignoreStateas valid.- Parameters:
ignoreState- the invalid state (seecheckStatementValid()to ignore- Throws:
SQLException- when this statement is closed or in error state
-
checkStatementHasOpenCursor
Checks if statement is valid withcheckStatementValid()and then checks if the current statement state has an open cursor.- Throws:
SQLException- when this statement is closed or in error state, or has no open cursor- Since:
- 6
-
getTransaction
- Specified by:
getTransactionin interfaceFbStatement- Returns:
- Transaction currently associated with this statement
-
isValidTransactionClass
Method to decide if a transaction implementation class is valid for the statement implementation.Eg a
V10Statementwill only work with anFbWireTransactionimplementation.- Parameters:
transactionClass- Class of the transaction- Returns:
truewhen the transaction class is valid for the statement implementation.
-
setTransaction
Description copied from interface:FbStatementAssociates a transaction with this statement- Specified by:
setTransactionin interfaceFbStatement- Parameters:
newTransaction- The transaction- Throws:
SQLException
-
setTimeout
Description copied from interface:FbStatementSets the statement timeout.The statement timeout value is ignored in implementations that do not support timeouts. If the provided timeout value is greater than supported (eg greater than â€4294967295‬ milliseconds on Firebird 4), the implementation should behave as if zero (
0) was set, but still report the original value.The configured timeout only affects subsequent executes on this statement. The timeout includes time spent between reading from the result set.
- Specified by:
setTimeoutin interfaceFbStatement- Parameters:
statementTimeout- Timeout value in milliseconds- Throws:
SQLException- If the value is less than zero, this statement is closed, or a database access error occurs
-
getTimeout
Description copied from interface:FbStatementGets the current statement timeout for this statement.This method will only return the current statement timeout value for this method, it will not consider attachment or connection level timeouts. This is an implementation decision that might change in a point release.
- Specified by:
getTimeoutin interfaceFbStatement- Returns:
- The configured timeout in milliseconds; read the documentation in
FbStatement.setTimeout(long) - Throws:
SQLException- If this statement is closed, or a database access error occurs- See Also:
-
setCursorName
Sets the named cursor name for this statement.This method takes out a lock, and checks statement validity, then calls
setCursorNameImpl(String), and stores the cursor name on successful completion. Any exceptions will be notified onexceptionListenerDispatcher. To override the behaviour of this method, implement/overridesetCursorNameImpl(String).- Specified by:
setCursorNamein interfaceFbStatement- Parameters:
cursorName- Name of the cursor- Throws:
SQLException- If this statement is closed, or if the cursor name is set andcursorNameis different from the current cursor name
-
setCursorNameImpl
Implementation ofsetCursorName(String).The caller of this method will take out the lock, check statement validity and call
exceptionListenerDispatcherfor exceptions, so implementations of this method do not need to do so.- Parameters:
cursorName- Name of the cursor- Throws:
SQLException- If this statement is closed, or if the cursor name is set andcursorNameis different from the current cursor name
-
getCursorName
Gets the cursor name.The cursor name is cleared by a new statement prepare.
- Returns:
- the current cursor name
- Since:
- 6
-
getAllowedTimeout
- Returns:
- The timeout value, or
0if the timeout is larger than supported - Throws:
SQLException- If the statement is invalid
-
parseStatementInfo
Parse the statement info response instatementInfoResponse. If the response is truncated, a new request is done usinggetStatementInfoRequestItems()- Parameters:
statementInfoResponse- Statement info response- Throws:
SQLException
-
hasSingletonResult
protected final boolean hasSingletonResult()- Returns:
trueif this is a stored procedure (or other singleton result producing statement) with at least 1 output field
-
hasFields
protected final boolean hasFields()- Returns:
trueif this statement has at least one output field (either singleton or result set)
-
signalExecute
Signals the start of an execute for this statement.- Returns:
OperationCloseHandlehandle for the operation
-
signalFetch
Signals the start of a fetch for this statement.- Returns:
OperationCloseHandlehandle for the operation
-
signalAsyncFetchStart
-
signalAsyncFetchComplete
-