Package org.apache.beam.sdk.coders

Class TimestampPrefixingWindowCoder<T extends BoundedWindow>

  • Type Parameters:
    T - The custom window type.
    All Implemented Interfaces:
    java.io.Serializable
    public class TimestampPrefixingWindowCoder<T extends BoundedWindow>
extends StructuredCoder<T>
    A TimestampPrefixingWindowCoder wraps arbitrary user custom window coder. While encoding the custom window type, it extracts the maxTimestamp(inclusive) of the window and prefix it to the encoded bytes of the window using the user custom window coder.
    See Also:
    Serialized Form

    • Method Detail

      • getWindowCoder

        public Coder<T> getWindowCoder()

      • encode

        public void encode​(T value,
                   java.io.OutputStream outStream)
            throws CoderException,
                   java.io.IOException
        Description copied from class: Coder
        Encodes the given value of type T onto the given output stream.
        Specified by:
        encode in class Coder<T extends BoundedWindow>
        Throws:
        CoderException - if the value could not be encoded for some reason
        java.io.IOException - if writing to the OutputStream fails for some reason

      • decode

        public T decode​(java.io.InputStream inStream)
         throws CoderException,
                java.io.IOException
        Description copied from class: Coder
        Decodes a value of type T from the given input stream in the given context. Returns the decoded value.
        Specified by:
        decode in class Coder<T extends BoundedWindow>
        Throws:
        CoderException - if the value could not be decoded for some reason
        java.io.IOException - if reading from the InputStream fails for some reason

      • getCoderArguments

        public java.util.List<? extends Coder<?>> getCoderArguments()
        Description copied from class: Coder
        If this is a Coder for a parameterized type, returns the list of Coders being used for each of the parameters in the same order they appear within the parameterized type's type signature. If this cannot be done, or this Coder does not encode/decode a parameterized type, returns the empty list.
        Specified by:
        getCoderArguments in class Coder<T extends BoundedWindow>

      • verifyDeterministic

        public void verifyDeterministic()
                         throws Coder.NonDeterministicException
        Description copied from class: Coder
        Throw Coder.NonDeterministicException if the coding is not deterministic.

        In order for a Coder to be considered deterministic, the following must be true:

        • two values that compare as equal (via Object.equals() or Comparable.compareTo(), if supported) have the same encoding.
        • the Coder always produces a canonical encoding, which is the same for an instance of an object even if produced on different computers at different times.
        Specified by:
        verifyDeterministic in class Coder<T extends BoundedWindow>
        Throws:
        Coder.NonDeterministicException - if this coder is not deterministic.

      • consistentWithEquals

        public boolean consistentWithEquals()
        Description copied from class: Coder
        Returns true if this Coder is injective with respect to Object.equals(java.lang.Object).

        Whenever the encoded bytes of two values are equal, then the original values are equal according to Objects.equals(). Note that this is well-defined for null.

        This condition is most notably false for arrays. More generally, this condition is false whenever equals() compares object identity, rather than performing a semantic/structural comparison.

        By default, returns false.

        Overrides:
        consistentWithEquals in class Coder<T extends BoundedWindow>

      • registerByteSizeObserver

        public void registerByteSizeObserver​(T value,
                                     ElementByteSizeObserver observer)
                              throws java.lang.Exception
        Description copied from class: Coder
        Notifies the ElementByteSizeObserver about the byte size of the encoded value using this Coder.

        Not intended to be called by user code, but instead by PipelineRunner implementations.

        By default, this notifies observer about the byte size of the encoded value using this coder as returned by Coder.getEncodedElementByteSize(T).

        Overrides:
        registerByteSizeObserver in class Coder<T extends BoundedWindow>
        Throws:
        java.lang.Exception