Class Tuple

    • Field Detail

      • EOF

        public boolean EOF
        When EOF field is true the Tuple marks the end of the stream. The EOF Tuple will not contain a record from the stream, but it may contain metrics/aggregates gathered by underlying streams.
      • EXCEPTION

        public boolean EXCEPTION
        When EXCEPTION field is true the Tuple marks an exception in the stream and the corresponding "EXCEPTION" field contains a related message.
    • Constructor Detail

      • Tuple

        public Tuple()
      • Tuple

        public Tuple​(Map<String,​?> fields)
        A copy constructor.
        Parameters:
        fields - map containing keys and values to be copied to this tuple
      • Tuple

        public Tuple​(Tuple original)
        A copy constructor
        Parameters:
        original - Tuple that will be copied
    • Method Detail

      • putAll

        public void putAll​(Map<String,​?> fields)
      • remove

        public void remove​(String key)
      • getException

        public String getException()
      • getFields

        public Map<String,​Object> getFields()
        Return all tuple fields and their values.
      • getFieldLabels

        public Map<String,​String> getFieldLabels()
        This represents the mapping of external field labels to the tuple's internal field names if they are different from field names.
        Returns:
        field labels or null
      • setFieldLabels

        public void setFieldLabels​(Map<String,​String> fieldLabels)
      • getFieldNames

        public List<String> getFieldNames()
        A list of field names to serialize. This list (together with the mapping in getFieldLabels() determines what tuple values are serialized and their external (serialized) names.
        Returns:
        list of external field names or null
      • setFieldNames

        public void setFieldNames​(List<String> fieldNames)
      • setMaps

        public void setMaps​(String key,
                            List<Map<?,​?>> maps)
      • getMetrics

        public Map<String,​Map<?,​?>> getMetrics()
      • setMetrics

        public void setMetrics​(Map<String,​Map<?,​?>> metrics)
      • merge

        public void merge​(Tuple other)
        The other tuples fields and fieldLabels will be putAll'd directly to this's fields and fieldLabels while other's fieldNames will be added such that duplicates aren't present.
        Parameters:
        other - Tuple to be merged into this.
      • EOF

        public static Tuple EOF()
        Create a new empty tuple marked as EOF.
      • EXCEPTION

        public static Tuple EXCEPTION​(String msg,
                                      boolean eof)
        Create a new empty tuple marked as EXCEPTION, and optionally EOF.
        Parameters:
        msg - exception message
        eof - if true the tuple will be marked as EOF
      • EXCEPTION

        public static Tuple EXCEPTION​(Throwable t,
                                      boolean eof)
        Create a new empty tuple marked as EXCEPTION and optionally EOF.
        Parameters:
        t - exception - full stack trace will be used as an exception message
        eof - if true the tuple will be marked as EOF