Top Description Fields Constructors Methods
org.hibernate.metamodel.model.domain

public final Class NavigableRole

extends Object
implements DotIdentifierSequence, Serializable
Class Inheritance
All Implemented Interfaces
java.io.Serializable, org.hibernate.spi.DotIdentifierSequence
Imports
java.io.Serializable, org.hibernate.internal.util.StringHelper, org.hibernate.spi.DotIdentifierSequence, .NavigablePath
A compound path which represents a org.hibernate.metamodel.mapping.ModelPart and uniquely identifies it with the runtime metamodel.

The root will name either an entity or collection

API Note

Poorly named. Should probably have been `org.hibernate.metamodel.model.mapping.MappingRole`; the term "navigable" here is meant to indicate that we could navigate to the specific org.hibernate.metamodel.mapping.ModelPart given the role.

Author
Steve Ebersole

Field Summary

Modifier and TypeField and Description
private final String
fullPath

public static final String
IDENTIFIER_MAPPER_PROPERTY

private final String
localName

private final NavigableRole
parent

Constructor Summary

AccessConstructor and Description

Method Summary

Modifier and TypeMethod and Description
public NavigableRole
append(String name)

Implements org.hibernate.spi.DotIdentifierSequence.append.

Append a new part to the end of this sequence, returning the new representation.
public NavigableRole
appendContainer(String name)

Uses `#` as the separator rather than `.`.

public boolean
equals(final Object
the reference object with which to compare.
o)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.
public String
getFullPath()

Implements org.hibernate.spi.DotIdentifierSequence.getFullPath.

The full sequence text.
public String
getLocalName()

Implements org.hibernate.spi.DotIdentifierSequence.getLocalName.

The name of this leaf sequence part.
public String
getNavigableName()

public NavigableRole
getParent()

Implements org.hibernate.spi.DotIdentifierSequence.getParent.

The parent sequence part.
public int
hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code value for the object.
public boolean
isRoot()

Overrides default org.hibernate.spi.DotIdentifierSequence.isRoot.

Is this sequence node the root of the sequence?
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.
Inherited from java.lang.Object:
clonefinalizegetClassnotifynotifyAllwaitwaitwait

Field Detail

fullPathback to summary
private final String fullPath
IDENTIFIER_MAPPER_PROPERTYback to summary
public static final String IDENTIFIER_MAPPER_PROPERTY
localNameback to summary
private final String localName
parentback to summary
private final NavigableRole parent

Constructor Detail

NavigableRoleback to summary
public NavigableRole(NavigableRole parent, String localName)
NavigableRoleback to summary
public NavigableRole(NavigableRole parent, String localName, char separator)
NavigableRoleback to summary
public NavigableRole(String localName)
NavigableRoleback to summary
public NavigableRole()

Method Detail

appendback to summary
public NavigableRole append(String name)

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.

appendContainerback to summary
public NavigableRole appendContainer(String name)

Uses `#` as the separator rather than `.`. The intention being that the incoming name is a org.hibernate.metamodel.mapping.ModelPartContainer of some sort todo (6.0) : better name?

equalsback to summary
public boolean equals(final 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.

Parameters
o: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
getFullPathback 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".

getLocalNameback 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
getNavigableNameback to summary
public String getNavigableName()
getParentback to summary
public NavigableRole 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.

hashCodeback 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
isRootback to summary
public boolean isRoot()

Overrides default org.hibernate.spi.DotIdentifierSequence.isRoot.

Doc from org.hibernate.spi.DotIdentifierSequence.isRoot.

Is this sequence node the root of the sequence?

Same as checking the nullness of getParent().

toStringback 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