Nested and Inner Type Summary

Modifier and Type	Class and Description
private static record	BibEntryMatchVisitor.OperatorFlags
private static record	BibEntryMatchVisitor.RegexKey

Field Summary

Modifier and Type	Field and Description
private static final Cache<BibEntryMatchVisitor.RegexKey, Pattern>	COMPILED_PATTERNS Compiled regexes shared across all visitor instances (one instance is created per `BibEntry`, so an instance-level cache would not help when scanning a library).
private final BibEntry	entry
private static final String	GROUPS_FIELD_NAME
private final Character	keywordSeparator
private static final Logger	LOGGER
private final EnumSet<SearchFlags>	searchBarFlags

Access	Constructor and Description
pack-priv	BibEntryMatchVisitor(BibEntry entry, EnumSet<SearchFlags> searchBarFlags, Character keywordSeparator)

Method Summary

Modifier and Type	Method and Description
private boolean	isFieldPresent(String fieldName)
private static BibEntryMatchVisitor.OperatorFlags	mapOperator(int tokenType)
private boolean	matchAnyField(String term, SearchFlags matchKind, boolean caseSensitive)
private boolean	matchAnyKeyword(String term, SearchFlags matchKind, boolean caseSensitive)
private boolean	matchField(String fieldName, String term, SearchFlags matchKind, boolean caseSensitive)
private boolean	matchNamedField(String fieldName, String term, SearchFlags matchKind, boolean caseSensitive)
private static boolean	matchRegex(String value, String pattern, boolean caseSensitive)
private static boolean	matchValue(String value, String term, SearchFlags one of `SearchFlags#INEXACT_MATCH`, `SearchFlags#EXACT_MATCH`, `SearchFlags#REGULAR_EXPRESSION` matchKind, boolean caseSensitive)
public Boolean	visitBinaryExpression(SearchParser.BinaryExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitBinaryExpression. Implements org.jabref.search.SearchVisitor.visitBinaryExpression. Visit a parse tree produced by the `binaryExpression` labeled alternative in `SearchParser#expression`.
public Boolean	visitComparison(SearchParser.ComparisonContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitComparison. Implements org.jabref.search.SearchVisitor.visitComparison. Visit a parse tree produced by `SearchParser#comparison`.
public Boolean	visitComparisonExpression(SearchParser.ComparisonExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitComparisonExpression. Implements org.jabref.search.SearchVisitor.visitComparisonExpression. Visit a parse tree produced by the `comparisonExpression` labeled alternative in `SearchParser#expression`.
public Boolean	visitImplicitAndExpression(SearchParser.ImplicitAndExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitImplicitAndExpression. Implements org.jabref.search.SearchVisitor.visitImplicitAndExpression. Visit a parse tree produced by the `implicitAndExpression` labeled alternative in `SearchParser#andExpression`.
public Boolean	visitNegatedExpression(SearchParser.NegatedExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitNegatedExpression. Implements org.jabref.search.SearchVisitor.visitNegatedExpression. Visit a parse tree produced by the `negatedExpression` labeled alternative in `SearchParser#expression`.
public Boolean	visitParenExpression(SearchParser.ParenExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitParenExpression. Implements org.jabref.search.SearchVisitor.visitParenExpression. Visit a parse tree produced by the `parenExpression` labeled alternative in `SearchParser#expression`.
public Boolean	visitStart(SearchParser.StartContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitStart. Implements org.jabref.search.SearchVisitor.visitStart. Visit a parse tree produced by `SearchParser#start`.

Inherited from org.jabref.search.SearchBaseVisitor:: visitOperator visitSearchValue

Field Detail

COMPILED_PATTERNS	back to summary
private static final Cache<BibEntryMatchVisitor.RegexKey, Pattern> COMPILED_PATTERNS Compiled regexes shared across all visitor instances (one instance is created per `BibEntry`, so an instance-level cache would not help when scanning a library). Keyed by pattern + case mode.

entry	back to summary
private final BibEntry entry

GROUPS_FIELD_NAME	back to summary
private static final String GROUPS_FIELD_NAME

keywordSeparator	back to summary
private final Character keywordSeparator

LOGGER	back to summary
private static final Logger LOGGER

searchBarFlags	back to summary
private final EnumSet<SearchFlags> searchBarFlags

Constructor Detail

BibEntryMatchVisitor	back to summary
pack-priv BibEntryMatchVisitor(BibEntry entry, EnumSet<SearchFlags> searchBarFlags, Character keywordSeparator)

Method Detail

isFieldPresent	back to summary
private boolean isFieldPresent(String fieldName)

mapOperator	back to summary
private static BibEntryMatchVisitor.OperatorFlags mapOperator(int tokenType)

matchAnyField	back to summary
private boolean matchAnyField(String term, SearchFlags matchKind, boolean caseSensitive)

matchAnyKeyword	back to summary
private boolean matchAnyKeyword(String term, SearchFlags matchKind, boolean caseSensitive)

matchField	back to summary
private boolean matchField(String fieldName, String term, SearchFlags matchKind, boolean caseSensitive)

matchNamedField	back to summary
private boolean matchNamedField(String fieldName, String term, SearchFlags matchKind, boolean caseSensitive)

matchRegex	back to summary
private static boolean matchRegex(String value, String pattern, boolean caseSensitive)

matchValue	back to summary
private static boolean matchValue(String value, String term, SearchFlags matchKind, boolean caseSensitive) Parameters matchKind:SearchFlags one of `SearchFlags#INEXACT_MATCH`, `SearchFlags#EXACT_MATCH`, `SearchFlags#REGULAR_EXPRESSION`

visitBinaryExpression back to summary

visitBinaryExpression	back to summary
public Boolean visitBinaryExpression(SearchParser.BinaryExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitBinaryExpression. Implements org.jabref.search.SearchVisitor.visitBinaryExpression. Doc from org.jabref.search.SearchBaseVisitor.visitBinaryExpression. Visit a parse tree produced by the `binaryExpression` labeled alternative in `SearchParser#expression`. The default implementation returns the result of calling `visitChildren` on `ctx`. Annotations @Override

public Boolean visitBinaryExpression(SearchParser.BinaryExpressionContext ctx)

Overrides org.jabref.search.SearchBaseVisitor.visitBinaryExpression.

Implements org.jabref.search.SearchVisitor.visitBinaryExpression.

Doc from org.jabref.search.SearchBaseVisitor.visitBinaryExpression.

Visit a parse tree produced by the binaryExpression labeled alternative in SearchParser#expression.

The default implementation returns the result of calling visitChildren on ctx.

Annotations

@Override

visitComparison back to summary

visitComparison	back to summary
public Boolean visitComparison(SearchParser.ComparisonContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitComparison. Implements org.jabref.search.SearchVisitor.visitComparison. Doc from org.jabref.search.SearchBaseVisitor.visitComparison. Visit a parse tree produced by `SearchParser#comparison`. The default implementation returns the result of calling `visitChildren` on `ctx`. Annotations @Override

public Boolean visitComparison(SearchParser.ComparisonContext ctx)

Overrides org.jabref.search.SearchBaseVisitor.visitComparison.

Implements org.jabref.search.SearchVisitor.visitComparison.

Doc from org.jabref.search.SearchBaseVisitor.visitComparison.

Visit a parse tree produced by SearchParser#comparison.

The default implementation returns the result of calling visitChildren on ctx.

Annotations

@Override

visitComparisonExpression back to summary

visitComparisonExpression	back to summary
public Boolean visitComparisonExpression(SearchParser.ComparisonExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitComparisonExpression. Implements org.jabref.search.SearchVisitor.visitComparisonExpression. Doc from org.jabref.search.SearchBaseVisitor.visitComparisonExpression. Visit a parse tree produced by the `comparisonExpression` labeled alternative in `SearchParser#expression`. The default implementation returns the result of calling `visitChildren` on `ctx`. Annotations @Override

public Boolean visitComparisonExpression(SearchParser.ComparisonExpressionContext ctx)

Overrides org.jabref.search.SearchBaseVisitor.visitComparisonExpression.

Implements org.jabref.search.SearchVisitor.visitComparisonExpression.

Doc from org.jabref.search.SearchBaseVisitor.visitComparisonExpression.

Visit a parse tree produced by the comparisonExpression labeled alternative in SearchParser#expression.

The default implementation returns the result of calling visitChildren on ctx.

Annotations

@Override

visitImplicitAndExpression back to summary

visitImplicitAndExpression	back to summary
public Boolean visitImplicitAndExpression(SearchParser.ImplicitAndExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitImplicitAndExpression. Implements org.jabref.search.SearchVisitor.visitImplicitAndExpression. Doc from org.jabref.search.SearchBaseVisitor.visitImplicitAndExpression. Visit a parse tree produced by the `implicitAndExpression` labeled alternative in `SearchParser#andExpression`. The default implementation returns the result of calling `visitChildren` on `ctx`. Annotations @Override

public Boolean visitImplicitAndExpression(SearchParser.ImplicitAndExpressionContext ctx)

Overrides org.jabref.search.SearchBaseVisitor.visitImplicitAndExpression.

Implements org.jabref.search.SearchVisitor.visitImplicitAndExpression.

Doc from org.jabref.search.SearchBaseVisitor.visitImplicitAndExpression.

Visit a parse tree produced by the implicitAndExpression labeled alternative in SearchParser#andExpression.

The default implementation returns the result of calling visitChildren on ctx.

Annotations

@Override

visitNegatedExpression back to summary

visitNegatedExpression	back to summary
public Boolean visitNegatedExpression(SearchParser.NegatedExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitNegatedExpression. Implements org.jabref.search.SearchVisitor.visitNegatedExpression. Doc from org.jabref.search.SearchBaseVisitor.visitNegatedExpression. Visit a parse tree produced by the `negatedExpression` labeled alternative in `SearchParser#expression`. The default implementation returns the result of calling `visitChildren` on `ctx`. Annotations @Override

public Boolean visitNegatedExpression(SearchParser.NegatedExpressionContext ctx)

Overrides org.jabref.search.SearchBaseVisitor.visitNegatedExpression.

Implements org.jabref.search.SearchVisitor.visitNegatedExpression.

Doc from org.jabref.search.SearchBaseVisitor.visitNegatedExpression.

Visit a parse tree produced by the negatedExpression labeled alternative in SearchParser#expression.

The default implementation returns the result of calling visitChildren on ctx.

Annotations

@Override

visitParenExpression back to summary

visitParenExpression	back to summary
public Boolean visitParenExpression(SearchParser.ParenExpressionContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitParenExpression. Implements org.jabref.search.SearchVisitor.visitParenExpression. Doc from org.jabref.search.SearchBaseVisitor.visitParenExpression. Visit a parse tree produced by the `parenExpression` labeled alternative in `SearchParser#expression`. The default implementation returns the result of calling `visitChildren` on `ctx`. Annotations @Override

public Boolean visitParenExpression(SearchParser.ParenExpressionContext ctx)

Overrides org.jabref.search.SearchBaseVisitor.visitParenExpression.

Implements org.jabref.search.SearchVisitor.visitParenExpression.

Doc from org.jabref.search.SearchBaseVisitor.visitParenExpression.

Visit a parse tree produced by the parenExpression labeled alternative in SearchParser#expression.

The default implementation returns the result of calling visitChildren on ctx.

Annotations

@Override

visitStart back to summary

visitStart	back to summary
public Boolean visitStart(SearchParser.StartContext ctx) Overrides org.jabref.search.SearchBaseVisitor.visitStart. Implements org.jabref.search.SearchVisitor.visitStart. Doc from org.jabref.search.SearchBaseVisitor.visitStart. Visit a parse tree produced by `SearchParser#start`. The default implementation returns the result of calling `visitChildren` on `ctx`. Annotations @Override

public Boolean visitStart(SearchParser.StartContext ctx)

Overrides org.jabref.search.SearchBaseVisitor.visitStart.

Implements org.jabref.search.SearchVisitor.visitStart.

Doc from org.jabref.search.SearchBaseVisitor.visitStart.

Visit a parse tree produced by SearchParser#start.

The default implementation returns the result of calling visitChildren on ctx.

Annotations

@Override

org.jabref.logic.search.inmemory back to summary

private final Record BibEntryMatchVisitor.OperatorFlags

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.search.inmemory.BibEntryMatchVisitor.OperatorFlags

Record Components

matchKind:SearchFlags: one of SearchFlags#INEXACT_MATCH, SearchFlags#EXACT_MATCH, SearchFlags#REGULAR_EXPRESSION
caseSensitive:boolean
negation:boolean

Field Summary

Modifier and Type	Field and Description
private final boolean	caseSensitive Record Component accessed by caseSensitive().
private final SearchFlags	matchKind Record Component accessed by matchKind(). one of `SearchFlags#INEXACT_MATCH`, `SearchFlags#EXACT_MATCH`, `SearchFlags#REGULAR_EXPRESSION`
private final boolean	negation Record Component accessed by negation().

Constructor Summary

Access	Constructor and Description
private	OperatorFlags(SearchFlags matchKind, boolean caseSensitive, boolean negation)

Method Summary

Modifier and Type	Method and Description
public boolean	caseSensitive() Record Component getter of caseSensitive.
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 SearchFlags	matchKind() Record Component getter of matchKind. Record Component one of `SearchFlags#INEXACT_MATCH`, `SearchFlags#EXACT_MATCH`, `SearchFlags#REGULAR_EXPRESSION`
public boolean	negation() Record Component getter of negation.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

caseSensitive	back to summary
private final boolean caseSensitive Record Component accessed by caseSensitive().

matchKind back to summary

matchKind	back to summary
private final SearchFlags matchKind Record Component accessed by matchKind(). one of `SearchFlags#INEXACT_MATCH`, `SearchFlags#EXACT_MATCH`, `SearchFlags#REGULAR_EXPRESSION`

private final SearchFlags matchKind

Record Component accessed by matchKind().

one of SearchFlags#INEXACT_MATCH, SearchFlags#EXACT_MATCH, SearchFlags#REGULAR_EXPRESSION

negation	back to summary
private final boolean negation Record Component accessed by negation().

Constructor Detail

OperatorFlags	back to summary
private OperatorFlags(SearchFlags matchKind, boolean caseSensitive, boolean negation)

Method Detail

caseSensitive	back to summary
public boolean caseSensitive() Record Component getter of caseSensitive.

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

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

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.

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.

matchKind back to summary

matchKind	back to summary
public SearchFlags matchKind() Record Component getter of matchKind. Record Component one of `SearchFlags#INEXACT_MATCH`, `SearchFlags#EXACT_MATCH`, `SearchFlags#REGULAR_EXPRESSION`

public SearchFlags matchKind()

Record Component getter of matchKind.

Record Component: one of SearchFlags#INEXACT_MATCH, SearchFlags#EXACT_MATCH, SearchFlags#REGULAR_EXPRESSION

negation	back to summary
public boolean negation() Record Component getter of negation.

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.

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.search.inmemory back to summary

private final Record BibEntryMatchVisitor.RegexKey

Class Inheritance

extends Record

java.lang.Object
java.lang.Record
org.jabref.logic.search.inmemory.BibEntryMatchVisitor.RegexKey

Record Components

pattern:String
caseSensitive:boolean

Field Summary

Modifier and Type	Field and Description
private final boolean	caseSensitive Record Component accessed by caseSensitive().
private final String	pattern Record Component accessed by pattern().

Constructor Summary

Access	Constructor and Description
private	RegexKey(String pattern, boolean caseSensitive)

Method Summary

Modifier and Type	Method and Description
public boolean	caseSensitive() Record Component getter of caseSensitive.
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 String	pattern() Record Component getter of pattern.
public final String	toString() Implements abstract java.lang.Record.toString. Returns a string representation of the record.

Field Detail

caseSensitive	back to summary
private final boolean caseSensitive Record Component accessed by caseSensitive().

pattern	back to summary
private final String pattern Record Component accessed by pattern().

Constructor Detail

RegexKey	back to summary
private RegexKey(String pattern, boolean caseSensitive)

Method Detail

caseSensitive	back to summary
public boolean caseSensitive() Record Component getter of caseSensitive.

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

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

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.

public final int hashCode()

Implements abstract java.lang.Record.hashCode.

Doc from java.lang.Record.hashCode.

pattern	back to summary
public String pattern() Record Component getter of pattern.

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.

public final String toString()

Implements abstract java.lang.Record.toString.

Doc from java.lang.Record.toString.

pack-priv Class BibEntryMatchVisitor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record BibEntryMatchVisitor.OperatorFlags

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Record BibEntryMatchVisitor.RegexKey

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail