de.ipcon.db.oql

Class PathNode

java.lang.Object

de.ipcon.db.oql.ParseTreeNode

de.ipcon.db.oql.PathNode

public class PathNode
extends ParseTreeNode

A Node in the Parse tree which represents a path expression.

There's some parsing going on here as well, just because the path expression has some special syntax for special needs which I don't want to pollute into the 'pure' OQL expression parsing.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PathNode.HstoreExtractionMode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VIRTUAL_ARRAY_MODIFIER_KEYS
static java.lang.String	VIRTUAL_ARRAY_MODIFIER_VALUES
static java.lang.String	VIRTUAL_MODIFIER_FALLBACK

Constructor Summary

Constructors

Constructor and Description
PathNode(Parser parser, QueryNameSpace nameSpace, boolean shortcutJoins, java.lang.String explicitRootAlias, boolean registerInNameSpace)
PathNode(ParseTreeNode parent, Parser parser, QueryNameSpace nameSpace, boolean shortcutJoins)
PathNode(java.lang.String[] path, QueryNameSpace nameSpace, boolean shortcutJoins)
PathNode(java.lang.String s, Parser parser, QueryNameSpace nameSpace, boolean shortcutJoins)

Method Summary

Modifier and Type	Method and Description
void	addChild(ParseTreeNode child) Adds a new node as a child of this node.
void	addPathPart(PathPart part)
void	addPathPart(java.lang.String name, boolean nullsafeDotted, java.lang.String typeCast, boolean only)
void	appendDebugString(java.lang.StringBuilder s) appends a String representation of this node including it's children to the given StringBuilder
boolean	endsWithAnchor()
de.ipcon.db.oql.TableSurrogate	getAnchor()
EntityI	getAnchorEntity()
AttributeI	getAttributeOfLastPathPart()
ParseTreeNode	getChild(int index) Accessor method for individual children of this node.
int	getChildCount() Accessor method for the number of children of this node.
java.util.List	getChildren()
de.ipcon.db.oql.ExpressionResultType	getExpressionResultType()
PathPart	getFirstPathPart()
PathNode.HstoreExtractionMode	getHstoreExtractionMode()
PathPart	getLastPathPart()
QueryNameSpace	getNameSpace()
int	getOperatorPrecedence()
java.util.List<PathPart>	getPathParts()
java.lang.String	getPathPartsAsString()
java.lang.String	getPathPartsAsString(int idx)
int	getPathPartsCount()
java.lang.Class<?>	getResultClass() Returns the Java result type of this path.
boolean	hasFallback() True if this path expression explicitly requested language fallback resolution via the terminal .fallback modifier on an hstore column.
boolean	isLeaf() Specifies whether this node is a leaf.
void	prependPathPart(PathPart part)
void	prependPathPart(java.lang.String name)
void	registerInNameSpaceNow()
void	removeLastPathPart()
void	renderRawHstoreSQL(java.lang.StringBuilder s) Renders the raw column path without wrapping it in native PostgreSQL array functions (akeys/avals) and without appending virtual L10n locale keys.
void	renderSQL(java.lang.StringBuilder s, java.lang.Object[] oqlArgs, java.util.List sqlArgs) Renders this node into a StringBuilder as SQL statement, copying arguments from oqlArgs to sqlArgs if needed.
void	setAnchor(de.ipcon.db.oql.TableSurrogate anchor, EntityI anchorEntity, boolean endsWithAnchor)
void	setNameSpace(QueryNameSpace nameSpace)
java.lang.String	toString() returns a String representation of just this node.
boolean	touchesLocalizedAttribute() True if rendering this path into SQL depends on locale state (either direct virtual L10n lookup or fallback chain resolution).

Methods inherited from class de.ipcon.db.oql.ParseTreeNode

appendComments, debugString, getParent, getToken, getType, hasType, isRoot, removeChild, setOwnType, setParent, setToken, setType, setType, setType, setTypeFromChildren, setTypeFromParent

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

VIRTUAL_ARRAY_MODIFIER_KEYS

public static final java.lang.String VIRTUAL_ARRAY_MODIFIER_KEYS

See Also:

Constant Field Values

VIRTUAL_ARRAY_MODIFIER_VALUES

public static final java.lang.String VIRTUAL_ARRAY_MODIFIER_VALUES

See Also:

Constant Field Values

VIRTUAL_MODIFIER_FALLBACK

public static final java.lang.String VIRTUAL_MODIFIER_FALLBACK

See Also:

Constant Field Values

Constructor Detail

PathNode

public PathNode(java.lang.String s,
                Parser parser,
                QueryNameSpace nameSpace,
                boolean shortcutJoins)
         throws OQLSyntaxException

Throws:

OQLSyntaxException

PathNode

public PathNode(java.lang.String[] path,
                QueryNameSpace nameSpace,
                boolean shortcutJoins)
         throws OQLSyntaxException

Throws:

OQLSyntaxException

PathNode

public PathNode(Parser parser,
                QueryNameSpace nameSpace,
                boolean shortcutJoins,
                java.lang.String explicitRootAlias,
                boolean registerInNameSpace)
         throws OQLSyntaxException

Throws:

OQLSyntaxException

PathNode

public PathNode(ParseTreeNode parent,
                Parser parser,
                QueryNameSpace nameSpace,
                boolean shortcutJoins)
         throws OQLSyntaxException

Throws:

OQLSyntaxException

Method Detail

registerInNameSpaceNow

public void registerInNameSpaceNow()
                            throws OQLSyntaxException

Throws:

OQLSyntaxException

setNameSpace

public void setNameSpace(QueryNameSpace nameSpace)

getNameSpace

public QueryNameSpace getNameSpace()

setAnchor

public void setAnchor(de.ipcon.db.oql.TableSurrogate anchor,
                      EntityI anchorEntity,
                      boolean endsWithAnchor)

getAnchor

public final de.ipcon.db.oql.TableSurrogate getAnchor()

getAnchorEntity

public final EntityI getAnchorEntity()

endsWithAnchor

public final boolean endsWithAnchor()

getAttributeOfLastPathPart

public final AttributeI getAttributeOfLastPathPart()

addChild

public void addChild(ParseTreeNode child)

Description copied from class: ParseTreeNode

Adds a new node as a child of this node. Changes the nodes parent to this.

Overrides:

addChild in class ParseTreeNode

Parameters:

child - The new child

getChildren

public java.util.List getChildren()

getChild

public ParseTreeNode getChild(int index)

Description copied from class: ParseTreeNode

Accessor method for individual children of this node.

Overrides:

getChild in class ParseTreeNode

Parameters:

index - the index of the child to retrieve.

Returns:

the index child of this node.

getChildCount

public int getChildCount()

Description copied from class: ParseTreeNode

Accessor method for the number of children of this node.

Overrides:

getChildCount in class ParseTreeNode

Returns:

the number of children of this node.

isLeaf

public boolean isLeaf()

Description copied from class: ParseTreeNode

Specifies whether this node is a leaf.

Overrides:

isLeaf in class ParseTreeNode

Returns:

True if the node does not have any children, otherwise false.

addPathPart

public void addPathPart(java.lang.String name,
                        boolean nullsafeDotted,
                        java.lang.String typeCast,
                        boolean only)

addPathPart

public void addPathPart(PathPart part)

getExpressionResultType

public de.ipcon.db.oql.ExpressionResultType getExpressionResultType()

Overrides:

getExpressionResultType in class ParseTreeNode

getResultClass

public java.lang.Class<?> getResultClass()

Returns the Java result type of this path. Virtual scalar hstore extractions (.fallback, virtual L10n) yield String, whereas collections (.keys, .values) yield String[].

Overrides:

getResultClass in class ParseTreeNode

Returns:

A non-null Java class of this node, possibly defaulting to java.lang.Object if the type is not known or not applicable.

toString

public java.lang.String toString()

Description copied from class: ParseTreeNode

returns a String representation of just this node.

Overrides:

toString in class ParseTreeNode

appendDebugString

public void appendDebugString(java.lang.StringBuilder s)

Description copied from class: ParseTreeNode

appends a String representation of this node including it's children to the given StringBuilder

Overrides:

appendDebugString in class ParseTreeNode

getFirstPathPart

public final PathPart getFirstPathPart()

getLastPathPart

public final PathPart getLastPathPart()

removeLastPathPart

public void removeLastPathPart()

prependPathPart

public void prependPathPart(java.lang.String name)

prependPathPart

public void prependPathPart(PathPart part)

getPathParts

public final java.util.List<PathPart> getPathParts()

getPathPartsCount

public int getPathPartsCount()

getPathPartsAsString

public java.lang.String getPathPartsAsString()

getPathPartsAsString

public java.lang.String getPathPartsAsString(int idx)

getHstoreExtractionMode

public final PathNode.HstoreExtractionMode getHstoreExtractionMode()

renderRawHstoreSQL

public void renderRawHstoreSQL(java.lang.StringBuilder s)

Renders the raw column path without wrapping it in native PostgreSQL array functions (akeys/avals) and without appending virtual L10n locale keys. Used for high-performance GIN index subset queries and trigram casts.

renderSQL

public void renderSQL(java.lang.StringBuilder s,
                      java.lang.Object[] oqlArgs,
                      java.util.List sqlArgs)

Description copied from class: ParseTreeNode

Renders this node into a StringBuilder as SQL statement, copying arguments from oqlArgs to sqlArgs if needed.

Overrides:

renderSQL in class ParseTreeNode

hasFallback

public boolean hasFallback()

True if this path expression explicitly requested language fallback resolution via the terminal .fallback modifier on an hstore column.

touchesLocalizedAttribute

public boolean touchesLocalizedAttribute()

True if rendering this path into SQL depends on locale state (either direct virtual L10n lookup or fallback chain resolution).

getOperatorPrecedence

public int getOperatorPrecedence()

Overrides:

getOperatorPrecedence in class ParseTreeNode