java.lang.Object
org.firebirdsql.gds.ng.AbstractFbStatement
org.firebirdsql.gds.ng.wire.AbstractFbWireStatement
- All Implemented Interfaces:
AutoCloseable,FbStatement,ExceptionListenable,FbWireStatement
- Direct Known Subclasses:
V10Statement
public abstract class AbstractFbWireStatement
extends AbstractFbStatement
implements FbWireStatement
- Since:
- 3.0
- Author:
- Mark Rotteveel
-
Field Summary
Fields inherited from class org.firebirdsql.gds.ng.AbstractFbStatement
exceptionListenerDispatcher, statementListenerDispatcher -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected final byte[]calculateBlr(RowDescriptor rowDescriptor) Returns the (possibly cached) blr byte array for aRowDescriptor, ornullif the parameter is null.protected final byte[]calculateBlr(RowDescriptor rowDescriptor, RowValue rowValue) Returns the blr byte array for aRowValue, ornullif the parameter is null.final voidclose()Close and deallocate this statement.final RowDescriptorprotected final BlrCalculatorfinal FbWireDatabasefinal intprotected byte[]getInfo(int operation, byte[] requestItems, int bufferLength) byte[]getSqlInfo(byte[] requestItems, int bufferLength) Request statement info.protected final XdrInputStreamgetXdrIn()Gets the XdrInputStream.protected final XdrOutputStreamGets the XdrOutputStream.protected booleanisValidTransactionClass(Class<? extends FbTransaction> transactionClass) Method to decide if a transaction implementation class is valid for the statement implementation.protected final voidsetHandle(int handle) final LockCloseablewithLock()Locks the lock withLock.lock()(or equivalent).protected final <T> DeferredActionwrapDeferredResponse(DeferredResponse<T> deferredResponse, Function<Response, T> responseMapper, boolean requiresSync) Wraps a deferred response to produce a deferred action that can be added usingFbWireDatabase.enqueueDeferredAction(DeferredAction), notifying the exception listener of this statement for exceptions, and forcing the ERROR state for IO errors.Methods inherited from class org.firebirdsql.gds.ng.AbstractFbStatement
addExceptionListener, addStatementListener, addWeakStatementListener, asyncFetchRows, checkFetchSize, checkPrepareAllowed, checkStatementHasOpenCursor, checkStatementValid, checkStatementValid, closeCursor, closeCursor, createExecutionPlanProcessor, createSqlCountProcessor, ensureClosedCursor, fetchScroll, fetchScrollImpl, forceState, free, getAllowedTimeout, getCursorInfo, getCursorInfo, getCursorInfoImpl, getCursorName, getExecutionPlan, getExplainedExecutionPlan, getParameterDescriptionInfoRequestItems, getParameterDescriptor, getRowDescriptor, getSqlCounts, getSqlInfo, getState, getStatementInfoRequestItems, getStatementWarningCallback, getTimeout, getTransaction, getTransactionListener, getType, hasFetched, hasFields, hasSingletonResult, isAfterLast, isBeforeFirst, isPrepareAllowed, parseStatementInfo, queueRowData, removeExceptionListener, removeStatementListener, reset, reset, resetAll, setAfterLast, setBeforeFirst, setCursorName, setCursorNameImpl, setParameterDescriptor, setRowDescriptor, setTimeout, setTransaction, setType, signalAsyncFetchComplete, signalAsyncFetchStart, signalExecute, signalFetch, switchState, unprepare, validateParametersMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.firebirdsql.gds.ng.listeners.ExceptionListenable
addExceptionListener, removeExceptionListenerMethods inherited from interface org.firebirdsql.gds.ng.FbStatement
addStatementListener, addWeakStatementListener, asyncFetchRows, batchCancel, batchExecute, clearCursorFlag, closeCursor, closeCursor, createBatchParameterBuffer, deferredBatchCreate, deferredBatchRelease, deferredBatchSend, ensureClosedCursor, execute, fetchRows, fetchScroll, getCursorInfo, getCursorInfo, getDefaultSqlInfoSize, getExecutionPlan, getExplainedExecutionPlan, getMaxSqlInfoSize, getParameterDescriptor, getRowDescriptor, getSqlCounts, getSqlInfo, getState, getTimeout, getTransaction, getType, hasFetched, isCursorFlagSet, prepare, removeStatementListener, setCursorFlag, setCursorName, setTimeout, setTransaction, supportBatchUpdates, supportsCursorInfo, supportsFetchScroll, unprepare, validateParameters
-
Constructor Details
-
AbstractFbWireStatement
-
-
Method Details
-
withLock
Description copied from interface:FbStatementLocks the lock withLock.lock()(or equivalent).Implementations are expected to apply the same lock as
FbAttachment.withLock().- Specified by:
withLockin interfaceFbStatement- Returns:
- lock closeable which unlocks the lock on close
- See Also:
-
getXdrIn
Gets the XdrInputStream.- Returns:
- Instance of XdrInputStream
- Throws:
SQLException- If no connection is opened or when exceptions occur retrieving the InputStream
-
getXdrOut
Gets the XdrOutputStream.- Returns:
- Instance of XdrOutputStream
- Throws:
SQLException- If no connection is opened or when exceptions occur retrieving the OutputStream
-
getDatabase
- Specified by:
getDatabasein interfaceFbStatement- Returns:
- The database connection that created this statement
-
getHandle
public final int getHandle()- Specified by:
getHandlein interfaceFbStatement- Returns:
- The Firebird statement handle identifier
-
setHandle
protected final void setHandle(int handle) -
calculateBlr
Returns the (possibly cached) blr byte array for aRowDescriptor, ornullif the parameter is null.- Parameters:
rowDescriptor- The row descriptor.- Returns:
- blr byte array or
nullwhenrowDescriptorisnull - Throws:
SQLException- When theRowDescriptorcontains an unsupported field type.
-
calculateBlr
protected final byte[] calculateBlr(RowDescriptor rowDescriptor, RowValue rowValue) throws SQLException Returns the blr byte array for aRowValue, ornullif the parameter is null.Contrary to
calculateBlr(org.firebirdsql.gds.ng.fields.RowDescriptor), it is not allowed to cache this value as it depends on the actual row value.- Parameters:
rowValue- The row value.- Returns:
- blr byte array or
nullwhenrowValueisnull - Throws:
SQLException- When theRowValuecontains an unsupported field type.
-
getBlrCalculator
- Returns:
- The
BlrCalculatorinstance for this statement (currently always the one from theFbWireDatabaseinstance).
-
close
Description copied from interface:FbStatementClose and deallocate this statement.- Specified by:
closein interfaceAutoCloseable- Specified by:
closein interfaceFbStatement- Overrides:
closein classAbstractFbStatement- Throws:
SQLException
-
isValidTransactionClass
Description copied from class:AbstractFbStatementMethod to decide if a transaction implementation class is valid for the statement implementation.Eg a
V10Statementwill only work with anFbWireTransactionimplementation.- Specified by:
isValidTransactionClassin classAbstractFbStatement- Parameters:
transactionClass- Class of the transaction- Returns:
truewhen the transaction class is valid for the statement implementation.
-
emptyRowDescriptor
- Specified by:
emptyRowDescriptorin interfaceFbStatement- Returns:
- A potentially cached empty row descriptor for this statement or database.
-
getSqlInfo
Description copied from interface:FbStatementRequest statement info.- Specified by:
getSqlInfoin 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 response.
-
getInfo
- Throws:
SQLException
-
wrapDeferredResponse
protected final <T> DeferredAction wrapDeferredResponse(DeferredResponse<T> deferredResponse, Function<Response, T> responseMapper, boolean requiresSync) Wraps a deferred response to produce a deferred action that can be added usingFbWireDatabase.enqueueDeferredAction(DeferredAction), notifying the exception listener of this statement for exceptions, and forcing the ERROR state for IO errors.- Type Parameters:
T- type of deferred response- Parameters:
deferredResponse- deferred response to wrapresponseMapper- Function to map aResponseto the response object expected by the deferred responserequiresSync-trueif the deferred response requires a sync action or flush before it can be processed- Returns:
- deferred action
-