Modifier and Type	Class and Description
public static record	BibliographyConsistencyCheck.EntryTypeResult
public static record	BibliographyConsistencyCheck.Result

Access	Constructor and Description
public	BibliographyConsistencyCheck()

Modifier and Type	Method and Description
public BibliographyConsistencyCheck.Result	check(List<BibEntry> entries) Checks the consistency of the given entries by looking at the present and absent fields.
private static void	collectEntriesIntoMaps(List<BibEntry> entries, Map<EntryType, Set<Field>> entryTypeToFieldsInAnyEntryMap, Map<EntryType, Set<Field>> entryTypeToFieldsInAllEntriesMap, Map<EntryType, Set<BibEntry>> entryTypeToEntriesMap)
private static Comparator<BibEntry>	getBibEntryComparator() Sorts entries by the number of fields and then by the field names.

BibliographyConsistencyCheck	back to summary
public BibliographyConsistencyCheck()

Method Detail

check back to summary

check	back to summary
public BibliographyConsistencyCheck.Result check(List<BibEntry> entries) 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 not check whether all required fields are present or 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.

public BibliographyConsistencyCheck.Result check(List<BibEntry> entries)

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 not check whether all required fields are present or 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.

collectEntriesIntoMaps	back to summary
private static void collectEntriesIntoMaps(List<BibEntry> entries, Map<EntryType, Set<Field>> entryTypeToFieldsInAnyEntryMap, Map<EntryType, Set<Field>> entryTypeToFieldsInAllEntriesMap, Map<EntryType, Set<BibEntry>> entryTypeToEntriesMap)

getBibEntryComparator	back to summary
private static Comparator<BibEntry> getBibEntryComparator() Sorts entries by the number of fields and then by the field names.

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

public final Record BibliographyConsistencyCheck.EntryTypeResult

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.quality.consistency.BibliographyConsistencyCheck.EntryTypeResult

Record Components

fields:Collection<Field>
sortedEntries:SequencedCollection<BibEntry>

Field Summary

Modifier and Type	Field and Description
private final Collection<Field>	fields Record Component accessed by fields().
private final SequencedCollection<BibEntry>	sortedEntries Record Component accessed by sortedEntries().

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public final boolean	equals(Object the reference object with which to compare. 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

fields	back to summary
private final Collection<Field> fields Record Component accessed by fields().

sortedEntries	back to summary
private final SequencedCollection<BibEntry> sortedEntries Record Component accessed by sortedEntries().

Constructor Detail

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

Method Detail

equals back to summary

equals	back 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)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

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

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

fields	back to summary
public Collection<Field> fields() Record Component getter of fields.

hashCode back to summary

hashCode	back 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. Returns:int a hash code value for this record.

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.

Returns:int: a hash code value for this record.

sortedEntries	back to summary
public SequencedCollection<BibEntry> sortedEntries() Record Component getter of sortedEntries.

toString back to summary

toString	back 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. Returns:String a string representation of the object.

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.

Returns:String: a string representation of the object.

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

public final Record BibliographyConsistencyCheck.Result

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.quality.consistency.BibliographyConsistencyCheck.Result

Record Components

entryTypeToResultMap:Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult>

Field Summary

Modifier and Type	Field and Description
private final Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult>	entryTypeToResultMap Record Component accessed by entryTypeToResultMap().

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
public Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult>	entryTypeToResultMap() Record Component getter of entryTypeToResultMap.
public final boolean	equals(Object the reference object with which to compare. 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

entryTypeToResultMap	back to summary
private final Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult> entryTypeToResultMap Record Component accessed by entryTypeToResultMap().

Constructor Detail

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

Method Detail

entryTypeToResultMap	back to summary
public Map<EntryType, BibliographyConsistencyCheck.EntryTypeResult> entryTypeToResultMap() Record Component getter of entryTypeToResultMap.

equals back to summary

equals	back 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)`. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this record is equal to the argument; `false` otherwise.

public final boolean equals(Object o)

Implements abstract java.lang.Record.equals.

Doc from java.lang.Record.equals.

    R copy = new R(r.c1(), r.c2(), ..., r.cn());

then it must be the case that r.equals(copy).

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this record is equal to the argument; false otherwise.

hashCode back to summary

hashCode	back 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. Returns:int a hash code value for this record.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

Returns:int: a hash code value for this record.

toString back to summary

toString	back 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. Returns:String a string representation of the object.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

Returns:String: a string representation of the object.

public Class BibliographyConsistencyCheck

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Record BibliographyConsistencyCheck.EntryTypeResult

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Record BibliographyConsistencyCheck.Result

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail