Verified Owner
Top Description Fields Constructors Methods
org.jabref.logic.quality.consistency

public abstract Class BibliographyConsistencyCheckResultWriter

extends Object
implements Closeable
Class Inheritance
All Implemented Interfaces
java.io.Closeable, java.lang.AutoCloseable
Known Direct Subclasses
org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultCsvWriter, org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultErrorFormatWriter, org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultGitHubActionsWriter, org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultTxtWriter
Imports
java.io.Closeable, .IOException, .Writer, java.util.ArrayList, .Collection, .Comparator, .List, .Map, .Optional, .SequencedCollection, .Set, java.util.stream.Collectors, org.jabref.model.database.BibDatabaseMode, org.jabref.model.entry.BibEntry, .BibEntryType, .BibEntryTypesManager, org.jabref.model.entry.field.BibField, .Field, .FieldTextMapper, org.jabref.model.entry.types.EntryType, org.jooq.lambda.Unchecked
Outputs the findings as CSV.

Following symbols are used (as default):

Note that this classification is based on JabRef's definition and might not match the publisher's definition.

Implementation Note

We could have implemented a PaperConsistencyCheckResultFormatter, but that would have been too much effort.

Field Summary

Modifier and TypeField and Description
protected final List<Field>
allReportedFields

protected final BibDatabaseMode
bibDatabaseMode

protected final int
columnCount

protected final List<String>
columnNames

protected final BibEntryTypesManager
entryTypesManager

protected final boolean
isPorcelain

protected static final String
OPTIONAL_FIELD_AT_ENTRY_TYPE_CELL_ENTRY

protected static final String
REQUIRED_FIELD_AT_ENTRY_TYPE_CELL_ENTRY

protected final BibliographyConsistencyCheck.Result
result

protected static final String
UNKNOWN_FIELD_AT_ENTRY_TYPE_CELL_ENTRY

protected static final String
UNSET_FIELD_AT_ENTRY_TYPE_CELL_ENTRY

protected final Writer
writer

Constructor Summary

AccessConstructor and Description
public
BibliographyConsistencyCheckResultWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain)

public
BibliographyConsistencyCheckResultWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain, BibEntryTypesManager entryTypesManager, BibDatabaseMode bibDatabaseMode)

Method Summary

Modifier and TypeMethod and Description
private List<String>
getColumnNames()

protected List<String>
getFindingsAsList(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields)

protected abstract void
writeBibEntry(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields)

public void
writeFindings()

protected void
writeMapEntry(Map.Entry<EntryType, BibliographyConsistencyCheck.EntryTypeResult> mapEntry)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

allReportedFieldsback to summary
protected final List<Field> allReportedFields
bibDatabaseModeback to summary
protected final BibDatabaseMode bibDatabaseMode
columnCountback to summary
protected final int columnCount
columnNamesback to summary
protected final List<String> columnNames
entryTypesManagerback to summary
protected final BibEntryTypesManager entryTypesManager
isPorcelainback to summary
protected final boolean isPorcelain
OPTIONAL_FIELD_AT_ENTRY_TYPE_CELL_ENTRYback to summary
protected static final String OPTIONAL_FIELD_AT_ENTRY_TYPE_CELL_ENTRY
REQUIRED_FIELD_AT_ENTRY_TYPE_CELL_ENTRYback to summary
protected static final String REQUIRED_FIELD_AT_ENTRY_TYPE_CELL_ENTRY
resultback to summary
protected final BibliographyConsistencyCheck.Result result
UNKNOWN_FIELD_AT_ENTRY_TYPE_CELL_ENTRYback to summary
protected static final String UNKNOWN_FIELD_AT_ENTRY_TYPE_CELL_ENTRY
UNSET_FIELD_AT_ENTRY_TYPE_CELL_ENTRYback to summary
protected static final String UNSET_FIELD_AT_ENTRY_TYPE_CELL_ENTRY
writerback to summary
protected final Writer writer

Constructor Detail

BibliographyConsistencyCheckResultWriterback to summary
public BibliographyConsistencyCheckResultWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain)
BibliographyConsistencyCheckResultWriterback to summary
public BibliographyConsistencyCheckResultWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain, BibEntryTypesManager entryTypesManager, BibDatabaseMode bibDatabaseMode)

Method Detail

getColumnNamesback to summary
private List<String> getColumnNames()
getFindingsAsListback to summary
protected List<String> getFindingsAsList(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields)
writeBibEntryback to summary
protected abstract void writeBibEntry(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields) throws IOException
writeFindingsback to summary
public void writeFindings() throws IOException
writeMapEntryback to summary
protected void writeMapEntry(Map.Entry<EntryType, BibliographyConsistencyCheck.EntryTypeResult> mapEntry)