dictionary library

Classes

AbbyyLingvoFormat
A dictionary format for archives following the ABBYY Lingvo or DSL format compatible with GoldenDict.
DeleteDictionaryParams
For isolate communication purposes. Used for dictionary deletion.
Dictionary
A dictionary that can be imported into the application, encapsulating its metadata and current preferences.
DictionaryEntry
A database entity that represents single or multiple dictionary definitions, which can be in text, media or in a custom format.
DictionaryFormat
Information making up a supported dictionary format, as well as the methods that the format will use in a separate isolate for importing or enabling a dictionary of the matching format. Methods are top-level and should be defined in the global scope below the class declaration of a dictionary format.
DictionaryFrequency
A database entity that that represents supplementary frequency data for a certain search key.
DictionaryHeading
A database entity that that effectively acts as the primary key for a dictionary search. Dictionary headings, which specify the term and reading, may point to multiple dictionary entries.
DictionaryPitch
A database entity that that represents supplementary pitch accent data for a certain search key.
DictionarySearchParams
For isolate communication purposes. Used for dictionary search.
DictionarySearchResult
A database entity for storing references to DictionaryEntry results that are yielded from dictionary database searches.
DictionaryTag
A database entity for tags, heavily based on the Yomichan format.
IsolateParams
Base entity which allows messaging updates from other isolates.
MigakuFormat
A dictionary format for archives following the ABBYY Lingvo or DSL format compatible with GoldenDict.
PrepareDictionaryParams
For isolate communication purposes. See a dictionary fformat's name, entries and metadata preparation methods. Some parameters may be null at certain stages of the import.
PrepareDirectoryParams
For isolate communication purposes. See a dictionary format's directory preparation method.
UpdateDictionaryHistoryParams
For isolate communication purposes. Used for dictionary deletion.
YomichanFormat
A dictionary format for archives following the latest Yomichan bank schema. Example dictionaries for this format may be downloaded from the Yomichan website.

Extensions

DictionaryByIndex
DictionaryEntryQueryFilter
DictionaryEntryQueryObject
DictionaryEntryQueryProperty
DictionaryEntryQuerySortBy
DictionaryEntryQuerySortThenBy
DictionaryEntryQueryWhere
DictionaryEntryQueryWhereDistinct
DictionaryEntryQueryWhereSort
DictionaryFrequencyQueryFilter
DictionaryFrequencyQueryObject
DictionaryFrequencyQueryProperty
DictionaryFrequencyQuerySortBy
DictionaryFrequencyQuerySortThenBy
DictionaryFrequencyQueryWhere
DictionaryFrequencyQueryWhereDistinct
DictionaryFrequencyQueryWhereSort
DictionaryHeadingQueryFilter
DictionaryHeadingQueryObject
DictionaryHeadingQueryProperty
DictionaryHeadingQuerySortBy
DictionaryHeadingQuerySortThenBy
DictionaryHeadingQueryWhere
DictionaryHeadingQueryWhereDistinct
DictionaryHeadingQueryWhereSort
DictionaryPitchQueryFilter
DictionaryPitchQueryObject
DictionaryPitchQueryProperty
DictionaryPitchQuerySortBy
DictionaryPitchQuerySortThenBy
DictionaryPitchQueryWhere
DictionaryPitchQueryWhereDistinct
DictionaryPitchQueryWhereSort
DictionaryQueryFilter
DictionaryQueryObject
DictionaryQueryProperty
DictionaryQuerySortBy
DictionaryQuerySortThenBy
DictionaryQueryWhere
DictionaryQueryWhereDistinct
DictionaryQueryWhereSort
DictionarySearchResultByIndex
DictionarySearchResultQueryFilter
DictionarySearchResultQueryObject
DictionarySearchResultQueryProperty
DictionarySearchResultQuerySortBy
DictionarySearchResultQuerySortThenBy
DictionarySearchResultQueryWhere
DictionarySearchResultQueryWhereDistinct
DictionarySearchResultQueryWhereSort
DictionaryTagQueryFilter
DictionaryTagQueryObject
DictionaryTagQueryProperty
DictionaryTagQuerySortBy
DictionaryTagQuerySortThenBy
DictionaryTagQueryWhere
DictionaryTagQueryWhereDistinct
DictionaryTagQueryWhereSort
GetDictionaryCollection
GetDictionaryEntryCollection
GetDictionaryFrequencyCollection
GetDictionaryHeadingCollection
GetDictionaryPitchCollection
GetDictionarySearchResultCollection
GetDictionaryTagCollection

Constants

DictionaryEntrySchema → const CollectionSchema<DictionaryEntry>
CollectionSchema(name: r'DictionaryEntry', id: 433168435156867289, properties: {r'audioPaths' : PropertySchema(id: 0, name: r'audioPaths', type: IsarType.stringList), r'com…
DictionaryFrequencySchema → const CollectionSchema<DictionaryFrequency>
CollectionSchema(name: r'DictionaryFrequency', id: 2045353883102057112, properties: {r'displayValue' : PropertySchema(id: 0, name: r'displayValue', type: IsarType.string), r…
DictionaryHeadingSchema → const CollectionSchema<DictionaryHeading>
CollectionSchema(name: r'DictionaryHeading', id: 6765306005060595698, properties: {r'hashCode' : PropertySchema(id: 0, name: r'hashCode', type: IsarType.long), r'reading…
DictionaryPitchSchema → const CollectionSchema<DictionaryPitch>
CollectionSchema(name: r'DictionaryPitch', id: 7201735020230863881, properties: {r'downstep' : PropertySchema(id: 0, name: r'downstep', type: IsarType.long), r'hashCode'…
DictionarySchema → const CollectionSchema<Dictionary>
CollectionSchema(name: r'Dictionary', id: 9038313064164341215, properties: {r'collapsedLanguages' : PropertySchema(id: 0, name: r'collapsedLanguages', type: IsarType.stringList…
DictionarySearchResultSchema → const CollectionSchema<DictionarySearchResult>
CollectionSchema(name: r'DictionarySearchResult', id: -3666556092569216780, properties: {r'bestLength' : PropertySchema(id: 0, name: r'bestLength', type: IsarType.long), r'…
DictionaryTagSchema → const CollectionSchema<DictionaryTag>
CollectionSchema(name: r'DictionaryTag', id: -279734119535561079, properties: {r'category' : PropertySchema(id: 0, name: r'category', type: IsarType.string), r'dictionaryId…

Functions

deleteDictionariesHelper(DeleteDictionaryParams params) Future<void>
Clears all data from the dictionary database.
deleteDictionaryHelper(DeleteDictionaryParams params) Future<void>
Clears single dictionary data from the dictionary database.
depositDictionaryDataHelper(PrepareDictionaryParams params) Future<void>
Performed in another isolate with compute. This is a top-level utility function that makes use of Isar allowing instances to be opened through multiple isolates. The function for preparing entries and tags according to the DictionaryFormat is also done in the same isolate, to remove having to communicate potentially hundreds of thousands of entries to another newly opened isolate.
fastHash(String string) int
FNV-1a 64bit hash algorithm optimized for Dart Strings. This is used to generate integer IDs that can be hard assigned to entities with string IDs with microscopically low collision. This allows for example, a DictionaryHeading's ID to always be determinable by its composite parameters.
preloadResultSync(int id) → void
Preloads the entities linked to a search result.
prepareDirectoryAbbyyLingvoFormat(PrepareDirectoryParams params) Future<void>
Top-level function for use in compute. See DictionaryFormat for details.
prepareDirectoryMigakuFormat(PrepareDirectoryParams params) Future<void>
Top-level function for use in compute. See DictionaryFormat for details.
prepareDirectoryYomichanFormat(PrepareDirectoryParams params) Future<void>
Top-level function for use in compute. See DictionaryFormat for details.
prepareEntriesAbbyyLingvoFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryEntry>>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareEntriesMigakuFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryEntry>>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareEntriesYomichanFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryEntry>>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareFrequenciesAbbyyLingvoFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryFrequency>>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareFrequenciesMigakuFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryFrequency>>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareFrequenciesYomichanFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryFrequency>>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareNameAbbyyLingvoFormat(PrepareDirectoryParams params) Future<String>
Top-level function for use in compute. See DictionaryFormat for details.
prepareNameMigakuFormat(PrepareDirectoryParams params) Future<String>
Top-level function for use in compute. See DictionaryFormat for details.
prepareNameYomichanFormat(PrepareDirectoryParams params) Future<String>
Top-level function for use in compute. See DictionaryFormat for details.
preparePitchesAbbyyLingvoFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryPitch>>>
Top-level function for use in compute. See DictionaryFormat for details.
preparePitchesMigakuFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryPitch>>>
Top-level function for use in compute. See DictionaryFormat for details.
preparePitchesYomichanFormat(PrepareDictionaryParams params) Future<Map<DictionaryHeading, List<DictionaryPitch>>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareTagsAbbyyLingvoFormat(PrepareDictionaryParams params) Future<List<DictionaryTag>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareTagsMigakuFormat(PrepareDictionaryParams params) Future<List<DictionaryTag>>
Top-level function for use in compute. See DictionaryFormat for details.
prepareTagsYomichanFormat(PrepareDictionaryParams params) Future<List<DictionaryTag>>
Top-level function for use in compute. See DictionaryFormat for details.
updateDictionaryHistoryHelper(UpdateDictionaryHistoryParams params) Future<void>
Add a DictionarySearchResult to the dictionary history. If the maximum value is exceed, the dictionary history is cut down to the newest values.