Nested and Inner Type Summary

Modifier and Type	Class and Description
protected static interface	NavigablePath.FullPathCalculator Effectively a tri-function
protected static class	NavigablePath.RelativePathCollector

Field Summary

Modifier and Type	Field and Description
private final @Nullable String	alias
private final NavigablePath.FullPathCalculator	fullPathCalculator
private final int	hashCode
public static final String	IDENTIFIER_MAPPER_PROPERTY
private final String	identifierForTableGroup
private final String	localName
private final @Nullable NavigablePath	parent

Constructor Summary

Access	Constructor and Description
public	NavigablePath(String localName)
public	NavigablePath(String rootName, @Nullable String alias)
public	NavigablePath(NavigablePath parent, String navigableName)
public	NavigablePath(NavigablePath parent, String localName, @Nullable String alias)
public	NavigablePath(@Nullable NavigablePath parent, String localName, @Nullable String alias, String identifierForTableGroup, NavigablePath.FullPathCalculator fullPathCalculator, int hashCode)

Method Summary

Modifier and Type	Method and Description
public NavigablePath	append(String property) Implements org.hibernate.spi.DotIdentifierSequence.append. Append a new part to the end of this sequence, returning the new representation.
public NavigablePath	append(String property, String alias)
protected static String	calculateIdMapperFullPath(@Nullable NavigablePath parent, String localName, @Nullable String alias) Pattern used for `_identifierMapper`
private static String	calculateNormalFullPath(@Nullable NavigablePath parent, String localName, @Nullable String alias) The normal pattern used for the "full path"
protected static String	calculateRootFullPath(@Nullable NavigablePath parent, String rootName, @Nullable String alias) The pattern used for root NavigablePaths
public boolean	equals(@Nullable Object the reference object with which to compare. other) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public @Nullable String	getAlias()
public String	getFullPath() Implements org.hibernate.spi.DotIdentifierSequence.getFullPath. The full sequence text.
public String	getIdentifierForTableGroup()
public String	getLocalName() Implements org.hibernate.spi.DotIdentifierSequence.getLocalName. The name of this leaf sequence part.
public @Nullable NavigablePath	getParent() Implements org.hibernate.spi.DotIdentifierSequence.getParent. The parent sequence part.
public @Nullable NavigablePath	getRealParent()
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for the object.
public boolean	isAliased()
public boolean	isParent(@Nullable NavigablePath navigablePath) Determine whether this path is part of the given path's parent
public boolean	isParentOrEqual(@Nullable NavigablePath navigablePath) Determine whether this path is part of the given path's parent
public boolean	isSuffix(@Nullable DotIdentifierSequence dotIdentifierSequence) Determine whether the given path is a suffix of this path
protected boolean	localNamesMatch(DotIdentifierSequence other)
protected boolean	localNamesMatch(EntityIdentifierNavigablePath other)
public boolean	pathsMatch(@Nullable NavigablePath p)
public @Nullable String	relativize(NavigablePath base) Ignores aliases in the resulting String
protected void	relativize(NavigablePath base, NavigablePath.RelativePathCollector collector)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
public NavigablePath	treatAs(String entityName)
public NavigablePath	treatAs(String entityName, String alias)
public @Nullable NavigablePath	Returns: the NavigablePath stripped of the suffix part or null if the NavigablePath does not contain the suffix. trimSuffix(@Nullable DotIdentifierSequence the part to remove from the NavigablePath suffix) Removes the suffix part from the NavigablePath, when the NavigablePath does not contain the suffix it returns null;

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

alias	back to summary
private final @Nullable String alias

fullPathCalculator	back to summary
private final NavigablePath.FullPathCalculator fullPathCalculator

hashCode	back to summary
private final int hashCode

IDENTIFIER_MAPPER_PROPERTY	back to summary
public static final String IDENTIFIER_MAPPER_PROPERTY

identifierForTableGroup	back to summary
private final String identifierForTableGroup

localName	back to summary
private final String localName

parent	back to summary
private final @Nullable NavigablePath parent

Constructor Detail

NavigablePath	back to summary
public NavigablePath(String localName)

NavigablePath	back to summary
public NavigablePath(String rootName, @Nullable String alias)

NavigablePath	back to summary
public NavigablePath(NavigablePath parent, String navigableName)

NavigablePath	back to summary
public NavigablePath(NavigablePath parent, String localName, @Nullable String alias)

NavigablePath	back to summary
public NavigablePath(@Nullable NavigablePath parent, String localName, @Nullable String alias, String identifierForTableGroup, NavigablePath.FullPathCalculator fullPathCalculator, int hashCode)

Method Detail

append back to summary

append	back to summary
public NavigablePath append(String property) Implements org.hibernate.spi.DotIdentifierSequence.append. Doc from org.hibernate.spi.DotIdentifierSequence.append. Append a new part to the end of this sequence, returning the new representation. Given the sequence `a.b.c`, appending `d` results in the new sequence `a.b.c.d`.

public NavigablePath append(String property)

Implements org.hibernate.spi.DotIdentifierSequence.append.

Doc from org.hibernate.spi.DotIdentifierSequence.append.

Append a new part to the end of this sequence, returning the new representation.

Given the sequence a.b.c, appending d results in the new sequence a.b.c.d.

append	back to summary
public NavigablePath append(String property, String alias)

calculateIdMapperFullPath	back to summary
protected static String calculateIdMapperFullPath(@Nullable NavigablePath parent, String localName, @Nullable String alias) Pattern used for `_identifierMapper`

calculateNormalFullPath	back to summary
private static String calculateNormalFullPath(@Nullable NavigablePath parent, String localName, @Nullable String alias) The normal pattern used for the "full path"

calculateRootFullPath	back to summary
protected static String calculateRootFullPath(@Nullable NavigablePath parent, String rootName, @Nullable String alias) The pattern used for root NavigablePaths

equals back to summary

equals	back to summary
public boolean equals(@Nullable Object other) 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. Parameters other:@Nullable Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(@Nullable Object other)

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.

Parameters

other:@Nullable Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getAlias	back to summary
public @Nullable String getAlias()

getFullPath back to summary

getFullPath	back to summary
public String getFullPath() Implements org.hibernate.spi.DotIdentifierSequence.getFullPath. Doc from org.hibernate.spi.DotIdentifierSequence.getFullPath. The full sequence text. Given the sequence `a.b.c`, returns the string `"a.b.c"`. Annotations @Override

public String getFullPath()

Implements org.hibernate.spi.DotIdentifierSequence.getFullPath.

Doc from org.hibernate.spi.DotIdentifierSequence.getFullPath.

The full sequence text.

Given the sequence a.b.c, returns the string "a.b.c".

Annotations

@Override

getIdentifierForTableGroup	back to summary
public String getIdentifierForTableGroup()

getLocalName back to summary

getLocalName	back to summary
public String getLocalName() Implements org.hibernate.spi.DotIdentifierSequence.getLocalName. Doc from org.hibernate.spi.DotIdentifierSequence.getLocalName. The name of this leaf sequence part. Given the sequence `a.b.c`, returns the string `"c"`. Annotations @Override

public String getLocalName()

Implements org.hibernate.spi.DotIdentifierSequence.getLocalName.

Doc from org.hibernate.spi.DotIdentifierSequence.getLocalName.

The name of this leaf sequence part.

Given the sequence a.b.c, returns the string "c".

Annotations

@Override

getParent back to summary

getParent	back to summary
public @Nullable NavigablePath getParent() Implements org.hibernate.spi.DotIdentifierSequence.getParent. Doc from org.hibernate.spi.DotIdentifierSequence.getParent. The parent sequence part. Given the sequence `a.b.c`, returns the sequence `a.b`. Annotations @Override

public @Nullable NavigablePath getParent()

Implements org.hibernate.spi.DotIdentifierSequence.getParent.

Doc from org.hibernate.spi.DotIdentifierSequence.getParent.

The parent sequence part.

Given the sequence a.b.c, returns the sequence a.b.

Annotations

@Override

getRealParent	back to summary
public @Nullable NavigablePath getRealParent()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the 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. Returns:int a hash code value for this object. Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the 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.

Returns:int

a hash code value for this object.

Annotations

@Override

isAliased	back to summary
public boolean isAliased()

isParent	back to summary
public boolean isParent(@Nullable NavigablePath navigablePath) Determine whether this path is part of the given path's parent

isParentOrEqual	back to summary
public boolean isParentOrEqual(@Nullable NavigablePath navigablePath) Determine whether this path is part of the given path's parent

isSuffix	back to summary
public boolean isSuffix(@Nullable DotIdentifierSequence dotIdentifierSequence) Determine whether the given path is a suffix of this path

localNamesMatch	back to summary
protected boolean localNamesMatch(DotIdentifierSequence other)

localNamesMatch	back to summary
protected boolean localNamesMatch(EntityIdentifierNavigablePath other)

pathsMatch	back to summary
public boolean pathsMatch(@Nullable NavigablePath p)

relativize	back to summary
public @Nullable String relativize(NavigablePath base) Ignores aliases in the resulting String

relativize	back to summary
protected void relativize(NavigablePath base, NavigablePath.RelativePathCollector collector)

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations

@Override

treatAs	back to summary
public NavigablePath treatAs(String entityName)

treatAs	back to summary
public NavigablePath treatAs(String entityName, String alias)

trimSuffix	back to summary
public @Nullable NavigablePath trimSuffix(@Nullable DotIdentifierSequence suffix) Removes the suffix part from the NavigablePath, when the NavigablePath does not contain the suffix it returns null; Parameters suffix:@Nullable DotIdentifierSequence the part to remove from the NavigablePath Returns:@Nullable NavigablePath the NavigablePath stripped of the suffix part or null if the NavigablePath does not contain the suffix.

trimSuffix

back to summary

public @Nullable NavigablePath trimSuffix(@Nullable DotIdentifierSequence suffix)

Removes the suffix part from the NavigablePath, when the NavigablePath does not contain the suffix it returns null;

Parameters

suffix:@Nullable DotIdentifierSequence: the part to remove from the NavigablePath

Returns:@Nullable NavigablePath

the NavigablePath stripped of the suffix part or null if the NavigablePath does not contain the suffix.

org.hibernate.spi back to summary

protected Interface NavigablePath.FullPathCalculator

Annotations

extends Serializable

@FunctionalInterface

Effectively a tri-function

Method Summary

Modifier and Type	Method and Description
public String	calculateFullPath(@Nullable NavigablePath parent, String localName, @Nullable String alias)

Method Detail

calculateFullPath	back to summary
public String calculateFullPath(@Nullable NavigablePath parent, String localName, @Nullable String alias)

org.hibernate.spi back to summary

protected Class NavigablePath.RelativePathCollector

Class Inheritance

extends Object

java.lang.Object
org.hibernate.spi.NavigablePath.RelativePathCollector

Field Summary

Modifier and Type	Field and Description
private StringBuilder	buffer
private boolean	matchedBase

Constructor Summary

Access	Constructor and Description
protected	RelativePathCollector()

Method Summary

Modifier and Type	Method and Description
public void	collectPath(String path)
public @Nullable String	resolve()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

buffer	back to summary
private StringBuilder buffer

matchedBase	back to summary
private boolean matchedBase

Constructor Detail

RelativePathCollector	back to summary
protected RelativePathCollector()

Method Detail

collectPath	back to summary
public void collectPath(String path)

resolve	back to summary
public @Nullable String resolve()

public Class NavigablePath

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Interface NavigablePath.FullPathCalculator

Method Summary

Method Detail

protected Class NavigablePath.RelativePathCollector

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail