julee.domain.models.document.document

Document domain models for the Capture, Extract, Assemble, Publish workflow.

This module contains the core document domain objects that represent documents and their metadata in the CEAP workflow system.

All domain models use Pydantic BaseModel for validation, serialization, and type safety, following the patterns established in the sample project.

Classes

Document	Complete document entity including content and metadata.
DocumentStatus	Status of a document through the Capture, Extract, Assemble, Publish

Functions

delegate_to_content(*method_names)

Decorator to delegate IO methods to the content stream property.

Module Contents

class julee.domain.models.document.document.Document(/, **data)

Bases: pydantic.BaseModel

Complete document entity including content and metadata.

This is the primary domain model that represents a complete document in the CEAP workflow system. Content is provided as a ContentStream for efficient handling of both small and large documents.

The content stream is excluded from JSON serialization - use separate content endpoints for streaming binary data over HTTP.

classmethod content_multihash_must_not_be_empty(v)

classmethod content_type_must_not_be_empty(v)

classmethod document_id_must_not_be_empty(v)

classmethod filename_must_not_be_empty(v)

validate_content_fields(info)

Ensure document has at least content, or content_bytes.

additional_metadata: dict[str, Any] = None

assembly_types: list[str] = None

content: julee.domain.models.custom_fields.content_stream.ContentStream | None = None

content_bytes: bytes | None = None

content_multihash: str = None

content_type: str

created_at: datetime.datetime | None = None

document_id: str

knowledge_service_id: str | None = None

original_filename: str

size_bytes: int = None

status: DocumentStatus

updated_at: datetime.datetime | None = None

class julee.domain.models.document.document.DocumentStatus

Bases: str, enum.Enum

Status of a document through the Capture, Extract, Assemble, Publish pipeline.

ASSEMBLED = 'assembled'

ASSEMBLY_SPECIFICATION_IDENTIFIED = 'assembly_specification_identified'

CAPTURED = 'captured'

EXTRACTED = 'extracted'

FAILED = 'failed'

PUBLISHED = 'published'

REGISTERED = 'registered'

julee.domain.models.document.document.delegate_to_content(*method_names)

Decorator to delegate IO methods to the content stream property.