Modifier and Type	Class and Description
public static interface	ImportFormatReader.CheckedFunction<T, R>
public static interface	ImportFormatReader.CheckedSupplier<R>
public static record	ImportFormatReader.ImportResult

Modifier and Type	Field and Description
public static final String	BIBTEX_FORMAT
private BibtexImporter	bibtexImporter
private final CitationKeyPatternPreferences	citationKeyPatternPreferences
private final FileUpdateMonitor	fileUpdateMonitor
private final ImporterPreferences	importerPreferences
private final List<Importer>	importers All import formats.
private final ImportFormatPreferences	importFormatPreferences
private static final Logger	LOGGER

Access	Constructor and Description
public	ImportFormatReader(ImporterPreferences importerPreferences, ImportFormatPreferences importFormatPreferences, CitationKeyPatternPreferences citationKeyPatternPreferences, FileUpdateMonitor fileUpdateMonitor)

Method Summary

Modifier and Type	Method and Description
private Optional<Importer>	Returns: Import Format or `null` if none matches getByCliId(String CLI-Id cliId) Format for a given CLI-ID. Will return the first format according to the default-order of format that matches the given ID.
public SortedSet<Importer>	getImporters() Returns: All importers, elements are sorted by name
public boolean	hasImporterForFile(Path filePath) Checks whether at least one registered importer supports the file extension.
public ParserResult	importFromFile(String format, Path file)
public ImportFormatReader.ImportResult	importWithAutoDetection(Path filePath) Tries to import a file by iterating through the available import filters, and keeping the import that seems most promising.
public ImportFormatReader.ImportResult	importWithAutoDetection(Reader reader) Tries to import a stream by iterating through the available import filters, and keeping the import that seems most promising.
public ImportFormatReader.ImportResult	Returns: an UnknownFormatImport with the imported entries and metadata importWithAutoDetection(@NonNull String the string to import data) Tries to import a String by iterating through the available import filters, and keeping the import that seems the most promising
private ImportFormatReader.ImportResult	Returns: an UnknownFormatImport with the imported entries and metadata importWithAutoDetection(ImportFormatReader.CheckedFunction<Importer, ParserResult> the function to import the entries with a formatter importDatabase, ImportFormatReader.CheckedFunction<Importer, Boolean> the function to check whether the source is in the correct format for an importer isRecognizedFormat, ImportFormatReader.CheckedSupplier<ParserResult> used as fallback when the importers did not match importUsingBibtex) Tries to import entries by iterating through the available import filters, and keeping the import that seems the most promising The implementation idea is to be independent of BufferedInputStream vs. File.
public void	reset()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BIBTEX_FORMAT	back to summary
public static final String BIBTEX_FORMAT

bibtexImporter	back to summary
private BibtexImporter bibtexImporter

citationKeyPatternPreferences	back to summary
private final CitationKeyPatternPreferences citationKeyPatternPreferences

fileUpdateMonitor	back to summary
private final FileUpdateMonitor fileUpdateMonitor

importerPreferences	back to summary
private final ImporterPreferences importerPreferences

importers	back to summary
private final List<Importer> importers All import formats. Sorted accordingly to `Importer#compareTo`, which defaults to alphabetically by the name

importFormatPreferences	back to summary
private final ImportFormatPreferences importFormatPreferences

LOGGER	back to summary
private static final Logger LOGGER

Constructor Detail

ImportFormatReader	back to summary
public ImportFormatReader(ImporterPreferences importerPreferences, ImportFormatPreferences importFormatPreferences, CitationKeyPatternPreferences citationKeyPatternPreferences, FileUpdateMonitor fileUpdateMonitor)

Method Detail

getByCliId back to summary

getByCliId	back to summary
private Optional<Importer> getByCliId(String cliId) Format for a given CLI-ID. Will return the first format according to the default-order of format that matches the given ID. Parameters cliId:String CLI-Id Returns:Optional<Importer> Import Format or `null` if none matches

private Optional<Importer> getByCliId(String cliId)

Format for a given CLI-ID.

Will return the first format according to the default-order of format that matches the given ID.

Parameters

cliId:String: CLI-Id

Returns:Optional<Importer>

Import Format or null if none matches

getImporters	back to summary
public SortedSet<Importer> getImporters() Returns:SortedSet<Importer> All importers, elements are sorted by name

hasImporterForFile	back to summary
public boolean hasImporterForFile(Path filePath) Checks whether at least one registered importer supports the file extension.

importFromFile	back to summary
public ParserResult importFromFile(String format, Path file) throws ImportException

importWithAutoDetection	back to summary
public ImportFormatReader.ImportResult importWithAutoDetection(Path filePath) throws ImportException Tries to import a file by iterating through the available import filters, and keeping the import that seems most promising. This method last attempts to read this file as bibtex. Exceptions ImportException: if the import fails (for example, if no suitable importer is found)

importWithAutoDetection

back to summary

public ImportFormatReader.ImportResult importWithAutoDetection(Path filePath) throws ImportException

Tries to import a file by iterating through the available import filters, and keeping the import that seems most promising.

This method last attempts to read this file as bibtex.

Exceptions

ImportException:: if the import fails (for example, if no suitable importer is found)

importWithAutoDetection	back to summary
public ImportFormatReader.ImportResult importWithAutoDetection(Reader reader) throws ImportException Tries to import a stream by iterating through the available import filters, and keeping the import that seems most promising. Exceptions ImportException: if the import fails (for example, if no suitable importer is found)

importWithAutoDetection

back to summary

public ImportFormatReader.ImportResult importWithAutoDetection(Reader reader) throws ImportException

Tries to import a stream by iterating through the available import filters, and keeping the import that seems most promising.

Exceptions

ImportException:: if the import fails (for example, if no suitable importer is found)

importWithAutoDetection	back to summary
public ImportFormatReader.ImportResult importWithAutoDetection(@NonNull String data) throws ImportException Tries to import a String by iterating through the available import filters, and keeping the import that seems the most promising Parameters data:@NonNull String the string to import Returns:ImportFormatReader.ImportResult an UnknownFormatImport with the imported entries and metadata Exceptions ImportException: if the import fails (for example, if no suitable importer is found)

importWithAutoDetection

back to summary

public ImportFormatReader.ImportResult importWithAutoDetection(@NonNull String data) throws ImportException

Tries to import a String by iterating through the available import filters, and keeping the import that seems the most promising

Parameters

data:@NonNull String: the string to import

Returns:ImportFormatReader.ImportResult

an UnknownFormatImport with the imported entries and metadata

Exceptions

ImportException:: if the import fails (for example, if no suitable importer is found)

importWithAutoDetection	back to summary
private ImportFormatReader.ImportResult importWithAutoDetection(ImportFormatReader.CheckedFunction<Importer, ParserResult> importDatabase, ImportFormatReader.CheckedFunction<Importer, Boolean> isRecognizedFormat, ImportFormatReader.CheckedSupplier<ParserResult> importUsingBibtex) throws ImportException Tries to import entries by iterating through the available import filters, and keeping the import that seems the most promising The implementation idea is to be independent of BufferedInputStream vs. File. Therefore, functions are passed. Parameters importDatabase:ImportFormatReader.CheckedFunction<Importer, ParserResult> the function to import the entries with a formatter isRecognizedFormat:ImportFormatReader.CheckedFunction<Importer, Boolean> the function to check whether the source is in the correct format for an importer importUsingBibtex:ImportFormatReader.CheckedSupplier<ParserResult> used as fallback when the importers did not match Returns:ImportFormatReader.ImportResult an UnknownFormatImport with the imported entries and metadata Exceptions ImportException: if the import fails (for example, if no suitable importer is found)

importWithAutoDetection

back to summary

private ImportFormatReader.ImportResult importWithAutoDetection(ImportFormatReader.CheckedFunction<Importer, ParserResult> importDatabase, ImportFormatReader.CheckedFunction<Importer, Boolean> isRecognizedFormat, ImportFormatReader.CheckedSupplier<ParserResult> importUsingBibtex) throws ImportException

Tries to import entries by iterating through the available import filters, and keeping the import that seems the most promising

The implementation idea is to be independent of BufferedInputStream vs. File. Therefore, functions are passed.

Parameters

importDatabase:ImportFormatReader.CheckedFunction<Importer, ParserResult>: the function to import the entries with a formatter
isRecognizedFormat:ImportFormatReader.CheckedFunction<Importer, Boolean>: the function to check whether the source is in the correct format for an importer
importUsingBibtex:ImportFormatReader.CheckedSupplier<ParserResult>: used as fallback when the importers did not match

Returns:ImportFormatReader.ImportResult

an UnknownFormatImport with the imported entries and metadata

Exceptions

ImportException:: if the import fails (for example, if no suitable importer is found)

reset	back to summary
public void reset()

org.jabref.logic.importer back to summary

public Interface ImportFormatReader.CheckedFunction<T, R>

Annotations

@FunctionalInterface

Method Summary

Modifier and Type	Method and Description
public R	apply(T t)

Method Detail

apply	back to summary
public R apply(T t) throws IOException

org.jabref.logic.importer back to summary

public Interface ImportFormatReader.CheckedSupplier<R>

Annotations

@FunctionalInterface

Method Summary

Modifier and Type	Method and Description
public R	apply()

Method Detail

apply	back to summary
public R apply() throws IOException

org.jabref.logic.importer back to summary

public final Record ImportFormatReader.ImportResult

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.importer.ImportFormatReader.ImportResult

Record Components

format:String: The name of the format used
parserResult:ParserResult: The resulting data

Field Summary

Modifier and Type	Field and Description
private final String	format Record Component accessed by format(). The name of the format used
private final ParserResult	parserResult Record Component accessed by parserResult(). The resulting data

Constructor Summary

Access	Constructor and Description
public	ImportResult(String format, ParserResult parserResult)

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object o) Implements abstract java.lang.Record.equals. Indicates whether some other object is "equal to" this one.
public String	format() Record Component getter of format. Record Component The name of the format used
public final int	hashCode() Implements abstract java.lang.Record.hashCode. Returns a hash code value for the record.
public ParserResult	parserResult() Record Component getter of parserResult. Record Component The resulting data
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

format	back to summary
private final String format Record Component accessed by format(). The name of the format used

format

back to summary

private final String format

Record Component accessed by format().

The name of the format used

parserResult	back to summary
private final ParserResult parserResult Record Component accessed by parserResult(). The resulting data

parserResult

back to summary

private final ParserResult parserResult

Record Component accessed by parserResult().

The resulting data

Constructor Detail

ImportResult	back to summary
public ImportResult(String format, ParserResult parserResult)

Method Detail

equals back to summary

equals	back to summary
public final boolean equals(Object o) Implements abstract java.lang.Record.equals. Doc from java.lang.Record.equals. Indicates whether some other object is "equal to" this one. In addition to the general contract of `Object.equals`, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows: R copy = new R(r.c1(), r.c2(), ..., r.cn()); then it must be the case that `r.equals(copy)`.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

Indicates whether some other object is "equal to" this one. In addition to the general contract of Object.equals, record classes must further obey the invariant that when a record instance is "copied" by passing the result of the record component accessor methods to the canonical constructor, as follows:

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

format	back to summary
public String format() Record Component getter of format. Record Component The name of the format used

format

back to summary

public String format()

Record Component getter of format.

Record Component: The name of the format used

hashCode back to summary

hashCode	back to summary
public final int hashCode() Implements abstract java.lang.Record.hashCode. Doc from java.lang.Record.hashCode. Returns a hash code value for the record. Obeys the general contract of `Object.hashCode`. For records, hashing behavior is constrained by the refined contract of `Record.equals`, so that any two records created from the same components must have the same hash code.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns a hash code value for the record. Obeys the general contract of Object.hashCode. For records, hashing behavior is constrained by the refined contract of Record.equals, so that any two records created from the same components must have the same hash code.

parserResult	back to summary
public ParserResult parserResult() Record Component getter of parserResult. Record Component The resulting data

parserResult

back to summary

public ParserResult parserResult()

Record Component getter of parserResult.

Record Component: The resulting data

toString back to summary

toString	back to summary
public final String toString() Implements abstract java.lang.Record.toString. Doc from java.lang.Record.toString. Returns a string representation of the record. In accordance with the general contract of `Object#toString()`, the `toString` method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read. In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns a string representation of the record. In accordance with the general contract of Object#toString(), the toString method returns a string that "textually represents" this record. The result should be a concise but informative representation that is easy for a person to read.

In addition to this general contract, record classes must further participate in the invariant that any two records which are equal must produce equal strings. This invariant is necessarily relaxed in the rare case where corresponding equal component values might fail to produce equal strings for themselves.

public Class ImportFormatReader

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface ImportFormatReader.CheckedFunction<T, R>

Method Summary

Method Detail

public Interface ImportFormatReader.CheckedSupplier<R>

Method Summary

Method Detail

public final Record ImportFormatReader.ImportResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail