Module com.darkcollective.relix.processor
Package com.darkcollective.relix.processor.provenance

Record Class Annotated<K>

java.lang.Object
java.lang.Record
com.darkcollective.relix.processor.provenance.Annotated<K>
Type Parameters:
K - the semiring annotation type
Record Components:
row - the annotated tuple; never null
annotation - the tuple's semiring annotation; never null
public record Annotated<K>(Row row, K annotation) extends Record
A tuple paired with its provenance annotation — the side-channel carrier of the K-relation model.

The annotation lives alongside the Row, never as an ordinary data column, so the relational algebra stays closed: operators see a Row exactly as before, and the K rides next to it only while a provenance mode is active. An annotation of zero denotes an absent tuple; the canonical form of an AnnotatedRelation therefore never contains a zero-annotated row.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Annotated(Row row, K annotation)
    Validates that neither component is null.

  • Method Summary

    Modifier and Type
    Method
    Description
    K
    annotation()
    Returns the value of the annotation record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    Row
    row()
    Returns the value of the row record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Annotated

      public Annotated(Row row, K annotation)
      Validates that neither component is null.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • row

      public Row row()
      Returns the value of the row record component.
      Returns:
      the value of the row record component

    • annotation

      public K annotation()
      Returns the value of the annotation record component.
      Returns:
      the value of the annotation record component