java.lang.Object
org.firebirdsql.gds.ng.wire.DefaultBlrCalculator
- All Implemented Interfaces:
BlrCalculator
Default BLR calculator for the wire protocol.
Most likely this can be used without change for other protocol versions as well, although we may need to investigate
the TODOs specified in calculateBlr(org.firebirdsql.gds.ng.fields.RowDescriptor)
.
- Since:
- 3.0
- Author:
- Mark Rotteveel
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final DefaultBlrCalculator
Cached instance ofDefaultBlrCalculator
for dialect 3 databases. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
calculateBatchMessageLength
(RowDescriptor rowDescriptor) Calculates the batch message length.byte[]
calculateBlr
(RowDescriptor rowDescriptor) Calculates the blr for the row descriptor.byte[]
calculateBlr
(RowDescriptor rowDescriptor, RowValue rowValue) Calculates the blr for a specific row value.int
calculateIoLength
(FieldDescriptor fieldDescriptor) Calculates the io length for the field descriptor.int
calculateIoLength
(FieldDescriptor fieldDescriptor, byte[] fieldData) Calculates the io length for the field descriptor and actual data.
-
Field Details
-
CALCULATOR_DIALECT_3
Cached instance ofDefaultBlrCalculator
for dialect 3 databases.
-
-
Constructor Details
-
DefaultBlrCalculator
public DefaultBlrCalculator(short dialect) Creates a BLR calculator.- Parameters:
dialect
- dialect, should beISCConstants.SQL_DIALECT_V6
(dialect 3) orISCConstants.SQL_DIALECT_V5
(dialect 1), but currentlydialect <= 1
is treated as dialect 1 and everything else as dialect 3
-
-
Method Details
-
calculateBlr
Description copied from interface:BlrCalculator
Calculates the blr for the row descriptor.- Specified by:
calculateBlr
in interfaceBlrCalculator
- Parameters:
rowDescriptor
- Row descriptor- Returns:
- Byte array with the blr
- Throws:
SQLException
- When theRowDescriptor
contains an unsupported field type.
-
calculateBlr
Description copied from interface:BlrCalculator
Calculates the blr for a specific row value.This allows to optimize for the actual length of the field.
- Specified by:
calculateBlr
in interfaceBlrCalculator
- Parameters:
rowDescriptor
- Row descriptorrowValue
- Row value- Returns:
- Byte array with the blr
- Throws:
SQLException
- When theRowValue
contains an unsupported field type.
-
calculateIoLength
Description copied from interface:BlrCalculator
Calculates the io length for the field descriptor.The return value indicates the length and padding of the type in the buffer
- < 0 : Type is of specified length * -1 and not padded
- == 0 : Type is of dynamic length (which is specified in the buffer as an integer) and padded
- > 0 : Type is of specified length minus 1 (subtracting 1 is required to avoid 0 for types of zero length) and padded
- Specified by:
calculateIoLength
in interfaceBlrCalculator
- Parameters:
fieldDescriptor
- Field descriptor- Returns:
- The io length
- Throws:
SQLException
-
calculateIoLength
Description copied from interface:BlrCalculator
Calculates the io length for the field descriptor and actual data.The return value indicates the length and padding of the type in the buffer
- < 0 : Type is of specified length * -1 and not padded
- == 0 : Type is of dynamic length (which is specified in the buffer as an integer) and padded
- > 0 : Type is of specified length minus 1 (subtracting 1 is required to avoid 0 for types of zero length) and padded
This allows to optimize for the actual length of the field.
For
CHAR
(ISCConstants.SQL_TEXT
the implementation should be consistent with the lengths as given byBlrCalculator.calculateIoLength(FieldDescriptor)
.- Specified by:
calculateIoLength
in interfaceBlrCalculator
- Parameters:
fieldDescriptor
- Field descriptorfieldData
- byte array (can benull
) with field data.- Returns:
- The io length
- Throws:
SQLException
-
calculateBatchMessageLength
Description copied from interface:BlrCalculator
Calculates the batch message length.- Specified by:
calculateBatchMessageLength
in interfaceBlrCalculator
- Parameters:
rowDescriptor
- row descriptor- Returns:
- batch message length
- Throws:
SQLException
- when theRowDescriptor
contains an unsupported field type.
-