JabRef 6.0-beta.1 · org.jabref.logic.importer.Importer

Modifier and Type	Field and Description
private static final Logger	LOGGER

Access	Constructor and Description
public	Importer()

Method Summary

Modifier and Type	Method and Description
public int	compareTo(Importer o) Implements java.lang.Comparable.compareTo. Compares this object with the specified object for order.
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
protected static Charset	getCharset(BufferedInputStream bufferedInputStream)
public abstract String	Returns: description of the import format getDescription() Returns the description of the import format.
public abstract FileType	Returns: `FileType` corresponding to the importer getFileType() Returns the type of files that this importer can read
public abstract String	Returns: ID, must be unique and not `null` getId() Returns a slug, which identifies this importer.
public abstract String	Returns: format name, must be unique and not `null` getName() Returns the name of this import format.
public static BufferedReader	getReader(Path filePath)
public static BufferedReader	getReader(InputStream stream)
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
public abstract ParserResult	importDatabase(BufferedReader the input to read from - there is no reset done. "BufferedReader" is only a convenience for the implementation input) Parse the database in the source.
public ParserResult	importDatabase(Path the path to the file which should be imported filePath) Parse the database in the specified file.
public ParserResult	Returns: the parsed result importDatabase(String the string which should be imported data) Parse the database in the specified string.
public boolean	isRecognizedFormat(BufferedReader input) Check whether the source is in the correct format for this importer.
public boolean	isRecognizedFormat(Reader input) #isRecognizedFormat(BufferedReader) without the requirement to reset
public boolean	Returns: true, if the file is in a recognized format isRecognizedFormat(Path the path of the file to check filePath) Check whether the source is in the correct format for this importer.
public boolean	Returns: true, if the data is in a recognized format isRecognizedFormat(String the data to check data) Check whether the source is in the correct format for this importer.
public boolean	supportsFileExtension(String the extension to check, without leading dot extension) Checks whether the file extension matches this importer.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

LOGGER	back to summary
private static final Logger LOGGER

Importer	back to summary
public Importer()

Method Detail

compareTo back to summary

compareTo	back to summary
public int compareTo(Importer o) Implements java.lang.Comparable.compareTo. Doc from java.lang.Comparable.compareTo. Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object. The implementor must ensure `signum(x.compareTo(y)) == -signum(y.compareTo(x))` for all `x` and `y`. (This implies that `x.compareTo(y)` must throw an exception if and only if `y.compareTo(x)` throws an exception.) The implementor must also ensure that the relation is transitive: `(x.compareTo(y) > 0 && y.compareTo(z) > 0)` implies `x.compareTo(z) > 0`. Finally, the implementor must ensure that `x.compareTo(y)==0` implies that `signum(x.compareTo(z)) == signum(y.compareTo(z))`, for all `z`. Annotations @Override

public int compareTo(Importer o)

Implements java.lang.Comparable.compareTo.

Doc from java.lang.Comparable.compareTo.

Compares this object with the specified object for order. Returns a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

The implementor must ensure signum(x.compareTo(y)) == -signum(y.compareTo(x)) for all x and y. (This implies that x.compareTo(y) must throw an exception if and only if y.compareTo(x) throws an exception.)

The implementor must also ensure that the relation is transitive: (x.compareTo(y) > 0 && y.compareTo(z) > 0) implies x.compareTo(z) > 0.

Finally, the implementor must ensure that x.compareTo(y)==0 implies that signum(x.compareTo(z)) == signum(y.compareTo(z)), for all z.

Annotations

@Override

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getCharset	back to summary
protected static Charset getCharset(BufferedInputStream bufferedInputStream)

getDescription back to summary

getDescription	back to summary
public abstract String getDescription() Returns the description of the import format. The description should specify what kind of entries from what sources and based on what specification it is able to import by what criteria it `isRecognizedFormat(BufferedReader)` recognizes an import format Returns:String description of the import format

public abstract String getDescription()

Returns the description of the import format.

The description should specify

what kind of entries from what sources and based on what specification it is able to import

by what criteria it isRecognizedFormat(BufferedReader) recognizes an import format

Returns:String: description of the import format

getFileType back to summary

getFileType	back to summary
public abstract FileType getFileType() Returns the type of files that this importer can read Returns:FileType `FileType` corresponding to the importer

public abstract FileType getFileType()

Returns the type of files that this importer can read

Returns:FileType: FileType corresponding to the importer

getId back to summary

getId	back to summary
public abstract String getId() Returns a slug, which identifies this importer. Used, for example, to identify the importer in CLI. Typically, this name should be short, in English, and should not contain special characters like #, %, etc. Returns:String ID, must be unique and not `null`

public abstract String getId()

Returns a slug, which identifies this importer. Used, for example, to identify the importer in CLI.

Typically, this name should be short, in English, and should not contain special characters like #, %, etc.

Returns:String: ID, must be unique and not null

getName back to summary

getName	back to summary
public abstract String getName() Returns the name of this import format. Typically, this is a string that denotes file type or format. It can also be localized, like "XMP-annotated PDF". Returns:String format name, must be unique and not `null`

public abstract String getName()

Returns the name of this import format. Typically, this is a string that denotes file type or format. It can also be localized, like "XMP-annotated PDF".

Returns:String: format name, must be unique and not null

getReader	back to summary
public static BufferedReader getReader(Path filePath) throws IOException

getReader	back to summary
public static BufferedReader getReader(InputStream stream)

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Annotations

@Override

importDatabase back to summary

importDatabase	back to summary
public abstract ParserResult importDatabase(BufferedReader input) throws IOException Parse the database in the source. This method can be called in two different contexts - either when importing in a specified format, or when importing in unknown format. In the latter case, JabRef cycles through all available import formats. No error messages or feedback is displayed from individual import formats in this case. If importing in a specified format and an empty library is returned, JabRef reports that no entries were found. If your format is binary-based (PDF, ZIP-based, or others), then you should not solely override this method. For binary formats do this: Throw `UnsupportedOperationException` in this method. Override the method `Importer#importDatabase(Path)`. Example of this workaround is in: `org.jabref.logic.importer.fileformat.pdf.PdfImporter`. Parameters input:BufferedReader the input to read from - there is no reset done. "BufferedReader" is only a convenience for the implementation

public abstract ParserResult importDatabase(BufferedReader input) throws IOException

Parse the database in the source.

This method can be called in two different contexts - either when importing in a specified format, or when importing in unknown format. In the latter case, JabRef cycles through all available import formats. No error messages or feedback is displayed from individual import formats in this case.

If importing in a specified format and an empty library is returned, JabRef reports that no entries were found.

If your format is binary-based (PDF, ZIP-based, or others), then you should not solely override this method. For binary formats do this:

Throw UnsupportedOperationException in this method.
Override the method Importer#importDatabase(Path). Example of this workaround is in: org.jabref.logic.importer.fileformat.pdf.PdfImporter.

Parameters

input:BufferedReader: the input to read from - there is no reset done. "BufferedReader" is only a convenience for the implementation

importDatabase	back to summary
public ParserResult importDatabase(Path filePath) throws IOException Parse the database in the specified file. Parameters filePath:Path the path to the file which should be imported

importDatabase

back to summary

public ParserResult importDatabase(Path filePath) throws IOException

Parse the database in the specified file.

Parameters

filePath:Path: the path to the file which should be imported

importDatabase back to summary

importDatabase	back to summary
public ParserResult importDatabase(String data) throws IOException Parse the database in the specified string. Importer having the facilities to detect the correct encoding of a string should overwrite this method, determine the encoding and then call `importDatabase(BufferedReader)`. Parameters data:String the string which should be imported Returns:ParserResult the parsed result Exceptions IOException: Signals that an I/O exception has occurred.

public ParserResult importDatabase(String data) throws IOException

Parse the database in the specified string.

Importer having the facilities to detect the correct encoding of a string should overwrite this method, determine the encoding and then call importDatabase(BufferedReader).

Parameters

data:String: the string which should be imported

Returns:ParserResult

the parsed result

Exceptions

IOException:: Signals that an I/O exception has occurred.

isRecognizedFormat	back to summary
public boolean isRecognizedFormat(BufferedReader input) throws IOException Check whether the source is in the correct format for this importer. All implementations need to reset the input stream to the beginning again - to enable importing at subsequent calls. The effect of this method is primarily to avoid unnecessary processing of files when searching for a suitable import format. If this method returns false, the import routine will move on to the next import format. Thus, the correct behavior is to return false if it is certain that the file is not of the suitable type, and true otherwise. Returning true is the safe choice if not certain.

isRecognizedFormat

back to summary

public boolean isRecognizedFormat(BufferedReader input) throws IOException

Check whether the source is in the correct format for this importer.

All implementations need to reset the input stream to the beginning again - to enable importing at subsequent calls.

The effect of this method is primarily to avoid unnecessary processing of files when searching for a suitable import format. If this method returns false, the import routine will move on to the next import format.

Thus, the correct behavior is to return false if it is certain that the file is not of the suitable type, and true otherwise. Returning true is the safe choice if not certain.

isRecognizedFormat	back to summary
public boolean isRecognizedFormat(Reader input) throws IOException #isRecognizedFormat(BufferedReader) without the requirement to reset

isRecognizedFormat	back to summary
public boolean isRecognizedFormat(Path filePath) throws IOException Check whether the source is in the correct format for this importer. Parameters filePath:Path the path of the file to check Returns:boolean true, if the file is in a recognized format Exceptions IOException: Signals that an I/O exception has occurred.

isRecognizedFormat

back to summary

public boolean isRecognizedFormat(Path filePath) throws IOException

Check whether the source is in the correct format for this importer.

Parameters

filePath:Path: the path of the file to check

Returns:boolean

true, if the file is in a recognized format

Exceptions

IOException:: Signals that an I/O exception has occurred.

isRecognizedFormat	back to summary
public boolean isRecognizedFormat(String data) throws IOException Check whether the source is in the correct format for this importer. Parameters data:String the data to check Returns:boolean true, if the data is in a recognized format Exceptions IOException: Signals that an I/O exception has occurred.

isRecognizedFormat

back to summary

public boolean isRecognizedFormat(String data) throws IOException

Check whether the source is in the correct format for this importer.

Parameters

data:String: the data to check

Returns:boolean

true, if the data is in a recognized format

Exceptions

IOException:: Signals that an I/O exception has occurred.

supportsFileExtension	back to summary
public boolean supportsFileExtension(String extension) Checks whether the file extension matches this importer. Parameters extension:String the extension to check, without leading dot

supportsFileExtension

back to summary

public boolean supportsFileExtension(String extension)

Checks whether the file extension matches this importer.

Parameters

extension:String: the extension to check, without leading dot

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public abstract Class Importer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

The description should specify

what kind of entries from what sources and based on what specification it is able to import