Top Fields Constructors Methods
org.hibernate.metamodel.mapping.ordering.ast

public Class ParseTreeVisitor

extends OrderingParserBaseVisitor<Object>
Class Inheritance
Imports
java.util.ArrayList, .Collections, .List, .Locale, org.hibernate.internal.util.QuotingHelper, org.hibernate.query.NullPrecedence, .SortDirection, org.hibernate.grammars.ordering.OrderingParser, .OrderingParserBaseVisitor, org.hibernate.metamodel.mapping.PluralAttributeMapping, org.hibernate.metamodel.mapping.ordering.TranslationContext, org.hibernate.query.sqm.ParsingException, org.hibernate.query.sqm.function.SqmFunctionDescriptor, org.antlr.v4.runtime.tree.ParseTree, .TerminalNode
Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final PathConsumer
pathConsumer

private final TranslationContext
translationContext

Constructor Summary

AccessConstructor and Description
public
ParseTreeVisitor(PluralAttributeMapping pluralAttributeMapping, TranslationContext translationContext)

Method Summary

Modifier and TypeMethod and Description
public String
visitCollationSpecification(OrderingParser.CollationSpecificationContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitCollationSpecification.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitCollationSpecification.

Visit a parse tree produced by OrderingParser#collationSpecification.
public OrderingExpression
visitDotIdentifier(OrderingParser.DotIdentifierContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitDotIdentifier.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifier.

Visit a parse tree produced by OrderingParser#dotIdentifier.
public OrderingExpression
visitDotIdentifierExpression(OrderingParser.DotIdentifierExpressionContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitDotIdentifierExpression.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifierExpression.

Visit a parse tree produced by the DotIdentifierExpression labeled alternative in OrderingParser#expression.
public FunctionExpression
visitFunction(OrderingParser.FunctionContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunction.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunction.

Deprecated as a consequence of FunctionExpression being deprecated.
Visit a parse tree produced by OrderingParser#function.
public OrderingExpression
visitFunctionArgument(OrderingParser.FunctionArgumentContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunctionArgument.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionArgument.

Visit a parse tree produced by OrderingParser#functionArgument.
public OrderingExpression
visitFunctionExpression(OrderingParser.FunctionExpressionContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunctionExpression.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionExpression.

Visit a parse tree produced by the FunctionExpression labeled alternative in OrderingParser#expression.
public OrderingExpression
visitIdentifier(OrderingParser.IdentifierContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitIdentifier.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifier.

Visit a parse tree produced by OrderingParser#identifier.
public OrderingExpression
visitIdentifierExpression(OrderingParser.IdentifierExpressionContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitIdentifierExpression.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifierExpression.

Visit a parse tree produced by the IdentifierExpression labeled alternative in OrderingParser#expression.
public OrderingExpression
visitLiteral(OrderingParser.LiteralContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitLiteral.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitLiteral.

Visit a parse tree produced by OrderingParser#literal.
public List<OrderingSpecification>
visitOrderByFragment(OrderingParser.OrderByFragmentContext
the parse tree
ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitOrderByFragment.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitOrderByFragment.

Visit a parse tree produced by OrderingParser#orderByFragment.
public OrderingSpecification
visitSortSpecification(OrderingParser.SortSpecificationContext
the parse tree
parsedSpec)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitSortSpecification.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitSortSpecification.

Visit a parse tree produced by OrderingParser#sortSpecification.
public Object
visitTerminal(TerminalNode
The TerminalNode to visit.
node)

Overrides org.antlr.v4.runtime.tree.AbstractParseTreeVisitor.visitTerminal.

Implements org.antlr.v4.runtime.tree.ParseTreeVisitor.visitTerminal.

Visit a terminal node, and return a user-defined result of the operation.
Inherited from org.hibernate.grammars.ordering.OrderingParserBaseVisitor:
visitDirectionvisitFunctionArgumentsvisitNullsPrecedencevisitPackagedFunctionvisitSimpleFunction

Field Detail

pathConsumerback to summary
private final PathConsumer pathConsumer
translationContextback to summary
private final TranslationContext translationContext

Constructor Detail

ParseTreeVisitorback to summary
public ParseTreeVisitor(PluralAttributeMapping pluralAttributeMapping, TranslationContext translationContext)

Method Detail

visitCollationSpecificationback to summary
public String visitCollationSpecification(OrderingParser.CollationSpecificationContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitCollationSpecification.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitCollationSpecification.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitCollationSpecification.

Visit a parse tree produced by OrderingParser#collationSpecification.

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

Parameters
ctx:OrderingParser.CollationSpecificationContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitCollationSpecification.

the parse tree

Returns:String

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitCollationSpecification.

the visitor result

Annotations
@Override
visitDotIdentifierback to summary
public OrderingExpression visitDotIdentifier(OrderingParser.DotIdentifierContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitDotIdentifier.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifier.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitDotIdentifier.

Visit a parse tree produced by OrderingParser#dotIdentifier.

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

Parameters
ctx:OrderingParser.DotIdentifierContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifier.

the parse tree

Returns:OrderingExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifier.

the visitor result

Annotations
@Override
visitDotIdentifierExpressionback to summary
public OrderingExpression visitDotIdentifierExpression(OrderingParser.DotIdentifierExpressionContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitDotIdentifierExpression.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifierExpression.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitDotIdentifierExpression.

Visit a parse tree produced by the DotIdentifierExpression labeled alternative in OrderingParser#expression.

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

Parameters
ctx:OrderingParser.DotIdentifierExpressionContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifierExpression.

the parse tree

Returns:OrderingExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitDotIdentifierExpression.

the visitor result

Annotations
@Override
visitFunctionback to summary
public FunctionExpression visitFunction(OrderingParser.FunctionContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunction.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunction.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunction.

Deprecated

as a consequence of FunctionExpression being deprecated. See corresponding docs for further information.

Visit a parse tree produced by OrderingParser#function.

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

Parameters
ctx:OrderingParser.FunctionContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunction.

the parse tree

Returns:FunctionExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunction.

the visitor result

Annotations
@Override
visitFunctionArgumentback to summary
public OrderingExpression visitFunctionArgument(OrderingParser.FunctionArgumentContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunctionArgument.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionArgument.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunctionArgument.

Visit a parse tree produced by OrderingParser#functionArgument.

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

Parameters
ctx:OrderingParser.FunctionArgumentContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionArgument.

the parse tree

Returns:OrderingExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionArgument.

the visitor result

Annotations
@Override
visitFunctionExpressionback to summary
public OrderingExpression visitFunctionExpression(OrderingParser.FunctionExpressionContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunctionExpression.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionExpression.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitFunctionExpression.

Visit a parse tree produced by the FunctionExpression labeled alternative in OrderingParser#expression.

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

Parameters
ctx:OrderingParser.FunctionExpressionContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionExpression.

the parse tree

Returns:OrderingExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitFunctionExpression.

the visitor result

Annotations
@Override
visitIdentifierback to summary
public OrderingExpression visitIdentifier(OrderingParser.IdentifierContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitIdentifier.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifier.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitIdentifier.

Visit a parse tree produced by OrderingParser#identifier.

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

Parameters
ctx:OrderingParser.IdentifierContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifier.

the parse tree

Returns:OrderingExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifier.

the visitor result

Annotations
@Override
visitIdentifierExpressionback to summary
public OrderingExpression visitIdentifierExpression(OrderingParser.IdentifierExpressionContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitIdentifierExpression.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifierExpression.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitIdentifierExpression.

Visit a parse tree produced by the IdentifierExpression labeled alternative in OrderingParser#expression.

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

Parameters
ctx:OrderingParser.IdentifierExpressionContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifierExpression.

the parse tree

Returns:OrderingExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitIdentifierExpression.

the visitor result

Annotations
@Override
visitLiteralback to summary
public OrderingExpression visitLiteral(OrderingParser.LiteralContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitLiteral.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitLiteral.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitLiteral.

Visit a parse tree produced by OrderingParser#literal.

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

Parameters
ctx:OrderingParser.LiteralContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitLiteral.

the parse tree

Returns:OrderingExpression

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitLiteral.

the visitor result

Annotations
@Override
visitOrderByFragmentback to summary
public List<OrderingSpecification> visitOrderByFragment(OrderingParser.OrderByFragmentContext ctx)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitOrderByFragment.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitOrderByFragment.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitOrderByFragment.

Visit a parse tree produced by OrderingParser#orderByFragment.

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

Parameters
ctx:OrderingParser.OrderByFragmentContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitOrderByFragment.

the parse tree

Returns:List<OrderingSpecification>

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitOrderByFragment.

the visitor result

Annotations
@Override
visitSortSpecificationback to summary
public OrderingSpecification visitSortSpecification(OrderingParser.SortSpecificationContext parsedSpec)

Overrides org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitSortSpecification.

Implements org.hibernate.grammars.ordering.OrderingParserVisitor.visitSortSpecification.

Doc from org.hibernate.grammars.ordering.OrderingParserBaseVisitor.visitSortSpecification.

Visit a parse tree produced by OrderingParser#sortSpecification.

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

Parameters
parsedSpec:OrderingParser.SortSpecificationContext

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitSortSpecification.

the parse tree

Returns:OrderingSpecification

Doc from org.hibernate.grammars.ordering.OrderingParserVisitor.visitSortSpecification.

the visitor result

Annotations
@Override
visitTerminalback to summary
public Object visitTerminal(TerminalNode node)

Overrides org.antlr.v4.runtime.tree.AbstractParseTreeVisitor.visitTerminal.

Implements org.antlr.v4.runtime.tree.ParseTreeVisitor.visitTerminal.

Doc from org.antlr.v4.runtime.tree.ParseTreeVisitor.visitTerminal.

Visit a terminal node, and return a user-defined result of the operation.

Parameters
node:TerminalNode

The TerminalNode to visit.

Returns:Object

The result of visiting the node.

Annotations
@Override