Modifier and Type	Class and Description
private static class	CffImporter.CffEntity
private static class	CffImporter.CffFormat
private static class	CffImporter.CffIdentifier
private static class	CffImporter.CffReference

Modifier and Type	Field and Description
private final CitationKeyPatternPreferences	citationKeyPatternPreferences
public static final Map<String, Field>	FIELDS_MAP
public static final Map<String, EntryType>	TYPES_MAP

Access	Constructor and Description
public	CffImporter(CitationKeyPatternPreferences citationKeyPatternPreferences)

Method Summary

Modifier and Type	Method and Description
public String	getDescription() Implements abstract org.jabref.logic.importer.Importer.getDescription. Returns the description of the import format.
public StandardFileType	getFileType() Implements abstract org.jabref.logic.importer.Importer.getFileType. Returns the type of files that this importer can read
public String	getId() Overrides org.jabref.logic.importer.Importer.getId. Returns a one-word ID which identifies this importer.
public String	getName() Implements abstract org.jabref.logic.importer.Importer.getName. Returns the name of this import format.
public ParserResult	importDatabase(BufferedReader the input to read from reader) Implements abstract org.jabref.logic.importer.Importer.importDatabase. Parse the database in the source.
public boolean	isRecognizedFormat(BufferedReader reader) Implements abstract org.jabref.logic.importer.Importer.isRecognizedFormat. Check whether the source is in the correct format for this importer.
private String	parseAuthors(List<CffImporter.CffEntity> authors)
private BibEntry	parseEntry(CffImporter.CffReference reference)
private void	parseFields(Map<String, String> values, Map<Field, String> entryMap)

Inherited from org.jabref.logic.importer.Importer:: compareTo equals getCharset getReader getReader hashCode importDatabase importDatabase isRecognizedFormat isRecognizedFormat toString

Field Detail

citationKeyPatternPreferences	back to summary
private final CitationKeyPatternPreferences citationKeyPatternPreferences

FIELDS_MAP	back to summary
public static final Map<String, Field> FIELDS_MAP

TYPES_MAP	back to summary
public static final Map<String, EntryType> TYPES_MAP

Constructor Detail

CffImporter	back to summary
public CffImporter(CitationKeyPatternPreferences citationKeyPatternPreferences)

Method Detail

getDescription back to summary

getDescription	back to summary
public String getDescription() Implements abstract org.jabref.logic.importer.Importer.getDescription. Doc from org.jabref.logic.importer.Importer.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 `recognizes` an import format Returns:String description of the import format Annotations @Override

public String getDescription()

Implements abstract org.jabref.logic.importer.Importer.getDescription.

Doc from org.jabref.logic.importer.Importer.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 recognizes an import format

Returns:String

description of the import format

Annotations

@Override

getFileType back to summary

getFileType	back to summary
public StandardFileType getFileType() Implements abstract org.jabref.logic.importer.Importer.getFileType. Doc from org.jabref.logic.importer.Importer.getFileType. Returns the type of files that this importer can read Returns:StandardFileType `FileType` corresponding to the importer Annotations @Override

public StandardFileType getFileType()

Implements abstract org.jabref.logic.importer.Importer.getFileType.

Doc from org.jabref.logic.importer.Importer.getFileType.

Returns the type of files that this importer can read

Returns:StandardFileType

FileType corresponding to the importer

Annotations

@Override

getId back to summary

getId	back to summary
public String getId() Overrides org.jabref.logic.importer.Importer.getId. Doc from org.jabref.logic.importer.Importer.getId. Returns a one-word ID which identifies this importer. Used for example, to identify the importer when used from the command line. Returns:String ID, must be unique and not `null` Annotations @Override

public String getId()

Overrides org.jabref.logic.importer.Importer.getId.

Doc from org.jabref.logic.importer.Importer.getId.

Returns a one-word ID which identifies this importer. Used for example, to identify the importer when used from the command line.

Returns:String

ID, must be unique and not null

Annotations

@Override

getName back to summary

getName	back to summary
public String getName() Implements abstract org.jabref.logic.importer.Importer.getName. Doc from org.jabref.logic.importer.Importer.getName. Returns the name of this import format. The name must be unique. Returns:String format name, must be unique and not `null` Annotations @Override

public String getName()

Implements abstract org.jabref.logic.importer.Importer.getName.

Doc from org.jabref.logic.importer.Importer.getName.

Returns the name of this import format.

The name must be unique.

Returns:String

format name, must be unique and not null

Annotations

@Override

importDatabase	back to summary
public ParserResult importDatabase(BufferedReader reader) throws IOException Implements abstract org.jabref.logic.importer.Importer.importDatabase. Doc from org.jabref.logic.importer.Importer.importDatabase. 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. This method should never return null. Parameters reader:BufferedReader the input to read from Annotations @Override

importDatabase

back to summary

public ParserResult importDatabase(BufferedReader reader) throws IOException

Implements abstract org.jabref.logic.importer.Importer.importDatabase.

Doc from org.jabref.logic.importer.Importer.importDatabase.

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.

This method should never return null.

Parameters

reader:BufferedReader: the input to read from

Annotations

@Override

isRecognizedFormat	back to summary
public boolean isRecognizedFormat(BufferedReader reader) throws IOException Implements abstract org.jabref.logic.importer.Importer.isRecognizedFormat. Doc from org.jabref.logic.importer.Importer.isRecognizedFormat. Check whether the source is in the correct format for this importer. 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 behaviour 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. Annotations @Override

isRecognizedFormat

back to summary

public boolean isRecognizedFormat(BufferedReader reader) throws IOException

Implements abstract org.jabref.logic.importer.Importer.isRecognizedFormat.

Doc from org.jabref.logic.importer.Importer.isRecognizedFormat.

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

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 behaviour 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.

Annotations

@Override

parseAuthors	back to summary
private String parseAuthors(List<CffImporter.CffEntity> authors)

parseEntry	back to summary
private BibEntry parseEntry(CffImporter.CffReference reference)

parseFields	back to summary
private void parseFields(Map<String, String> values, Map<Field, String> entryMap)

org.jabref.logic.importer.fileformat back to summary

private Class CffImporter.CffEntity

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.importer.fileformat.CffImporter.CffEntity

Field Summary

Modifier and Type	Field and Description
private final HashMap<String, String>	values

Constructor Summary

Access	Constructor and Description
public	CffEntity()

Method Summary

Modifier and Type	Method and Description
private void	setValues(String key, String value)

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

Field Detail

values	back to summary
private final HashMap<String, String> values

Constructor Detail

CffEntity	back to summary
public CffEntity()

Method Detail

setValues	back to summary
private void setValues(String key, String value) Annotations @JsonAnySetter

org.jabref.logic.importer.fileformat back to summary

private Class CffImporter.CffFormat

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.importer.fileformat.CffImporter.CffFormat

Field Summary

Modifier and Type	Field and Description
private List<CffImporter.CffEntity>	authors
private List<CffImporter.CffIdentifier>	ids
private List<String>	keywords
private CffImporter.CffReference	preferred
private List<CffImporter.CffReference>	references
private final HashMap<String, String>	values

Constructor Summary

Access	Constructor and Description
public	CffFormat()

Method Summary

Modifier and Type	Method and Description
private void	setValues(String key, String value)

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

Field Detail

authors	back to summary
private List<CffImporter.CffEntity> authors Annotations @JsonProperty:authors

ids	back to summary
private List<CffImporter.CffIdentifier> ids Annotations @JsonProperty:identifiers

keywords	back to summary
private List<String> keywords Annotations @JsonProperty:keywords

preferred	back to summary
private CffImporter.CffReference preferred Annotations @JsonProperty:preferred-citation

references	back to summary
private List<CffImporter.CffReference> references Annotations @JsonProperty:references

values	back to summary
private final HashMap<String, String> values

Constructor Detail

CffFormat	back to summary
public CffFormat()

Method Detail

setValues	back to summary
private void setValues(String key, String value) Annotations @JsonAnySetter

org.jabref.logic.importer.fileformat back to summary

private Class CffImporter.CffIdentifier

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.importer.fileformat.CffImporter.CffIdentifier

Field Summary

Modifier and Type	Field and Description
private String	type
private String	value

Constructor Summary

Access	Constructor and Description
public	CffIdentifier()

Method Summary

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

Field Detail

type	back to summary
private String type Annotations @JsonProperty:type

value	back to summary
private String value Annotations @JsonProperty:value

Constructor Detail

CffIdentifier	back to summary
public CffIdentifier()

org.jabref.logic.importer.fileformat back to summary

private Class CffImporter.CffReference

Class Inheritance

extends Object

java.lang.Object
org.jabref.logic.importer.fileformat.CffImporter.CffReference

Field Summary

Modifier and Type	Field and Description
private List<CffImporter.CffEntity>	authors
private CffImporter.CffEntity	conference
private CffImporter.CffEntity	contact
private CffImporter.CffEntity	databaseProvider
private List<CffImporter.CffEntity>	editors
private List<CffImporter.CffEntity>	editorsSeries
private CffImporter.CffEntity	institution
private List<String>	keywords
private List<String>	languages
private CffImporter.CffEntity	location
private CffImporter.CffEntity	publisher
private List<CffImporter.CffEntity>	recipients
private List<CffImporter.CffEntity>	senders
private List<CffImporter.CffEntity>	translators
private String	type
private final HashMap<String, String>	values

Constructor Summary

Access	Constructor and Description
public	CffReference()

Method Summary

Modifier and Type	Method and Description
private void	setValues(String key, String value)

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

Field Detail

authors	back to summary
private List<CffImporter.CffEntity> authors Annotations @JsonProperty:authors

conference	back to summary
private CffImporter.CffEntity conference Annotations @JsonProperty:conference

contact	back to summary
private CffImporter.CffEntity contact Annotations @JsonProperty:contact

databaseProvider	back to summary
private CffImporter.CffEntity databaseProvider Annotations @JsonProperty:database-provider

editors	back to summary
private List<CffImporter.CffEntity> editors Annotations @JsonProperty:editors

editorsSeries	back to summary
private List<CffImporter.CffEntity> editorsSeries Annotations @JsonProperty:editors-series

institution	back to summary
private CffImporter.CffEntity institution Annotations @JsonProperty:institution

keywords	back to summary
private List<String> keywords Annotations @JsonProperty:keywords

languages	back to summary
private List<String> languages Annotations @JsonProperty:languages

location	back to summary
private CffImporter.CffEntity location Annotations @JsonProperty:location

publisher	back to summary
private CffImporter.CffEntity publisher Annotations @JsonProperty:publisher

recipients	back to summary
private List<CffImporter.CffEntity> recipients Annotations @JsonProperty:recipients

senders	back to summary
private List<CffImporter.CffEntity> senders Annotations @JsonProperty:senders

translators	back to summary
private List<CffImporter.CffEntity> translators Annotations @JsonProperty:translators

type	back to summary
private String type Annotations @JsonProperty:type

values	back to summary
private final HashMap<String, String> values

Constructor Detail

CffReference	back to summary
public CffReference()

Method Detail

setValues	back to summary
private void setValues(String key, String value) Annotations @JsonAnySetter

public Class CffImporter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CffImporter.CffEntity

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CffImporter.CffFormat

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class CffImporter.CffIdentifier

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

private Class CffImporter.CffReference

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail