Feature/related work annotator

[jsochava]

Closes #14085

This Draft PR introduces a complete, deterministic pipeline for harvesting contextual summaries from a citing paper’s “Related Work” section and appending them to the appropriate BibEntry records.

What and why

1. RelatedWorkAnnotator.java

• Appends contextual summaries from a citing paper’s “Related Work” section into a target BibEntry.
• Uses JabRef’s comment- convention (resolved as UserSpecificCommentField).

2. HeuristicRelatedWorkExtractor.java

• Deterministic parser that locates author–year citations (e.g. (Vesce et al., 2016), (Bianchi, 2021)) within Related Work text.
• Extracts descriptive snippets surrounding each citation.
• Matches each citation to an existing BibEntry by first author surname + year.
• Implemented without AI dependencies; designed for reliability and transparent logic.

3. RelatedWorkHarvester.java

• High-level orchestrator that connects the extractor and annotator:
• Accepts PDF-extracted or plain text input.
• Calls the extractor to identify citation–context pairs.
• Invokes RelatedWorkAnnotator.appendSummaryToEntry(...) for each match.

4. RelatedWorkSectionLocator.java

• Deterministically isolates the “Related Work” / “Literature Review” / “Prior Work” / “Background and Related Work” section from a paper’s full plain text.
• Recognizes numeric and textual headers.
• Captures content until the next top-level header, ignoring figure/table captions and unrelated content.

5. RelatedWorkPipeline.java

• Introduces a convenience façade that chains the full extraction process:
  - SectionLocator → HeuristicRelatedWorkExtractor → RelatedWorkAnnotator
• Enables single-call usage for clients that have the full plain text and a list of candidate BibEntry objects.

6. PdfTextProvider.java
   -A tiny SPI interface: Path -> Optional plain-text extraction.
   -Keeps all PDF specifics behind a seam; facilitates unit testing with fakes/mocks and avoids hard deps in core logic.

7. PdfRelatedWorkTextExtractor.java

• Adapter: PDF -> plain text (via PdfTextProvider) → “Related Work” block (via RelatedWorkSectionLocator).
• Returns Optional with the body of the section (header stripped), or empty if not found/blank.
• Validates inputs and surfaces IO errors; does not depend on any PDF library directly.

8. RelatedWorkPdfPipeline.java

• End-to-end façade for callers that have a PDF and candidate entries:
• PdfRelatedWorkTextExtractor → HeuristicRelatedWorkExtractor → RelatedWorkAnnotator.
• Returns the number of annotations appended across matched entries.

9. RelatedWorkEvaluationRunner.java

• Deterministic evaluator comparing extracted (citation → snippet) pairs against gold fixtures.
• Computes precision, recall, F1, and coverage statistics.
• Supports in-memory or JSON-based fixture definitions.

10. RelatedWorkMetrics.java

• Immutable results object summarizing global and per-entry metrics.
• Includes pretty-printed summaries and detailed statistics for debugging.

11. RelatedWorkFixture.java

• Simple model for “gold” fixture data: includes related-work text and expected (author, year, snippet) expectations.
• Supports direct in-memory creation or loading from a JSON file.

12. HeuristicExtractorAdapter.java

• Bridge layer converting the HeuristicRelatedWorkExtractor output (Map<String, String>) into the Map<BibEntry, List> format expected by the evaluation runner.
• Keeps the original extractor untouched.

13. RelatedWorkSummarizer.java / NoOpRelatedWorkSummarizer.java

• SPI interface for optional snippet summarization.
• Default no-op implementation returns empty → the harvester keeps individual snippets unchanged.
• Future AI integrations (e.g., LangChain4j or OpenAI) can implement this interface.

14. CitationResolver.java / NoOpCitationResolver.java

• SPI interface for resolving missing citations by key or author–year, optionally creating new entries.
• Default implementation performs a simple local lookup and never creates entries.

15. RelatedWorkPluginConfig.java + RelatedWorkPluginsFactory.java

• Lightweight configuration object with feature flags:
  - enableSummarization
  - enableResolution
• Provides builder methods to safely compose plugin pipelines.
• Used by RelatedWorkHarvester to inject summarizer and resolver instances.
• Default build → no-op config (preserves old behavior).

Next steps

1. PDF text extraction

• Integrate JabRef’s existing PDF parsing utilities or the LangChain4j interface to automatically extract the “Related Work” section from PDFs.
• Focus on reliable section header detection (e.g., Related Work, Literature Review).

2. Reference lookup

• For each parsed in-text citation:
  - Match to an existing library entry.
  - If missing, create a new BibEntry and annotate it.

3. AI-Assisted Context Summarization

• Optional integration with LangChain4j for generating concise natural-language summaries when multiple snippets exist.

Steps to test

1. Run the unit tests for the new features only:

   ./gradlew :jablib:test --tests "org.jabref.logic.importer.RelatedWorkAnnotatorTest"
   ./gradlew :jablib:test --tests "org.jabref.logic.importer.relatedwork.HeuristicRelatedWorkExtractorTest"
   ./gradlew :jablib:test --tests "org.jabref.logic.importer.relatedwork.RelatedWorkHarvesterTest"
   ./gradlew :jablib:test --tests "org.jabref.logic.importer.relatedwork.RelatedWorkSectionLocatorTest"
   ./gradlew :jablib:test --tests "org.jabref.logic.importer.relatedwork.PdfRelatedWorkTextExtractorTest"
   ./gradlew :jablib:test --tests "org.jabref.logic.importer.relatedwork.RelatedWorkMetricsTest"

Mandatory checks

• I own the copyright of the code submitted and I license it under the MIT license
• I manually tested my changes in running JabRef (always required)
• I added JUnit tests for changes (if applicable)
• [/] I added screenshots in the PR description (if change is visible to the user)
• [/] I described the change in CHANGELOG.md in a way that is understandable for the average user (if change is visible to the user)
• [/] I checked the user documentation: Is the information available and up to date? If not, I created an issue at https://github.com/JabRef/user-documentation/issues or, even better, I submitted a pull request updating file(s) in https://github.com/JabRef/user-documentation/tree/main/en.

[github-actions]

Hey @jsochava!

Thank you for contributing to JabRef! Your help is truly appreciated ❤️.

We have automatic checks in place, based on which you will soon get automated feedback if any of them are failing. We also use TragBot with custom rules that scans your changes and provides some preliminary comments, before a maintainer takes a look. TragBot is still learning, and may not always be accurate. In the "Files changed" tab, you can go through its comments and just click on "Resolve conversation" if you are sure that it is incorrect, or comment on the conversation if you are doubtful.

Please re-check our contribution guide in case of any other doubts related to our contribution workflow.

[koppor]

Please check your IDE config. It seems you refomatted too much with the wrong style. Hard to give content feedback.

[jsochava]

@koppor when I used the IDE config described in the project's setup instructions, I consistently failed the automatic format checks. Is that expected?