Package io.micronaut.data.runtime.mapper

Interface ResultConsumer.Context<RS>

  • Type Parameters:
    RS - The result set type.
    Enclosing interface:
    ResultConsumer<T,​RS>
    public static interface ResultConsumer.Context<RS>
    A context object that simplifies mapping results to objects.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      ResultReader<RS,​java.lang.String> getResultReader()  
      RS getResultSet()  
      default java.math.BigDecimal readBigDecimal​(java.lang.String name)
      Read a BigDecimal value for the given name.
      default boolean readBoolean​(java.lang.String name)
      Read a boolean value for the given name.
      default byte readByte​(java.lang.String name)
      Read a byte value for the given name.
      default byte[] readBytes​(java.lang.String name)
      Read a byte[] value for the given name.
      default char readChar​(java.lang.String name)
      Read a char value for the given name.
      default java.util.Date readDate​(java.lang.String name)
      Read a date value for the given name.
      default double readDouble​(java.lang.String name)
      Read a double value for the given name.
      <E,​D>
      D      		 readDTO​(java.lang.String prefix, java.lang.Class<E> rootEntity, java.lang.Class<D> dtoType)
      Read an entity using the given prefix to be passes to result set lookups.
      <E> E readEntity​(java.lang.String prefix, java.lang.Class<E> type)
      Read an entity using the given prefix to be passes to result set lookups.
      default float readFloat​(java.lang.String name)
      Read a float value for the given name.
      default int readInt​(java.lang.String name)
      Read a int value for the given name.
      default long readLong​(java.lang.String name)
      Read a long value for the given name.
      default short readShort​(java.lang.String name)
      Read a short value for the given name.
      default java.lang.String readString​(java.lang.String name)
      Read a string value for the given name.
      default java.util.Date readTimestamp​(java.lang.String name)
      Read a timestamp value for the given index.

    • Method Detail

      • getResultSet

        RS getResultSet()
        Returns:
        The current state of the result.

      • getResultReader

        ResultReader<RS,​java.lang.String> getResultReader()
        Returns:
        The result reader.

      • readEntity

        @NonNull
<E> E readEntity​(@NonNull
                 java.lang.String prefix,
                 @NonNull
                 java.lang.Class<E> type)
          throws DataAccessException
        Read an entity using the given prefix to be passes to result set lookups.
        Type Parameters:
        E - The entity generic type
        Parameters:
        prefix - The prefix
        type - The entity type
        Returns:
        The entity result
        Throws:
        DataAccessException - if it is not possible read the result from the result set.

      • readDTO

        @NonNull
<E,​D> D readDTO​(@NonNull
                      java.lang.String prefix,
                      @NonNull
                      java.lang.Class<E> rootEntity,
                      @NonNull
                      java.lang.Class<D> dtoType)
               throws DataAccessException
        Read an entity using the given prefix to be passes to result set lookups.
        Type Parameters:
        E - The entity generic type
        D - The DTO generic type
        Parameters:
        prefix - The prefix
        rootEntity - The entity type
        dtoType - The DTO type. Must be annotated with Introspected
        Returns:
        The entity result
        Throws:
        DataAccessException - if it is not possible read the result from the result set.

      • readLong

        default long readLong​(@NonNull
                      java.lang.String name)
        Read a long value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The long value

      • readChar

        default char readChar​(@NonNull
                      java.lang.String name)
        Read a char value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The char value

      • readDate

        @Nullable
default java.util.Date readDate​(@NonNull
                                java.lang.String name)
        Read a date value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The char value

      • readTimestamp

        @Nullable
default java.util.Date readTimestamp​(@NonNull
                                     java.lang.String name)
        Read a timestamp value for the given index.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The char value

      • readString

        @Nullable
default java.lang.String readString​(@NonNull
                                    java.lang.String name)
        Read a string value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The string value

      • readInt

        default int readInt​(@NonNull
                    java.lang.String name)
        Read a int value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The int value

      • readBoolean

        default boolean readBoolean​(@NonNull
                            java.lang.String name)
        Read a boolean value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The boolean value

      • readFloat

        default float readFloat​(@NonNull
                        java.lang.String name)
        Read a float value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The float value

      • readByte

        default byte readByte​(@NonNull
                      java.lang.String name)
        Read a byte value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The byte value

      • readShort

        default short readShort​(@NonNull
                        java.lang.String name)
        Read a short value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The short value

      • readDouble

        default double readDouble​(@NonNull
                          java.lang.String name)
        Read a double value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The double value

      • readBigDecimal

        @Nullable
default java.math.BigDecimal readBigDecimal​(@NonNull
                                            java.lang.String name)
        Read a BigDecimal value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The BigDecimal value

      • readBytes

        default byte[] readBytes​(@NonNull
                         java.lang.String name)
        Read a byte[] value for the given name.
        Parameters:
        name - The name (such as the column name)
        Returns:
        The byte[] value