infrastructure

Documentation

Index

• func NewBleveDocumentIndex(documentIndexPath string, documents domain.Documents) (domain.DocumentIndex, error)
• func NewDocumentArchiveFileSystemImpl(basePath string) (domain.DocumentArchive, error)
• func NewDocumentPreprocessorImpl(documents domain.Documents, documentArchive domain.DocumentArchive) domain.DocumentPreprocessor
• func NewDocuments(db *Database) domain.Documents
• func NewLocalAsyncTubeMailImpl() domain.TubeMail
• func NewUsers(db *Database) domain.Users
• type Database
  • func NewDatabase(config *config.Configuration) *Database
  • func (db *Database) Connect() error
  • func (db *Database) Migrate() error
  • func (db *Database) MigrateTo(version string) error
• type TesseractOcrEngine
  • func NewTesseractOcrEngine(documents domain.Documents, documentArchive domain.DocumentArchive) *TesseractOcrEngine
  • func (t *TesseractOcrEngine) ScanPage(documentNumber domain.DocumentNumber, pageNumber domain.PageNumber) error

Functions

func NewBleveDocumentIndex

func NewBleveDocumentIndex(
	documentIndexPath string,
	documents domain.Documents,
) (domain.DocumentIndex, error)

NewBleveDocumentIndex returns a document index implementation based on a local Bleve index.

func NewDocumentArchiveFileSystemImpl

func NewDocumentArchiveFileSystemImpl(basePath string) (domain.DocumentArchive, error)

NewDocumentArchiveFileSystemImpl returns a new document store using file system as a backend for storing documents.

func NewDocumentPreprocessorImpl

func NewDocumentPreprocessorImpl(
	documents domain.Documents,
	documentArchive domain.DocumentArchive,
) domain.DocumentPreprocessor

NewDocumentPreprocessorImpl returns a new simple preprocessor using Go's standard packages.

func NewDocuments

func NewDocuments(db *Database) domain.Documents

NewDocuments creates a new documents domain repository.

func NewLocalAsyncTubeMailImpl

func NewLocalAsyncTubeMailImpl() domain.TubeMail

NewLocalAsyncTubeMailImpl creates a new tube mail implementation using local channels.

func NewUsers

func NewUsers(db *Database) domain.Users

NewUsers creates a new users domain repository.

Types

type Database

type Database struct {
	*gorm.DB
	// contains filtered or unexported fields
}

Database defines a struct holding all required information for accessing the database.

func NewDatabase

func NewDatabase(config *config.Configuration) *Database

NewDatabase creates a new database using the given configuration.

func (*Database) Connect

func (db *Database) Connect() error

Connect tries to establish a connection to the configured database.

func (*Database) Migrate

func (db *Database) Migrate() error

Migrate migrates the given database instance to the latest version.

func (*Database) MigrateTo

func (db *Database) MigrateTo(version string) error

MigrateTo migrates the given database instance to the given version.

type TesseractOcrEngine

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

TesseractOcrEngine provides an interface to the Tesseract OCR engine.

func NewTesseractOcrEngine

func NewTesseractOcrEngine(
	documents domain.Documents,
	documentArchive domain.DocumentArchive,
) *TesseractOcrEngine

NewTesseractOcrEngine returns a new Tesseract OCR engine.

func (*TesseractOcrEngine) ScanPage

func (t *TesseractOcrEngine) ScanPage(
	documentNumber domain.DocumentNumber,
	pageNumber domain.PageNumber,
) error

RecognizePage executes OCR to get the text from the pages image content.