Verified Owner
Top Inners Fields Constructors Methods
org.jabref.model.search.query

public Class SearchQuery

extends Object
Class Inheritance
Imports
java.util.EnumSet, .Objects, java.util.regex.Pattern, .PatternSyntaxException, org.jabref.model.search.SearchFlags, .ThrowingErrorListener, org.jabref.search.SearchBaseVisitor, .SearchLexer, .SearchParser, org.antlr.v4.runtime.BailErrorStrategy, .CharStreams, .CommonTokenStream, org.antlr.v4.runtime.misc.ParseCancellationException, org.jspecify.annotations.NonNull, .NullMarked, org.slf4j.Logger, .LoggerFactory

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Field Summary

Modifier and TypeField and Description
private SearchParser.StartContext
private boolean
private static final Logger
private final String
private final EnumSet<SearchFlags>
private SearchResults

Constructor Summary

AccessConstructor and Description
public
SearchQuery(String searchExpression)

public
SearchQuery(@NonNull String searchExpression, EnumSet<SearchFlags> searchFlags)

Method Summary

Modifier and TypeMethod and Description
private static boolean
public boolean
equals(Object o)

Overrides java.lang.Object.equals.

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

public SearchParser.StartContext
public String
public EnumSet<SearchFlags>
public SearchResults
public static SearchParser.StartContext
getStartContext(String searchExpression)

public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for this object.

public boolean
public void
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

public static String
unescapeSearchValue(SearchParser.SearchValueContext ctx)

Unescapes search value based on the Search grammar rules.

Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

contextback to summary
private SearchParser.StartContext context
isValidExpressionback to summary
private boolean isValidExpression
LOGGERback to summary
private static final Logger LOGGER
searchExpressionback to summary
private final String searchExpression
searchFlagsback to summary
private final EnumSet<SearchFlags> searchFlags
searchResultsback to summary
private SearchResults searchResults

Constructor Detail

SearchQueryback to summary
public SearchQuery(String searchExpression)
SearchQueryback to summary
public SearchQuery(@NonNull String searchExpression, EnumSet<SearchFlags> searchFlags)

Method Detail

containsOnlyValidRegularExpressionsback to summary
private static boolean containsOnlyValidRegularExpressions(SearchParser.StartContext context, EnumSet<SearchFlags> searchFlags)
equalsback to summary
public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

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

The equals method implements an equivalence relation on non-null object references:

  • It is reflexive: for any non-null reference value x, x.equals(x) should return true.
  • It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
  • It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
  • For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations
@Override
getContextback to summary
public SearchParser.StartContext getContext()
getSearchExpressionback to summary
public String getSearchExpression()
getSearchFlagsback to summary
public EnumSet<SearchFlags> getSearchFlags()
getSearchResultsback to summary
public SearchResults getSearchResults()
getStartContextback to summary
public static SearchParser.StartContext getStartContext(String searchExpression)
hashCodeback to summary
public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

  • Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
  • If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
  • It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.
Annotations
@Override
isValidback to summary
public boolean isValid()
setSearchResultsback to summary
public void setSearchResults(SearchResults searchResults)
toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override
unescapeSearchValueback to summary
public static String unescapeSearchValue(SearchParser.SearchValueContext ctx)

Unescapes search value based on the Search grammar rules.

  • STRING_LITERAL: Removes enclosing quotes and unescapes \"

  • TERM: Unescapes \=, \!, \~, \(, \)

org.jabref.model.search.query back to summary

private final Class SearchQuery.SearchRegularExpressionValidator

extends SearchBaseVisitor<Boolean>
Class Inheritance
Annotations
@NullMarked

Field Summary

Modifier and TypeField and Description
private final boolean

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private boolean
public Boolean
public Boolean
public Boolean
public Boolean
public Boolean
public Boolean
public Boolean
Inherited from org.jabref.search.SearchBaseVisitor:
visitOperatorvisitSearchValue

Field Detail

searchBarRegexback to summary
private final boolean searchBarRegex

Constructor Detail

SearchRegularExpressionValidatorback to summary
private SearchRegularExpressionValidator(EnumSet<SearchFlags> searchFlags)

Method Detail

isRegexComparisonback to summary
private boolean isRegexComparison(SearchParser.ComparisonContext ctx)
visitBinaryExpressionback 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
visitComparisonback 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
visitComparisonExpressionback 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
visitImplicitAndExpressionback 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
visitNegatedExpressionback 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
visitParenExpressionback 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
visitStartback 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