Top Inners Fields Constructors Methods
org.jabref.gui.search.rules.describer

public Class GrammarBasedSearchRuleDescriber

extends Object
implements SearchDescriber
Class Inheritance
All Implemented Interfaces
org.jabref.gui.search.rules.describer.SearchDescriber
Imports
java.util.ArrayList, .EnumSet, .List, .Objects, .Optional, java.util.regex.Pattern, javafx.scene.text.Text, .TextFlow, org.jabref.gui.util.TooltipTextUtil, org.jabref.logic.l10n.Localization, org.jabref.model.search.rules.GrammarBasedSearchRule, .SearchRules, .SearchRules.SearchFlags, org.jabref.model.strings.StringUtil, org.jabref.search.SearchBaseVisitor, .SearchParser, org.antlr.v4.runtime.tree.ParseTree

Nested and Inner Type Summary

Modifier and TypeClass and Description
private class

Field Summary

Modifier and TypeField and Description
private final ParseTree
private final EnumSet<SearchRules.SearchFlags>

Constructor Summary

AccessConstructor and Description
public

Method Summary

Modifier and TypeMethod and Description
public TextFlow
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

parseTreeback to summary
private final ParseTree parseTree
searchFlagsback to summary
private final EnumSet<SearchRules.SearchFlags> searchFlags

Constructor Detail

GrammarBasedSearchRuleDescriberback to summary
public GrammarBasedSearchRuleDescriber(EnumSet<SearchRules.SearchFlags> searchFlags, ParseTree parseTree)

Method Detail

getDescriptionback to summary
public TextFlow getDescription()

Implements org.jabref.gui.search.rules.describer.SearchDescriber.getDescription.

Annotations
@Override
org.jabref.gui.search.rules.describer back to summary

private Class GrammarBasedSearchRuleDescriber.DescriptionSearchBaseVisitor

extends SearchBaseVisitor<List<Text>>
Class Inheritance

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public List<Text>
visitBinaryExpression(SearchParser.BinaryExpressionContext
the parse tree
context
)

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 List<Text>
public List<Text>
visitParenExpression(SearchParser.ParenExpressionContext
the parse tree
context
)

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 List<Text>
public List<Text>
visitUnaryExpression(SearchParser.UnaryExpressionContext
the parse tree
context
)

Overrides org.jabref.search.SearchBaseVisitor.visitUnaryExpression.

Implements org.jabref.search.SearchVisitor.visitUnaryExpression.

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

Inherited from org.jabref.search.SearchBaseVisitor:
visitAtomExpressionvisitName

Constructor Detail

DescriptionSearchBaseVisitorback to summary
private DescriptionSearchBaseVisitor()

Method Detail

visitBinaryExpressionback to summary
public List<Text> visitBinaryExpression(SearchParser.BinaryExpressionContext context)

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.

Parameters
context:SearchParser.BinaryExpressionContext

Doc from org.jabref.search.SearchVisitor.visitBinaryExpression.

the parse tree

Returns:List<Text>

Doc from org.jabref.search.SearchVisitor.visitBinaryExpression.

the visitor result

Annotations
@Override
visitComparisonback to summary
public List<Text> visitComparison(SearchParser.ComparisonContext context)

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.

Parameters
context:SearchParser.ComparisonContext

Doc from org.jabref.search.SearchVisitor.visitComparison.

the parse tree

Returns:List<Text>

Doc from org.jabref.search.SearchVisitor.visitComparison.

the visitor result

Annotations
@Override
visitParenExpressionback to summary
public List<Text> visitParenExpression(SearchParser.ParenExpressionContext context)

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.

Parameters
context:SearchParser.ParenExpressionContext

Doc from org.jabref.search.SearchVisitor.visitParenExpression.

the parse tree

Returns:List<Text>

Doc from org.jabref.search.SearchVisitor.visitParenExpression.

the visitor result

Annotations
@Override
visitStartback to summary
public List<Text> visitStart(SearchParser.StartContext context)

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.

Parameters
context:SearchParser.StartContext

Doc from org.jabref.search.SearchVisitor.visitStart.

the parse tree

Returns:List<Text>

Doc from org.jabref.search.SearchVisitor.visitStart.

the visitor result

Annotations
@Override
visitUnaryExpressionback to summary
public List<Text> visitUnaryExpression(SearchParser.UnaryExpressionContext context)

Overrides org.jabref.search.SearchBaseVisitor.visitUnaryExpression.

Implements org.jabref.search.SearchVisitor.visitUnaryExpression.

Doc from org.jabref.search.SearchBaseVisitor.visitUnaryExpression.

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

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

Parameters
context:SearchParser.UnaryExpressionContext

Doc from org.jabref.search.SearchVisitor.visitUnaryExpression.

the parse tree

Returns:List<Text>

Doc from org.jabref.search.SearchVisitor.visitUnaryExpression.

the visitor result

Annotations
@Override