Package com.tnsai.rag

Record Class DocumentBlock

java.lang.Object

java.lang.Record

com.tnsai.rag.DocumentBlock

Record Components:

content - normalized block text

structuralPath - stable format-native path

metadata - immutable format-specific metadata

public record DocumentBlock(String content, String structuralPath, Map<String,Object> metadata)
extends Record

One structurally addressable block within an extracted document.

structuralPath is stable for unchanged source structure and may use a format-native convention such as $.products[4], page/12, or a source-code symbol signature. Metadata values follow the immutable algebra and bounds documented by DocumentInput.

Since:

0.13.0

Constructor Summary

Constructors

Constructor	Description
DocumentBlock(String content, String structuralPath, Map<String,Object> metadata)	Creates an instance of a DocumentBlock record class.

Method Summary

Modifier and Type	Method	Description
String	content()	Returns the value of the content 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.
Map<String,Object>	metadata()	Returns the value of the metadata record component.
String	structuralPath()	Returns the value of the structuralPath record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DocumentBlock

public DocumentBlock(String content,
 String structuralPath,
 Map<String,Object> metadata)

Creates an instance of a DocumentBlock record class.

Parameters:

content - the value for the content record component

structuralPath - the value for the structuralPath record component

metadata - the value for the metadata record component

Method Details

toString

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

content

public String content()

Returns the value of the content record component.

Returns:

the value of the content record component

structuralPath

public String structuralPath()

Returns the value of the structuralPath record component.

Returns:

the value of the structuralPath record component

metadata

public Map<String,Object> metadata()

Returns the value of the metadata record component.

Returns:

the value of the metadata record component