Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revert "Refine documentation" #8559

Merged
merged 1 commit into from
Mar 11, 2022
Merged

Revert "Refine documentation" #8559

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 1 addition & 12 deletions src/main/java/org/jabref/logic/importer/SearchBasedParserFetcher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
import java.util.List;

import org.jabref.logic.cleanup.Formatter;
import org.jabref.logic.importer.fetcher.MedlineFetcher;
import org.jabref.model.entry.BibEntry;

import org.apache.lucene.queryparser.flexible.core.nodes.QueryNode;
Expand All @@ -21,24 +20,14 @@
* <li>Post-process fetched entries</li>
* </ol>
* <p>
* Normally, a fetcher invokes an API and then parses the response (to get BibEntries).
* This kind of workflow is supported by the parser-based fetcher.
* Sometimes you need to have more flexibility, i.e. call multiple endpoints and merge the results etc.
* In theses cases, one has to use the non-parser-based fetcher interfaces.
* <p>
* <p>
* This interface is used for web resources which do NOT provide BibTeX data {@link BibEntry} directly.
* This interface is used for web resources which do NOT provide BibTeX data {@link BibEntry}.
* JabRef's infrastructure to convert arbitrary input data to BibTeX is {@link Parser}.
* </p>
* <p>
* This interface inherits {@link SearchBasedFetcher}, because the methods <code>performSearch</code> have to be provided by both.
* As non-BibTeX web fetcher one could do "magic" stuff without this helper interface and directly use {@link WebFetcher}, but this is more work.
* </p>
* <p>
* The idea is the one can reuse an importer in the place of a Parser.
* See {@link MedlineFetcher#getParser()} for an example.
* </p>
* <p>
* Note that this interface "should" be an abstract class.
* However, Java does not support multi inheritance with classes (but with interfaces).
* We need multi inheritance, because a fetcher might implement multiple query types (such as id fetching {@link IdBasedFetcher}), complete entry {@link EntryBasedFetcher}, and search-based fetcher (this class).
Expand Down