Record Class ParsedDocument

java.lang.Object

java.lang.Record

ai.doctruth.ParsedDocument

Record Components:

docId - a stable identifier for this document (e.g. content hash, UUID, file path).

sections - the parsed sections in document order.

metadata - document-level metadata.

public record ParsedDocument(String docId, List<ParsedSection> sections, DocumentMetadata metadata)
extends Record

The output of Layer 1 (document parsing): a stable identifier, an ordered list of sections, and the document metadata.

Invariants (enforced by the compact constructor):

• docId is non-null and non-blank.
• sections is non-null (empty list allowed).
• metadata is non-null.

The sections list is defensively copied on construction and exposed as unmodifiable, so neither the caller's input nor the accessor's return value can mutate the document's state.

Since:

0.1.0

Constructor Summary

Constructors

Constructor	Description
ParsedDocument(String docId, List<ParsedSection> sections, DocumentMetadata metadata)	Creates an instance of a ParsedDocument record class.

Method Summary

Modifier and Type	Method	Description
String	docId()	Returns the value of the docId 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.
DocumentMetadata	metadata()	Returns the value of the metadata record component.
List<ParsedSection>	sections()	Returns the value of the sections record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ParsedDocument

public ParsedDocument(String docId,
 List<ParsedSection> sections,
 DocumentMetadata metadata)

Creates an instance of a ParsedDocument record class.

Parameters:

docId - the value for the docId record component

sections - the value for the sections record component

metadata - the value for the metadata 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.

docId

public String docId()

Returns the value of the docId record component.

Returns:

the value of the docId record component

sections

public List<ParsedSection> sections()

Returns the value of the sections record component.

Returns:

the value of the sections record component

metadata

public DocumentMetadata metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component