Class NavigableRole

java.lang.Object

org.hibernate.metamodel.model.domain.NavigableRole

All Implemented Interfaces:

Serializable, DotIdentifierSequence

@Incubating
public final class NavigableRole
extends Object
implements DotIdentifierSequence, Serializable

A compound path which represents a ModelPart and uniquely identifies it with the runtime metamodel.

The root will name either an entity or collection.

See Also:

• Serialized Form

API Note:

This is an incubating SPI type, and will move to org.hibernate.spi. It might be renamed to org.hibernate.metamodel.model.mapping.MappingRole; the term "navigable" here is meant to indicate that we could navigate to the specific ModelPart given the role.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTIFIER_MAPPER_PROPERTY

Constructor Summary

Constructors

Constructor	Description
NavigableRole()
NavigableRole(String localName)
NavigableRole(NavigableRole parent, String localName)
NavigableRole(NavigableRole parent, String localName, char separator)

Method Summary

Modifier and Type	Method	Description
NavigableRole	append(String name)	Append a new part to the end of this sequence, returning the new representation.
NavigableRole	appendContainer(String name)	Uses # as the separator rather than a period, the intention being that the incoming name is a ModelPartContainer of some sort.
boolean	equals(Object object)
String	getFullPath()	The full sequence text.
String	getLocalName()	The name of this leaf sequence part.
String	getNavigableName()
NavigableRole	getParent()	The parent sequence part.
int	hashCode()
String	toString()

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface DotIdentifierSequence

getParts, isRoot

Field Details

IDENTIFIER_MAPPER_PROPERTY

public static final String IDENTIFIER_MAPPER_PROPERTY

See Also:

• Constant Field Values

Constructor Details

NavigableRole

public NavigableRole(NavigableRole parent,
 String localName)

NavigableRole

public NavigableRole(NavigableRole parent,
 String localName,
 char separator)

NavigableRole

public NavigableRole(String localName)

NavigableRole

public NavigableRole()

Method Details

append

public NavigableRole append(String name)

Description copied from interface: DotIdentifierSequence

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.

Specified by:

append in interface DotIdentifierSequence

appendContainer

public NavigableRole appendContainer(String name)

Uses # as the separator rather than a period, the intention being that the incoming name is a ModelPartContainer of some sort.

getParent

public NavigableRole getParent()

Description copied from interface: DotIdentifierSequence

The parent sequence part.

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

Specified by:

getParent in interface DotIdentifierSequence

getLocalName

public String getLocalName()

Description copied from interface: DotIdentifierSequence

The name of this leaf sequence part.

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

Specified by:

getLocalName in interface DotIdentifierSequence

getNavigableName

public String getNavigableName()

getFullPath

public String getFullPath()

Description copied from interface: DotIdentifierSequence

The full sequence text.

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

Specified by:

getFullPath in interface DotIdentifierSequence

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object