YomichanFormat class

A dictionary format for archives following the latest Yomichan bank schema. Example dictionaries for this format may be downloaded from the Yomichan website.

Details on the format can be found here: https://github.com/FooSoft/yomichan/blob/master/ext/data/schemas/dictionary-term-bank-v3-schema.json

Inheritance

Properties

allowedExtensions ↔ List<String>
This will be used to notify the user about the required extension if they select a file with the wrong extension. Elements should not include leading dots.
read / writeinherited
fileType → FileType
Whether or not the file picker supports the file extensions of this format.
finalinherited
hashCode → int
The hash code for this object.
read-onlyinherited
icon ↔ IconData
An appropriate icon for this dictionary format.
read / writeinherited
isTextFormat ↔ bool
If this is true, the charset of this format will be taken.
read / writeinherited
name ↔ String
The display name of this dictionary format. For example, this could be a 'Yomichan Dictionary' or 'ABBYY Lingvo'.
read / writeinherited
prepareDirectory ↔ Future<void> Function(PrepareDirectoryParams params)
IMPORTANT: The following parameters below point to functions defined in the top-level, not within the inheriting class. They are meant to be defined in the constructor -- the actual functions to be executed are outside of the class, placed preferably at the bottom of the inheriting format class. This is because these functions should not block the UI isolate and must be top-level in order to do so. Given a File, prepare files to be accessible in a working Directory such that it will be possible to make relative commands (in the directory) to be able to get a dictionary's name, its entries and other related metadata that will be useful for preservation.
read / writeinherited
prepareEntries ↔ Future<Map<DictionaryHeading, List<DictionaryEntry>>> Function(PrepareDictionaryParams params)
Prepares a map with entries that will be added to the database. See PrepareDictionaryParams for how to work with the individual input parameters.
read / writeinherited
prepareFrequencies ↔ Future<Map<DictionaryHeading, List<DictionaryFrequency>>> Function(PrepareDictionaryParams params)
Prepares a map with frequency entries that will be added to the database. See PrepareDictionaryParams for how to work with the individual input parameters.
read / writeinherited
prepareName ↔ Future<String> Function(PrepareDirectoryParams params)
Given a Directory of files pertaining to this dictionary format, return a String that will refer to a dictionary's name in this format.
read / writeinherited
preparePitches ↔ Future<Map<DictionaryHeading, List<DictionaryPitch>>> Function(PrepareDictionaryParams params)
Prepares a map with pitch entries that will be added to the database. See PrepareDictionaryParams for how to work with the individual input parameters.
read / writeinherited
prepareTags ↔ Future<List<DictionaryTag>> Function(PrepareDictionaryParams params)
Prepares a list of tags that will be added to the database. See PrepareDictionaryParams for how to work with the individual input parameters.
read / writeinherited
runtimeType → Type
A representation of the runtime type of the object.
read-onlyinherited
uniqueKey ↔ String
This is used to distinguish dictionary formats from one another, and to allow editing of the display name easily without having to worry about backwards compatibility.
read / writeinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Properties

instance → YomichanFormat
Get the singleton instance of this dictionary format.
read-only