JabRef 6.0-beta.1 · org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultErrorFormatWriter

Outputs the findings in a line-oriented file:line:column:citationKey:field: message format suitable for editors and CI tooling.

This is the same format produced by org.jabref.logic.integrity.IntegrityCheckResultErrorFormatWriter. One line is emitted per deviating field of a reported entry:

a field that is absent although other entries of the same type use it, and
an unknown field that is present although other entries of the same type do not use it.

Both findings are field-level, so every line carries both the citation key and the field name.

Field Summary

Modifier and Type	Field and Description
private final Path	inputFile
private final ParserResult	parserResult

Inherited from org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter:: allReportedFields bibDatabaseMode columnCount columnNames entryTypesManager isPorcelain OPTIONAL_FIELD_AT_ENTRY_TYPE_CELL_ENTRY REQUIRED_FIELD_AT_ENTRY_TYPE_CELL_ENTRY result UNKNOWN_FIELD_AT_ENTRY_TYPE_CELL_ENTRY UNSET_FIELD_AT_ENTRY_TYPE_CELL_ENTRY writer

Constructor Summary

Access	Constructor and Description
public	BibliographyConsistencyCheckResultErrorFormatWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain, BibEntryTypesManager entryTypesManager, BibDatabaseMode bibDatabaseMode, ParserResult parserResult, Path inputFile)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
private void	write(ParserResult.Range range, String citationKey, Field field, String message)
protected void	writeBibEntry(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields) Implements abstract org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter.writeBibEntry.

Inherited from org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter:: getFindingsAsList writeFindings writeMapEntry

Field Detail

inputFile	back to summary
private final Path inputFile

parserResult	back to summary
private final ParserResult parserResult

Constructor Detail

BibliographyConsistencyCheckResultErrorFormatWriter	back to summary
public BibliographyConsistencyCheckResultErrorFormatWriter(BibliographyConsistencyCheck.Result result, Writer writer, boolean isPorcelain, BibEntryTypesManager entryTypesManager, BibDatabaseMode bibDatabaseMode, ParserResult parserResult, Path inputFile)

Method Detail

close back to summary

close	back to summary
public void close() throws IOException Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override Exceptions IOException: if an I/O error occurs

public void close() throws IOException

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs

write	back to summary
private void write(ParserResult.Range range, String citationKey, Field field, String message) throws IOException

writeBibEntry	back to summary
protected void writeBibEntry(BibEntry bibEntry, String entryType, Set<Field> requiredFields, Set<Field> optionalFields) throws IOException Implements abstract org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter.writeBibEntry. Annotations @Override

writeBibEntry

back to summary

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

Implements abstract org.jabref.logic.quality.consistency.BibliographyConsistencyCheckResultWriter.writeBibEntry.