Uses of Interface
dev.omnist.document.Document

Packages that use Document

Package	Description
dev.omnist.algebra	The normative Schema Algebra: operations that reason about and transform an OSD Schema itself, rather than the documents it describes — normalize, prune, extract, lint, compatible_with, equivalent, is_empty, and structural inference from sample documents (omnist-spec §6).
dev.omnist.codec	Reading and writing the Document model as the non-OML wire formats — JSON, YAML, TOML, and XML (omnist-spec §7.3) — including the lossy-adjustment reporting (WriteReport) that records when a format's constraints force a value to be adjusted on write.
dev.omnist.document	Omnist document data model core package.
dev.omnist.oml	The lexer and parser for OML, Omnist's canonical text format (omnist-spec §4) — the format every other codec's input is normalized through and every omnist format output is written in.
dev.omnist.validation	Validating and materializing documents against an OSD schema: checking a Document conforms to a Schema and reporting diagnostics when it doesn't (omnist-spec §3.6), and the materialization pass that produces a schema-conformant document from one that's structurally compatible but not yet exact (§6.3, §8.2).

Uses of Document in dev.omnist.algebra

Method parameters in dev.omnist.algebra with type arguments of type Document

Modifier and Type	Method	Description
static Schema	SchemaAlgebra.infer(List<Document> samples)	Infers a schema from a list of sample documents (§6.10), rooted at "Root" with any-fallback disabled.
static Schema	SchemaAlgebra.infer(List<Document> samples, String rootName, boolean allowAny)	Infers a schema from a list of sample documents (§6.10).
static InferResult	SchemaAlgebra.inferWithReport(List<Document> samples, String rootName, boolean allowAny)	Infers a schema from a list of sample documents (§6.10), returning both the schema and a report of every field that fell back to any because its samples mixed incompatible scalar kinds.

Uses of Document in dev.omnist.codec

Methods in dev.omnist.codec that return Document

Modifier and Type	Method	Description
static Document	JsonCodec.read(String text)	Parses JSON text into a Document without schema guidance.
static Document	JsonCodec.read(String text, Schema schema)	Parses JSON text into a Document.
static Document	TomlCodec.read(String text)	Parses TOML text into a Document without schema guidance.
static Document	TomlCodec.read(String text, Schema schema)	Parses TOML text into a Document.
static Document	XmlCodec.read(String text)	Parses XML text into a Document without schema guidance.
static Document	XmlCodec.read(String text, Schema schema)	Parses XML text into a Document, optionally with schema guidance.
static Document	YamlCodec.read(String text)	Parses YAML text into a Document without schema guidance.
static Document	YamlCodec.read(String text, Schema schema)	Parses YAML text into a Document.

Methods in dev.omnist.codec with parameters of type Document

Modifier and Type	Method	Description
static WriteReport	JsonCodec.check(Document node)	Checks a Document for JSON-representability issues without serializing it.
static WriteReport	TomlCodec.check(Document node)	Computes what adjustments TomlCodec.write(Document) would make to node without actually producing TOML text — useful for checking whether a document would round-trip cleanly before committing to a strict write.
static WriteReport	XmlCodec.check(Document node)	Computes what adjustments XmlCodec.write(Document) would make to node without actually producing XML text.
static WriteReport	YamlCodec.check(Document node)	Computes what adjustments YamlCodec.write(Document) would make to node without actually producing YAML text.
static String	JsonCodec.write(Document node)	Serializes a Document to compact JSON with no indentation.
static String	JsonCodec.write(Document node, Integer indent, boolean strict, WriteReport report)	Serializes a Document to JSON, optionally indented and in strict mode.
static String	TomlCodec.write(Document node)	Serializes a Document to TOML text, non-strict (dropping unrepresentable leaves rather than throwing).
static String	TomlCodec.write(Document node, boolean strict, WriteReport report)	Serializes a Document to TOML text.
static String	XmlCodec.write(Document node)	Serializes a Document to XML text, non-strict (dropping/sanitizing unrepresentable content rather than throwing).
static String	XmlCodec.write(Document node, boolean strict, WriteReport report)	Serializes a Document to XML text.
static String	YamlCodec.write(Document node)	Serializes a Document to YAML text, non-strict (applying adjustments rather than throwing).
static String	YamlCodec.write(Document node, boolean strict, WriteReport report)	Serializes a Document to YAML text.

Uses of Document in dev.omnist.document

Subinterfaces of Document in dev.omnist.document

Modifier and Type	Interface	Description
interface	Scalar	Represents a scalar value in the Omnist Document model (omnist-spec §2.2.1).
interface	Value	Represents a value in the Document model (omnist-spec §2.2).

Classes in dev.omnist.document that implement Document

Modifier and Type	Class	Description
final record	Node	A node in the Document model, consisting of an ordered list of labeled edges (omnist-spec §2.1/§2.2).
static final record	Scalar.BooleanScalar	A scalar holding a boolean value (omnist-spec §2.2.1, type boolean).
static final record	Scalar.DateScalar	A scalar holding a calendar date without a time component (omnist-spec §2.2.1, type date).
static final record	Scalar.DateTimeScalar	A scalar holding a date-time with an optional UTC offset (omnist-spec §2.2.1, type datetime).
static final record	Scalar.IntegerScalar	A scalar holding an arbitrary-precision integer value (omnist-spec §2.2.1, type integer).
static final record	Scalar.NumberScalar	A scalar holding an IEEE-754 64-bit floating-point number (omnist-spec §2.2.1, type number).
static final record	Scalar.StringScalar	A scalar holding a Unicode text value (omnist-spec §2.2.1, type string).
static final record	Scalar.TimeScalar	A scalar holding a time-of-day with an optional UTC offset (omnist-spec §2.2.1, type time).
static final record	Value.NullValue	Represents the null value in the Document model (omnist-spec §2.2.1).

Uses of Document in dev.omnist.oml

Methods in dev.omnist.oml that return Document

Modifier and Type	Method	Description
Document	OmlReader.parseDocument()	Parses the token stream into a top-level Document.
static Document	OmlReader.read(String source)	Parses OML text into a Document using Limits.DEFAULT safety limits.
static Document	OmlReader.read(String source, Limits limits)	Parses OML text into a Document using caller-supplied safety limits.

Methods in dev.omnist.oml with parameters of type Document

Modifier and Type	Method	Description
static String	OmlWriter.write(Document doc)	Serializes a Document to canonical indented OML text (omnist-spec §4 and §9.5).
static String	OmlWriter.writeCompact(Document doc)	Serializes a Document to compact inline OML text.

Uses of Document in dev.omnist.validation

Methods in dev.omnist.validation that return Document

Modifier and Type	Method	Description
static Document	Materializer.materialize(Document node, Schema schema)	Applies schema-driven coercion to node, returning a fully-typed Document.

Methods in dev.omnist.validation with parameters of type Document

Modifier and Type	Method	Description
static Document	Materializer.materialize(Document node, Schema schema)	Applies schema-driven coercion to node, returning a fully-typed Document.
static ValidationResult	Validator.validate(Document document, Schema schema)	Validates a Document against a Schema.