Record Class FigureSection

java.lang.Object
java.lang.Record
ai.doctruth.FigureSection
Record Components:
caption - the figure's caption text, possibly empty.
location - the source-document span this figure was recovered from.
All Implemented Interfaces:
ParsedSection
public record FigureSection(String caption, SourceLocation location) extends Record implements ParsedSection
A figure (image, chart, diagram) recovered from the source document, represented by its caption text plus a SourceLocation. The image bytes themselves are not carried by this record — downstream consumers can re-fetch from the source PDF/DOCX using the location.

Invariants: caption and location are non-null. Empty caption is allowed (some figures have no caption).

Since:
0.1.0

  • Constructor Details

    • FigureSection

      public FigureSection(String caption, SourceLocation location)
      Creates an instance of a FigureSection record class.
      Parameters:
      caption - the value for the caption record component
      location - the value for the location record component

  • 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.

    • caption

      public String caption()
      Returns the value of the caption record component.
      Returns:
      the value of the caption record component

    • location

      public SourceLocation location()
      Returns the value of the location record component.
      Returns:
      the value of the location record component