Type (presto-common 0.278.1 API)

All Known Subinterfaces:

EnumType<T>, FixedWidthType, VariableWidthType

All Known Implementing Classes:

AbstractIntType, AbstractLongType, AbstractPrimitiveType, AbstractType, AbstractVarcharType, AbstractVariableWidthType, ArrayType, BigintEnumType, BigintType, BooleanType, CharType, DateType, DecimalType, DistinctType, DoubleType, FunctionType, HyperLogLogType, IntegerType, JsonType, KdbTreeType, MapType, P4HyperLogLogType, RealType, RowType, SmallintType, StatisticalDigestType, TimestampType, TimestampWithTimeZoneType, TimeType, TimeWithTimeZoneType, TinyintType, TypeWithName, UnknownType, VarbinaryType, VarcharEnumType, VarcharType
```
public interface Type
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`appendTo(Block block, int position, BlockBuilder blockBuilder)` Append the value at `position` in `block` to `blockBuilder`.
`int`	`compareTo(Block leftBlock, int leftPosition, Block rightBlock, int rightPosition)` Compare the values in the specified block at the specified positions equal.
`BlockBuilder`	`createBlockBuilder(BlockBuilderStatus blockBuilderStatus, int expectedEntries)` Creates the preferred block builder for this type.
`BlockBuilder`	`createBlockBuilder(BlockBuilderStatus blockBuilderStatus, int expectedEntries, int expectedBytesPerEntry)` Creates the preferred block builder for this type.
`boolean`	`equalTo(Block leftBlock, int leftPosition, Block rightBlock, int rightPosition)` Are the values in the specified blocks at the specified positions equal?
`Block`	`getBlockUnchecked(Block block, int internalPosition)` Gets the value at the `block` `internalPosition - offsetBase` as a block without boundary checks.
`boolean`	`getBoolean(Block block, int position)` Gets the value at the `block` `position` as a boolean.
`boolean`	`getBooleanUnchecked(UncheckedBlock block, int internalPosition)` Gets the value at the `block` `internalPosition - offsetBase` as a boolean without boundary checks.
`String`	`getDisplayName()` Returns the name of this type that should be displayed to end-users.
`double`	`getDouble(Block block, int position)` Gets the value at the `block` `position` as a double.
`double`	`getDoubleUnchecked(UncheckedBlock block, int internalPosition)` Gets the value at the `block` `internalPosition - offsetBase` as a double without boundary checks.
`Class<?>`	`getJavaType()` Gets the Java class type used to represent this value on the stack during expression execution.
`long`	`getLong(Block block, int position)` Gets the value at the `block` `position` as a long.
`long`	`getLongUnchecked(UncheckedBlock block, int internalPosition)` Gets the value at the `block` `internalPosition - offsetBase` as a long without boundary checks.
`Object`	`getObject(Block block, int position)` Gets the value at the `block` `position` as an Object.
`Object`	`getObjectValue(SqlFunctionProperties properties, Block block, int position)` Gets an object representation of the type value in the `block` `position`.
`io.airlift.slice.Slice`	`getSlice(Block block, int position)` Gets the value at the `block` `position` as a Slice.
`io.airlift.slice.Slice`	`getSliceUnchecked(Block block, int internalPosition)` Gets the value at the `block` `position` as a Slice without boundary checks
`List<Type>`	`getTypeParameters()` For parameterized types returns the list of parameters.
`TypeSignature`	`getTypeSignature()` Gets the name of this type which must be case insensitive globally unique.
`long`	`hash(Block block, int position)` Calculates the hash code of the value at the specified position in the specified block.
`boolean`	`isComparable()` True if the type supports equalTo and hash.
`boolean`	`isOrderable()` True if the type supports compareTo.
`void`	`writeBoolean(BlockBuilder blockBuilder, boolean value)` Writes the boolean value into the `BlockBuilder`.
`void`	`writeDouble(BlockBuilder blockBuilder, double value)` Writes the double value into the `BlockBuilder`.
`void`	`writeLong(BlockBuilder blockBuilder, long value)` Writes the long value into the `BlockBuilder`.
`void`	`writeObject(BlockBuilder blockBuilder, Object value)` Writes the Object value into the `BlockBuilder`.
`void`	`writeSlice(BlockBuilder blockBuilder, io.airlift.slice.Slice value)` Writes the Slice value into the `BlockBuilder`.
`void`	`writeSlice(BlockBuilder blockBuilder, io.airlift.slice.Slice value, int offset, int length)` Writes the Slice value into the `BlockBuilder`.

- Method Detail
  - getTypeSignature
```
TypeSignature getTypeSignature()
```
    Gets the name of this type which must be case insensitive globally unique. The name of a user defined type must be a legal identifier in Presto.
  - getDisplayName
```
String getDisplayName()
```
    Returns the name of this type that should be displayed to end-users.
  - isComparable
```
boolean isComparable()
```
    True if the type supports equalTo and hash.
  - isOrderable
```
boolean isOrderable()
```
    True if the type supports compareTo.
  - getJavaType
```
Class<?> getJavaType()
```
    Gets the Java class type used to represent this value on the stack during expression execution.
    Currently, this must be boolean, long, double, Slice or Block.
  - getTypeParameters
```
List<Type> getTypeParameters()
```
    For parameterized types returns the list of parameters.
  - createBlockBuilder
```
BlockBuilder createBlockBuilder(BlockBuilderStatus blockBuilderStatus,
                                int expectedEntries,
                                int expectedBytesPerEntry)
```
    Creates the preferred block builder for this type. This is the builder used to store values after an expression projection within the query.
  - createBlockBuilder
```
BlockBuilder createBlockBuilder(BlockBuilderStatus blockBuilderStatus,
                                int expectedEntries)
```
    Creates the preferred block builder for this type. This is the builder used to store values after an expression projection within the query.
  - getObjectValue
```
Object getObjectValue(SqlFunctionProperties properties,
                      Block block,
                      int position)
```
    Gets an object representation of the type value in the block position. This is the value returned to the user via the REST endpoint and therefore must be JSON serializable.
  - getBoolean
```
boolean getBoolean(Block block,
                   int position)
```
    Gets the value at the block position as a boolean.
  - getBooleanUnchecked
```
boolean getBooleanUnchecked(UncheckedBlock block,
                            int internalPosition)
```
    Gets the value at the block internalPosition - offsetBase as a boolean without boundary checks.
  - getLong
```
long getLong(Block block,
             int position)
```
    Gets the value at the block position as a long.
  - getLongUnchecked
```
long getLongUnchecked(UncheckedBlock block,
                      int internalPosition)
```
    Gets the value at the block internalPosition - offsetBase as a long without boundary checks.
  - getDouble
```
double getDouble(Block block,
                 int position)
```
    Gets the value at the block position as a double.
  - getDoubleUnchecked
```
double getDoubleUnchecked(UncheckedBlock block,
                          int internalPosition)
```
    Gets the value at the block internalPosition - offsetBase as a double without boundary checks.
  - getSlice
```
io.airlift.slice.Slice getSlice(Block block,
                                int position)
```
    Gets the value at the block position as a Slice.
  - getSliceUnchecked
```
io.airlift.slice.Slice getSliceUnchecked(Block block,
                                         int internalPosition)
```
    Gets the value at the block position as a Slice without boundary checks
  - getObject
```
Object getObject(Block block,
                 int position)
```
    Gets the value at the block position as an Object.
  - getBlockUnchecked
```
Block getBlockUnchecked(Block block,
                        int internalPosition)
```
    Gets the value at the block internalPosition - offsetBase as a block without boundary checks.
  - writeBoolean
```
void writeBoolean(BlockBuilder blockBuilder,
                  boolean value)
```
    Writes the boolean value into the BlockBuilder.
  - writeLong
```
void writeLong(BlockBuilder blockBuilder,
               long value)
```
    Writes the long value into the BlockBuilder.
  - writeDouble
```
void writeDouble(BlockBuilder blockBuilder,
                 double value)
```
    Writes the double value into the BlockBuilder.
  - writeSlice
```
void writeSlice(BlockBuilder blockBuilder,
                io.airlift.slice.Slice value)
```
    Writes the Slice value into the BlockBuilder.
  - writeSlice
```
void writeSlice(BlockBuilder blockBuilder,
                io.airlift.slice.Slice value,
                int offset,
                int length)
```
    Writes the Slice value into the BlockBuilder.
  - writeObject
```
void writeObject(BlockBuilder blockBuilder,
                 Object value)
```
    Writes the Object value into the BlockBuilder.
  - appendTo
```
void appendTo(Block block,
              int position,
              BlockBuilder blockBuilder)
```
    Append the value at position in block to blockBuilder.
  - equalTo
```
boolean equalTo(Block leftBlock,
                int leftPosition,
                Block rightBlock,
                int rightPosition)
```
    Are the values in the specified blocks at the specified positions equal?
    This method assumes input is not null.
  - hash
```
long hash(Block block,
          int position)
```
    Calculates the hash code of the value at the specified position in the specified block.
  - compareTo
```
int compareTo(Block leftBlock,
              int leftPosition,
              Block rightBlock,
              int rightPosition)
```
    Compare the values in the specified block at the specified positions equal.

Interface Type

Method Summary

Method Detail

getTypeSignature

getDisplayName

isComparable

isOrderable

getJavaType

getTypeParameters

createBlockBuilder

createBlockBuilder

getObjectValue

getBoolean

getBooleanUnchecked

getLong

getLongUnchecked

getDouble

getDoubleUnchecked

getSlice

getSliceUnchecked

getObject

getBlockUnchecked

writeBoolean

writeLong

writeDouble

writeSlice

writeSlice

writeObject

appendTo

equalTo

hash

compareTo