corpus

type CollectionEntry struct {
	CollectionFile, GlossFile, Title, Summary, Intro, DateUpdated, Corpus string
	CorpusEntries                                                         []CorpusEntry
	AnalysisFile, Format, Date, Genre                                     string
}

type CorpusConfig struct {
	CorpusDataDir string
	CorpusDir     string
	Excluded      map[string]bool
	ProjectHome   string
	// contains filtered or unexported fields
}

type CorpusEntry struct {
	RawFile, GlossFile, Title, ColTitle, ColFile string
}

type CorpusLoader interface {

	// Method to get the corpus configuration
	// Parameter:
	//  r: to reader the text
	GetConfig() CorpusConfig

	// Method to get a single entry in a collection
	// Param:
	//   fName: The file name of the collection
	// Returns
	//   A CollectionEntry encapsulating the collection or an error
	GetCollectionEntry(fName string) (*CollectionEntry, error)

	// Method to load the entries in a collection
	// Param:
	//   fName: A file name containing the entries in the collection
	//   colTitle: The title of the collection
	LoadCollection(fName, colTitle string) (*[]CorpusEntry, error)

	// Method to load the collections in a corpus from the default file
	// Parameter:
	//  r: to read the listing of the collections
	LoadCollections() (*[]CollectionEntry, error)

	// Method to load the collections in a corpus
	// Parameter:
	//  r: to read the listing of the collections
	LoadCorpus(r io.Reader) (*[]CollectionEntry, error)

	// Method to read the contents of a corpus entry
	// Parameter:
	//  r: to reader the text
	ReadText(srcFile string) (string, error)
}