mugiten/jadb
2
0
Fork 0
Code Issues 45 Pull Requests Actions Activity

lib/search: document public search functions

Browse Source
This commit is contained in:
Oystein Kristoffer Tveit
2025-05-19 16:40:36 +02:00
parent 128dd14a0d
commit ebe29db092
2 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
lib/search.dart
View File

@@ -12,18 +12,27 @@ class JaDBConnection {
const JaDBConnection(this._connection);
/// Search for a kanji in the database.
Future<KanjiSearchResult?> searchKanji(String kanji) =>
searchKanjiWithDbConnection(this._connection, kanji);
/// Search for a word in the database.
Future<List<WordSearchResult>?> searchWord(String word) =>
searchWordWithDbConnection(this._connection, word);
/// Search for a word in the database, and return the count of results.
Future<int?> searchWordCount(String word) =>
searchWordCountWithDbConnection(this._connection, word);
/// Given a list of radicals, search which kanji contains all
/// of the radicals, find their other radicals, and return those.
/// This is used to figure out which remaining combinations of radicals
/// the user can search for without getting zero results.
Future<List<String>> searchRemainingRadicals(List<String> radicals) =>
searchRemainingRadicalsWithDbConnection(this._connection, radicals);
/// Given a list of radicals, search which kanji contains all
/// of the radicals, and return those.
Future<List<String>> searchKanjiByRadicals(List<String> radicals) =>
searchKanjiByRadicalsWithDbConnection(this._connection, radicals);
}

6
lib/search/radical_search.dart
View File

@@ -2,10 +2,6 @@ import 'package:sqflite_common/sqlite_api.dart';
// TODO: validate that the list of radicals all are valid radicals
/// Given a list of radicals, search which kanji contains all
/// of the radicals, find their other radicals, and return those.
/// This is used to figure out which remaining combinations of radicals
/// the user can search for without getting zero results.
Future<List<String>> searchRemainingRadicalsWithDbConnection(
DatabaseExecutor connection,
List<String> radicals,
@@ -34,8 +30,6 @@ Future<List<String>> searchRemainingRadicalsWithDbConnection(
return remainingRadicals;
}
/// Given a list of radicals, search which kanji contains all
/// of the radicals, and return those.
Future<List<String>> searchKanjiByRadicalsWithDbConnection(
DatabaseExecutor connection,
List<String> radicals,