All Implemented Interfaces:
```
public class Document

                    
```
Represents an unstructured piece of text that usually corresponds to a content of a single file. This text could originate from various sources such as a text file, PDF, DOCX, or a web page (HTML). Each document may have associated metadata including its source, owner, creation date, etc.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`public final static String`	`FILE_NAME`
`public final static String`	`ABSOLUTE_DIRECTORY_PATH`
`public final static String`	`URL`

Constructor Summary

Constructors
Constructor	Description
`Document(String text)`	Creates a new Document from the given text.
`Document(String text, Metadata metadata)`	Creates a new Document from the given text.

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`text()`	Returns the text of this document.
`Metadata`	`metadata()`	Returns the metadata associated with this document.
`String`	`metadata(String key)`	Looks up the metadata value for the given key.
`TextSegment`	`toTextSegment()`	Builds a TextSegment from this document.
`boolean`	`equals(Object o)`
`int`	`hashCode()`
`String`	`toString()`
`static Document`	`from(String text)`	Creates a new Document from the given text.
`static Document`	`from(String text, Metadata metadata)`	Creates a new Document from the given text.
`static Document`	`document(String text)`	Creates a new Document from the given text.
`static Document`	`document(String text, Metadata metadata)`	Creates a new Document from the given text.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Document
```
Document(String text)
```
    Creates a new Document from the given text.
    
    Parameters:
    
    text - the text of the document.
  - Document
```
Document(String text, Metadata metadata)
```
    Creates a new Document from the given text.
    
    Parameters:
    
    text - the text of the document.
    
    metadata - the metadata of the document.
- Method Detail
  - text
```
 String text()
```
    Returns the text of this document.
    
    Returns:
    
    the text.
  - metadata
```
 Metadata metadata()
```
    Returns the metadata associated with this document.
    
    Returns:
    
    the metadata.
  - metadata
```
@Deprecated(forRemoval = true) String metadata(String key)
```
    Looks up the metadata value for the given key.
    
    Parameters:
    
    key - the key to look up.
    
    Returns:
    
    the metadata value for the given key, or null if the key is not present.
  - toTextSegment
```
 TextSegment toTextSegment()
```
    Builds a TextSegment from this document.
    
    Returns:
    
    a TextSegment.
  - equals
```
 boolean equals(Object o)
```
  - hashCode
```
 int hashCode()
```
  - toString
```
 String toString()
```
  - from
```
 static Document from(String text)
```
    Creates a new Document from the given text.
    The created document will have empty metadata.
    
    Parameters:
    
    text - the text of the document.
    
    Returns:
    
    a new Document.
  - from
```
 static Document from(String text, Metadata metadata)
```
    Creates a new Document from the given text.
    
    Parameters:
    
    text - the text of the document.
    
    metadata - the metadata of the document.
    
    Returns:
    
    a new Document.
  - document
```
 static Document document(String text)
```
    Creates a new Document from the given text.
    The created document will have empty metadata.
    
    Parameters:
    
    text - the text of the document.
    
    Returns:
    
    a new Document.
  - document
```
 static Document document(String text, Metadata metadata)
```
    Creates a new Document from the given text.
    
    Parameters:
    
    text - the text of the document.
    
    metadata - the metadata of the document.
    
    Returns:
    
    a new Document.

Class Document

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Document

Method Detail

text

metadata

metadata

toTextSegment

equals

hashCode

toString

from

from

document

document