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

public Class BibliographyConsistencyCheck

extends Object
Class Inheritance
Imports
java.util.Collection, .Collections, .HashMap, .HashSet, .LinkedHashMap, .List, .Map, .Optional, .SequencedCollection, .Set, java.util.function.BiConsumer, java.util.stream.Collectors, org.jabref.logic.bibtex.comparator.BibEntryByCitationKeyComparator, .BibEntryByFieldsComparator, .FieldComparatorStack, org.jabref.model.database.BibDatabaseContext, .BibDatabaseMode, org.jabref.model.entry.BibEntry, .BibEntryType, .BibEntryTypesManager, org.jabref.model.entry.field.Field, .InternalField, .OrFields, .SpecialField, .StandardField, .UserSpecificCommentField, org.jabref.model.entry.types.EntryType, com.google.common.annotations.VisibleForTesting

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static record
BibliographyConsistencyCheck.EntryTypeResult

public static record
BibliographyConsistencyCheck.Result

Field Summary

Modifier and TypeField and Description
private static final Set<Field>
EXPLICITLY_EXCLUDED_FIELDS

Constructor Summary

AccessConstructor and Description
public
BibliographyConsistencyCheck()

Method Summary

Modifier and TypeMethod and Description
public BibliographyConsistencyCheck.Result
check(BibDatabaseContext bibContext, BibEntryTypesManager bibEntryTypesManager, BiConsumer<Integer, Integer> entriesGroupingProgress)

Checks the consistency of the given entries by looking at the present and absent fields.

private static void
collectEntriesIntoMaps(BibDatabaseContext bibContext, Map<EntryType, Set<Field>> entryTypeToFieldsInAnyEntryMap, Map<EntryType, Set<Field>> entryTypeToFieldsInAllEntriesMap, Map<EntryType, Set<BibEntry>> entryTypeToEntriesMap)

pack-priv List<BibEntry>
filterAndSortEntriesWithFieldDifferences(Set<BibEntry> entries, Set<Field> differingFields, Set<OrFields> requiredFields)

Filters the given entries to those that violate consistency:

  • Fields not set (but set in other entries of the same type)
  • Required fields not set
private static Set<Field>
filterExcludedFields(Collection<Field> fields)

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

EXPLICITLY_EXCLUDED_FIELDSback to summary
private static final Set<Field> EXPLICITLY_EXCLUDED_FIELDS

Constructor Detail

BibliographyConsistencyCheckback to summary
public BibliographyConsistencyCheck()

Method Detail

checkback to summary
public BibliographyConsistencyCheck.Result check(BibDatabaseContext bibContext, BibEntryTypesManager bibEntryTypesManager, BiConsumer<Integer, Integer> entriesGroupingProgress)

Checks the consistency of the given entries by looking at the present and absent fields.

Computation takes place grouped by each entryType. Computes the fields set in all entries. In case entries of the same type has more fields defined, it is output.

This class does check if required fields are set for an entry type but does not check if the fields are valid for the entry type.

That result can a) be retrieved by using the JabRef UI and b) by checking the CSV output of BibliographyConsistencyCheckResultCsvWriter#writeFindings

Implementation Note

This class does not implement org.jabref.logic.integrity.DatabaseChecker, because it returns a list of org.jabref.logic.integrity.IntegrityMessage, which are too fine-grained.

collectEntriesIntoMapsback to summary
private static void collectEntriesIntoMaps(BibDatabaseContext bibContext, Map<EntryType, Set<Field>> entryTypeToFieldsInAnyEntryMap, Map<EntryType, Set<Field>> entryTypeToFieldsInAllEntriesMap, Map<EntryType, Set<BibEntry>> entryTypeToEntriesMap)
filterAndSortEntriesWithFieldDifferencesback to summary
pack-priv List<BibEntry> filterAndSortEntriesWithFieldDifferences(Set<BibEntry> entries, Set<Field> differingFields, Set<OrFields> requiredFields)

Filters the given entries to those that violate consistency:

  • Fields not set (but set in other entries of the same type)
  • Required fields not set

Additionally, the entries are sorted

Annotations
@VisibleForTesting
filterExcludedFieldsback to summary
private static Set<Field> filterExcludedFields(Collection<Field> fields)
org.jabref.logic.quality.consistency back to summary

public final Record BibliographyConsistencyCheck.EntryTypeResult

extends Record
Class Inheritance
Record Components
fields:Collection<Field> 
sortedEntries:SequencedCollection<BibEntry> 

Field Summary

Modifier and TypeField and Description
private final Collection<Field>
fields

Record Component accessed by fields().

private final SequencedCollection<BibEntry>
sortedEntries

Record Component accessed by sortedEntries().

Constructor Summary

AccessConstructor and Description
public
EntryTypeResult(Collection<Field> fields, SequencedCollection<BibEntry> sortedEntries)

Method Summary

Modifier and TypeMethod 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 Collection<Field>
fields()

Record Component getter of fields.

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public SequencedCollection<BibEntry>
sortedEntries()

Record Component getter of sortedEntries.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

fieldsback to summary
private final Collection<Field> fields

Record Component accessed by fields().

sortedEntriesback to summary
private final SequencedCollection<BibEntry> sortedEntries

Record Component accessed by sortedEntries().

Constructor Detail

EntryTypeResultback to summary
public EntryTypeResult(Collection<Field> fields, SequencedCollection<BibEntry> sortedEntries)

Method Detail

equalsback 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).
fieldsback to summary
public Collection<Field> fields()

Record Component getter of fields.

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

sortedEntriesback to summary
public SequencedCollection<BibEntry> sortedEntries()

Record Component getter of sortedEntries.

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

org.jabref.logic.quality.consistency back to summary

public final Record BibliographyConsistencyCheck.Result

extends Record
Class Inheritance
Record Components
entryTypeToResultMap:Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult> 

Field Summary

Modifier and TypeField and Description
private final Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult>
entryTypeToResultMap

Record Component accessed by entryTypeToResultMap().

Constructor Summary

AccessConstructor and Description
public
Result(Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult> entryTypeToResultMap)

Method Summary

Modifier and TypeMethod and Description
public Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult>
entryTypeToResultMap()

Record Component getter of entryTypeToResultMap.

public final boolean
equals(Object o)

Implements abstract java.lang.Record.equals.

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

public final int
hashCode()

Implements abstract java.lang.Record.hashCode.

Returns a hash code value for the record.

public final String
toString()

Implements abstract java.lang.Record.toString.

Returns a string representation of the record.

Field Detail

entryTypeToResultMapback to summary
private final Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult> entryTypeToResultMap

Record Component accessed by entryTypeToResultMap().

Constructor Detail

Resultback to summary
public Result(Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult> entryTypeToResultMap)

Method Detail

entryTypeToResultMapback to summary
public Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult> entryTypeToResultMap()

Record Component getter of entryTypeToResultMap.

equalsback 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).
hashCodeback 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.

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