domain

type ContentKey string

type Count int64

type Document struct {
	DocumentNumber DocumentNumber
	Title          Text
	Date           *time.Time
	State          DocumentState
	Fingerprint    Fingerprint
	Type           DocumentType
	IsInReview     bool
	CreatedAt      time.Time
	UpdatedAt      time.Time

	Owner *User
	Pages []DocumentPage
}

type DocumentAnalyzer interface {
	ScanPage(documentNumber DocumentNumber, pageNumber PageNumber) error
}

type DocumentArchive interface {
	// ReadContent returns the content of a document or page from the store.
	ReadContent(documentNumber DocumentNumber, contentKey ContentKey) (io.ReadCloser, error)

	// StoreContent stores content for a new document or page.
	StoreContent(documentNumber DocumentNumber, contentKey ContentKey, content io.Reader) error

	// MoveContent moves the stored content of one key to another.
	MoveContent(documentNumber DocumentNumber, sourceContentKey ContentKey, destinationContentKey ContentKey) error

	// DeleteContent deletes the content for a document or page from the store.
	DeleteContent(documentNumber DocumentNumber, contentKey ContentKey) error
}

type DocumentGenerator interface {
	// Generate generates the given document and returns a reader
	// for the generated content.
	Generate(document *Document) (io.Reader, error)
}

type DocumentIndex interface {
	// IndexAllDocuments reinserts all documents into the index.
	IndexAllDocuments() error

	// IndexDocument inserts or updates the index entry for the document with the given document number.
	IndexDocument(documentNumber DocumentNumber) error

	// Search returns all matching documents with respect to the given query.
	Search(query string, pr PageRequest) ([]DocumentSearchResult, Count, error)
}

type DocumentNumber uint

type DocumentPage struct {
	PageNumber  PageNumber
	State       PageState
	Text        Text
	Type        PageType
	Fingerprint Fingerprint
	IsInReview  bool
	Document    *Document
}

type DocumentPreprocessor interface {
	// PreprocessPage applies preprocessing to a document's page.
	PreprocessPage(documentNumber DocumentNumber, pageNumber PageNumber) error
}

type DocumentRegistry interface {
	Review(documentNumber DocumentNumber)
}

type DocumentSearchResult struct {
	Document *Document
}

type DocumentState string

type DocumentType string

type Documents interface {
	// Find returns the a subset of all documents with respect to the given page request.
	Find(pr PageRequest) ([]Document, Count, error)

	// FindByDocumentNumbers returns the subset of documents matching the set of document IDs.
	FindByDocumentNumbers(documentNumbers ...DocumentNumber) ([]Document, error)

	// FindByUsername returns the set of documents owned by the user
	// with the given username, alongside with the total count with respect to the given
	// page request.
	FindByUsername(username Name, pr PageRequest) ([]Document, Count, error)

	// GetByDocumentNumber returns the document with the given document number
	// or nil in case no such document exists.
	GetByDocumentNumber(documentNumber DocumentNumber) (*Document, error)

	// Add adds the given document without its pages.
	Add(document *Document) (*Document, error)

	// Update updates the given document without its pages.
	Update(document *Document) (*Document, error)

	// GetPagesByDocumentNumber returns all pages contained in the document for the given document number
	// alongside the total count of pages with respect to the given page request.
	GetPagesByDocumentNumber(documentNumber DocumentNumber, pr PageRequest) ([]DocumentPage, Count, error)

	// GetDocumentPageByDocumentNumberAndPageNumber returns the given document
	// page with the given page number, part of the document with the given
	// document number.
	GetPageByDocumentNumberAndPageNumber(
		documentNumber DocumentNumber,
		pageNumber PageNumber,
	) (*DocumentPage, error)

	// AddPage adds the given page to the document with the given document
	// number.
	AddPage(
		document DocumentNumber,
		page *DocumentPage,
	) (*DocumentPage, error)

	// UpdatePage saves the given document page associated to the given
	// document.
	UpdatePage(
		documentNumber DocumentNumber,
		page *DocumentPage,
	) (*DocumentPage, error)
}

type Error struct {
	// contains filtered or unexported fields
}

type Fingerprint string

type Mailbox string

type Name string

type PageNumber uint

type PageOffset = int

type PageRequest struct {
	Offset PageOffset
	Size   PageSize
	Sort   string
}

type PageSize = int

type PageState string

type PageType string

type Password string

type Receiver = func(...interface{}) error

type Text string

type TubeMail interface {
	// RegisterReceiver registers a new document receiver for a given mail box.
	RegisterReceiver(mailBox Mailbox, receiver TubeMailReceiver) error

	// SendMessage sends a message to a target mailbox.
	SendMessage(target Mailbox, message ...interface{}) error
}

type TubeMailReceiver = func(message ...interface{}) error

type User struct {
	Username Name
	Password Password
	Surname  Name
	Forename Name
	IsAdmin  bool
	IsActive bool
}

type Users interface {
	// GetByUsername returns the user with the given username or nil in case
	// no such user exists.
	GetByUsername(username Name) (*User, error)

	// Find returns the set of users and total count
	// with respect to the given page request.
	Find(page PageRequest) ([]User, Count, error)

	// Add adds a new user.
	Add(user *User) (*User, error)

	// Update updates the given user.
	Update(user *User) (*User, error)

	// Delete deletes the given user.
	Delete(user *User) error
}