Package org.hibernate.boot.model.internal

Class AnnotatedJoinColumn

java.lang.Object

org.hibernate.boot.model.internal.AnnotatedColumn

org.hibernate.boot.model.internal.AnnotatedJoinColumn

public class AnnotatedJoinColumn
extends AnnotatedColumn

An element of a join condition, logically representing a JoinColumn annotation, but not every instance corresponds to an explicit annotation in the Java code.

There's no exact analog of this class in the mapping model, so some information is lost when it's transformed into a Column.

Field Summary

Fields inherited from class org.hibernate.boot.model.internal.AnnotatedColumn

sqlType

Method Summary

Modifier and Type	Method	Description
protected void	addColumnBinding(SimpleValue value)
void	addDefaultJoinColumnName(PersistentClass referencedEntity, String logicalReferencedColumn)
void	applyJoinAnnotation(jakarta.persistence.JoinColumn joinColumn, String defaultName)
static AnnotatedJoinColumn	buildInheritanceJoinColumn(jakarta.persistence.PrimaryKeyJoinColumn primaryKeyJoinColumn, jakarta.persistence.JoinColumn joinColumn, Value identifier, AnnotatedJoinColumns parent, MetadataBuildingContext context)	Called for InheritanceType.JOINED entities.
static AnnotatedJoinColumn	buildJoinFormula(JoinFormula joinFormula, AnnotatedJoinColumns parent)
static void	checkIfJoinColumn(Object columns, PropertyHolder holder, PropertyData property)
void	copyReferencedStructureAndCreateDefaultJoinColumns(PersistentClass referencedEntity, SimpleValue referencedValue, SimpleValue value)
AnnotatedJoinColumns	getParent()
String	getReferencedColumn()	The referencedColumnName.
boolean	isReferenceImplicit()
void	linkValueUsingAColumnCopy(Column column, SimpleValue value)	used for mappedBy cases
void	linkValueUsingDefaultColumnNaming(Column referencedColumn, PersistentClass referencedEntity, SimpleValue value)
void	overrideFromReferencedColumnIfNecessary(Column column)	Called to apply column definitions from the referenced FK column to this column.
void	redefineColumnName(String columnName, String propertyName, boolean applyNamingStrategy)
void	setParent(AnnotatedColumns parent)
void	setParent(AnnotatedJoinColumns parent)
void	setReferencedColumn(String referencedColumn)
String	toString()

Methods inherited from class org.hibernate.boot.model.internal.AnnotatedColumn

addIndex, bind, buildColumnFromAnnotation, buildColumnFromNoAnnotation, buildColumnOrFormulaFromAnnotation, buildColumnsFromAnnotations, buildColumnsFromAnnotations, buildColumnsOrFormulaFromAnnotation, buildFormulaFromAnnotation, forceNotNull, getCheckConstraint, getComment, getDefaultValue, getExplicitTableName, getFormulaString, getGeneratedAs, getLength, getLogicalColumnName, getMappingColumn, getName, getPrecision, getScale, getSqlType, initMappingColumn, isFormula, isImplicit, isInsertable, isNameDeferred, isNullable, isUnique, isUpdatable, linkWithAggregateValue, linkWithValue, setCheckConstraint, setComment, setDefaultValue, setExplicitTableName, setFormula, setImplicit, setInsertable, setLength, setLogicalColumnName, setMappingColumn, setNullable, setPrecision, setScale, setSqlType, setUnique, setUpdatable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

setReferencedColumn

public void setReferencedColumn(String referencedColumn)

getReferencedColumn

public String getReferencedColumn()

The referencedColumnName.

isReferenceImplicit

public boolean isReferenceImplicit()

Returns:

true if the @JoinColumn annotation did not specify the referencedColumnName.

buildJoinFormula

public static AnnotatedJoinColumn buildJoinFormula(JoinFormula joinFormula,
                                                   AnnotatedJoinColumns parent)

applyJoinAnnotation

public void applyJoinAnnotation(jakarta.persistence.JoinColumn joinColumn,
                                String defaultName)

buildInheritanceJoinColumn

public static AnnotatedJoinColumn buildInheritanceJoinColumn(jakarta.persistence.PrimaryKeyJoinColumn primaryKeyJoinColumn,
                                                             jakarta.persistence.JoinColumn joinColumn,
                                                             Value identifier,
                                                             AnnotatedJoinColumns parent,
                                                             MetadataBuildingContext context)

Called for InheritanceType.JOINED entities.

checkIfJoinColumn

public static void checkIfJoinColumn(Object columns,
                                     PropertyHolder holder,
                                     PropertyData property)

copyReferencedStructureAndCreateDefaultJoinColumns

public void copyReferencedStructureAndCreateDefaultJoinColumns(PersistentClass referencedEntity,
                                                               SimpleValue referencedValue,
                                                               SimpleValue value)

linkValueUsingDefaultColumnNaming

public void linkValueUsingDefaultColumnNaming(Column referencedColumn,
                                              PersistentClass referencedEntity,
                                              SimpleValue value)

addDefaultJoinColumnName

public void addDefaultJoinColumnName(PersistentClass referencedEntity,
                                     String logicalReferencedColumn)

linkValueUsingAColumnCopy

public void linkValueUsingAColumnCopy(Column column,
                                      SimpleValue value)

used for mappedBy cases

addColumnBinding

protected void addColumnBinding(SimpleValue value)

Overrides:

addColumnBinding in class AnnotatedColumn

overrideFromReferencedColumnIfNecessary

public void overrideFromReferencedColumnIfNecessary(Column column)

Called to apply column definitions from the referenced FK column to this column.

Parameters:

column - the referenced column.

redefineColumnName

public void redefineColumnName(String columnName,
                               String propertyName,
                               boolean applyNamingStrategy)

Overrides:

redefineColumnName in class AnnotatedColumn

toString

public String toString()

Overrides:

toString in class AnnotatedColumn

getParent

public AnnotatedJoinColumns getParent()

Overrides:

getParent in class AnnotatedColumn

setParent

public void setParent(AnnotatedColumns parent)

Overrides:

setParent in class AnnotatedColumn

setParent

public void setParent(AnnotatedJoinColumns parent)