docs(dev): correct 15.8 data store plugin guide against implementation#447
Open
marevol wants to merge 1 commit into
Open
docs(dev): correct 15.8 data store plugin guide against implementation#447marevol wants to merge 1 commit into
marevol wants to merge 1 commit into
Conversation
Verify the developer guide for building a data store plugin against the current source code and fix inaccuracies, then re-translate every language version from the corrected Japanese source. - Fix storeData() signature: paramMap is DataStoreParams, not Map<String, String>; add the DataStoreParams import - Use paramMap.getAsString() instead of get() to read string parameters - Correct the field-mapping pipeline to match real connectors: build resultMap from paramMap.asMap() plus the source record, evaluate each scriptMap entry with convertValue(scriptType, template, resultMap), and call callback.store(paramMap, dataMap) - Use the correct DataConfig package (org.codelibs.fess.opensearch.config.exentity) - Show getName() as a protected method returning getClass().getSimpleName() - Add component registration via fess_ds++.xml (postConstruct register) - Add AbstractDataStore helper methods, a data-processing-flow section, and a build/installation section (pom.xml, mvn clean package, install) - Update the unit test example to JUnit 5 with UTFlute LastaDiTestCase - Re-translate en, de, es, fr, ko, and zh-cn (with correct diacritics)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The 15.8 developer guide for building a data store plugin (
dev/datastore-plugin.rst) was reviewed against the current source code (AbstractDataStore,DataStoreParams,IndexUpdateCallback, and thefess-ds-examplereference plugin) and corrected. All seven language versions were re-translated from the corrected Japanese source.Corrections
storeData()signature:paramMapisDataStoreParams, notMap<String, String>; added the missingDataStoreParamsimport.paramMap.getAsString()instead ofget()(DataStoreParamsdoes not implementMap).resultMapfromparamMap.asMap()plus the source record, evaluate eachscriptMapentry withconvertValue(scriptType, template, resultMap), then callcallback.store(paramMap, dataMap).DataConfigpackage: corrected toorg.codelibs.fess.opensearch.config.exentity.getName(): shown as aprotectedmethod returninggetClass().getSimpleName().LastaDiTestCaseand a collectingIndexUpdateCallback(previously JUnit 4).Added
fess_ds++.xmlwith<postConstruct name="register">).AbstractDataStorehelper methods (convertValue,getScriptType,getReadInterval,sleep) and a data-processing-flow section.pom.xmlwithfess-parent/providedscope,mvn clean package, plugin installation).Translations
en,de,es,fr,ko, andzh-cnre-translated from the corrected Japanese, restoring proper diacritics for German/French/Spanish. Structural parity (directives, code blocks, tables,:doc:references) verified across all languages, and every file parses cleanly with docutils.