Package org.hibernate.metamodel.model.domain.internal

Class SingularAttributeImpl<D,J>

java.lang.Object

org.hibernate.metamodel.model.domain.internal.AbstractAttribute<D,J,J>

org.hibernate.metamodel.model.domain.internal.SingularAttributeImpl<D,J>

All Implemented Interfaces:

Attribute<D,J>, Bindable<J>, SingularAttribute<D,J>, Serializable, PersistentAttribute<D,J>, SingularPersistentAttribute<D,J>, BindableType<J>, SqmExpressible<J>, SqmJoinable<D,J>, SqmPathSource<J>, SqmExpressibleAccessor<J>

Direct Known Subclasses:

SingularAttributeImpl.Identifier, SingularAttributeImpl.Version

public class SingularAttributeImpl<D,J>
extends AbstractAttribute<D,J,J>
implements SingularPersistentAttribute<D,J>, Serializable

Author:

Emmanuel Bernard, Steve Ebersole

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SingularAttributeImpl.Identifier<D,J>	Subclass used to simplify instantiation of singular attributes representing an entity's identifier.
static class	SingularAttributeImpl.Version<X,Y>	Subclass used to simply instantiation of singular attributes representing an entity's version.

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Attribute

Attribute.PersistentAttributeType

Nested classes/interfaces inherited from interface jakarta.persistence.metamodel.Bindable

Bindable.BindableType

Constructor Summary

Constructors

Constructor	Description
SingularAttributeImpl(ManagedDomainType<D> declaringType, String name, AttributeClassification attributeClassification, DomainType<J> attributeType, JavaType<?> relationalJavaType, Member member, boolean isIdentifier, boolean isVersion, boolean isOptional, boolean isGeneric, MetadataContext metadataContext)

Method Summary

Modifier and Type	Method	Description
NavigablePath	createNavigablePath(SqmPath<?> parent, String alias)
SqmAttributeJoin<D,J>	createSqmJoin(SqmFrom<?,D> lhs, SqmJoinType joinType, String alias, boolean fetched, SqmCreationState creationState)
SqmPath<J>	createSqmPath(SqmPath<?> lhs, SqmPathSource<?> intermediatePathSource)	Create an SQM path for this source relative to the given left hand side
SqmPathSource<?>	findSubPathSource(String name)	Find a SqmPathSource by name relative to this source.
SqmPathSource<?>	findSubPathSource(String name, JpaMetamodelImplementor metamodel)	Find a SqmPathSource by name relative to this source.
Class<J>	getBindableJavaType()	Return the Java type of the represented object.
Bindable.BindableType	getBindableType()	Return the bindable type of the represented object.
JavaType<J>	getExpressibleJavaType()	The Java type descriptor for this expressible
SimpleDomainType<?>	getKeyGraphType()
String	getPathName()	The name of this thing.
SqmPathSource<J>	getPathSource()
JavaType<?>	getRelationalJavaType()
SimpleDomainType<J>	getSqmPathType()	The type of path this source creates.
SimpleDomainType<J>	getType()	Return the type that represents the type of the attribute.
SimpleDomainType<J>	getValueGraphType()	For a singular attribute, the value type is defined as the attribute type
boolean	isAssociation()	Is the attribute an association.
boolean	isCollection()	Is the attribute collection-valued (represents a Collection, Set, List, or Map).
boolean	isGeneric()	Indicates if this path source is generically typed
boolean	isId()	Is the attribute an id attribute.
boolean	isOptional()	Can the attribute be null.
boolean	isVersion()	Is the attribute a version attribute.

Methods inherited from class org.hibernate.metamodel.model.domain.internal.AbstractAttribute

getAttributeClassification, getAttributeJavaType, getDeclaringType, getJavaMember, getJavaType, getName, getPersistentAttributeType, toString, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface jakarta.persistence.metamodel.Attribute

getJavaMember, getName, getPersistentAttributeType

Methods inherited from interface org.hibernate.metamodel.model.domain.PersistentAttribute

getAttributeClassification, getAttributeJavaType

Methods inherited from interface org.hibernate.metamodel.model.domain.SingularPersistentAttribute

getDeclaringType, getJavaType

Methods inherited from interface org.hibernate.query.sqm.SqmExpressible

getTypeName, isInstance, resolveExpressible

Methods inherited from interface org.hibernate.query.sqm.tree.SqmExpressibleAccessor

getNodeJavaType

Methods inherited from interface org.hibernate.query.sqm.SqmJoinable

getName

Methods inherited from interface org.hibernate.query.sqm.SqmPathSource

getExpressible, getIntermediatePathSource, getSqmType, getSubPathSource, getSubPathSource

Constructor Details

SingularAttributeImpl

public SingularAttributeImpl(ManagedDomainType<D> declaringType,
 String name,
 AttributeClassification attributeClassification,
 DomainType<J> attributeType,
 JavaType<?> relationalJavaType,
 Member member,
 boolean isIdentifier,
 boolean isVersion,
 boolean isOptional,
 boolean isGeneric,
 MetadataContext metadataContext)

Method Details

getPathName

public String getPathName()

Description copied from interface: SqmPathSource

The name of this thing.

Specified by:

getPathName in interface SqmPathSource<D>

getExpressibleJavaType

public JavaType<J> getExpressibleJavaType()

Description copied from interface: SqmExpressible

The Java type descriptor for this expressible

Specified by:

getExpressibleJavaType in interface SqmExpressible<D>

getSqmPathType

public SimpleDomainType<J> getSqmPathType()

Description copied from interface: SqmPathSource

The type of path this source creates.

Specified by:

getSqmPathType in interface SingularPersistentAttribute<D,J>

Specified by:

getSqmPathType in interface SqmPathSource<D>

Overrides:

getSqmPathType in class AbstractAttribute<D,J,J>

getValueGraphType

public SimpleDomainType<J> getValueGraphType()

Description copied from interface: SingularPersistentAttribute

For a singular attribute, the value type is defined as the attribute type

Specified by:

getValueGraphType in interface PersistentAttribute<D,J>

Specified by:

getValueGraphType in interface SingularPersistentAttribute<D,J>

Overrides:

getValueGraphType in class AbstractAttribute<D,J,J>

getKeyGraphType

public SimpleDomainType<?> getKeyGraphType()

Specified by:

getKeyGraphType in interface PersistentAttribute<D,J>

getType

public SimpleDomainType<J> getType()

Description copied from interface: SingularAttribute

Return the type that represents the type of the attribute.

Specified by:

getType in interface SingularAttribute<D,J>

Specified by:

getType in interface SingularPersistentAttribute<D,J>

Returns:

type of attribute

getBindableJavaType

public Class<J> getBindableJavaType()

Description copied from interface: Bindable

Return the Java type of the represented object. If the bindable type of the object is PLURAL_ATTRIBUTE, the Java element type is returned. If the bindable type is SINGULAR_ATTRIBUTE or ENTITY_TYPE, the Java type of the represented entity or attribute is returned.

Specified by:

getBindableJavaType in interface Bindable<D>

Specified by:

getBindableJavaType in interface BindableType<D>

Returns:

Java type

findSubPathSource

public SqmPathSource<?> findSubPathSource(String name)

Description copied from interface: SqmPathSource

Find a SqmPathSource by name relative to this source.

Specified by:

findSubPathSource in interface SqmPathSource<D>

Returns:

null if the subPathSource is not found

findSubPathSource

public SqmPathSource<?> findSubPathSource(String name,
 JpaMetamodelImplementor metamodel)

Description copied from interface: SqmPathSource

Find a SqmPathSource by name relative to this source.

Specified by:

findSubPathSource in interface SqmPathSource<D>

Returns:

null if the subPathSource is not found

getPathSource

public SqmPathSource<J> getPathSource()

Specified by:

getPathSource in interface SingularPersistentAttribute<D,J>

isGeneric

public boolean isGeneric()

Description copied from interface: SqmPathSource

Indicates if this path source is generically typed

Specified by:

isGeneric in interface SqmPathSource<D>

createSqmJoin

public SqmAttributeJoin<D,J> createSqmJoin(SqmFrom<?,D> lhs,
 SqmJoinType joinType,
 String alias,
 boolean fetched,
 SqmCreationState creationState)

Specified by:

createSqmJoin in interface SqmJoinable<D,J>

createNavigablePath

public NavigablePath createNavigablePath(SqmPath<?> parent,
 String alias)

Specified by:

createNavigablePath in interface SqmJoinable<D,J>

isId

public boolean isId()

Description copied from interface: SingularAttribute

Is the attribute an id attribute. This method will return true if the attribute is an attribute that corresponds to a simple id, an embedded id, or an attribute of an id class.

Specified by:

isId in interface SingularAttribute<D,J>

Returns:

boolean indicating whether the attribute is an id

isVersion

public boolean isVersion()

Description copied from interface: SingularAttribute

Is the attribute a version attribute.

Specified by:

isVersion in interface SingularAttribute<D,J>

Returns:

boolean indicating whether the attribute is a version attribute

isOptional

public boolean isOptional()

Description copied from interface: SingularAttribute

Can the attribute be null.

Specified by:

isOptional in interface SingularAttribute<D,J>

Returns:

boolean indicating whether the attribute can be null

isAssociation

public boolean isAssociation()

Description copied from interface: Attribute

Is the attribute an association.

Specified by:

isAssociation in interface Attribute<D,J>

Returns:

boolean indicating whether the attribute corresponds to an association

isCollection

public boolean isCollection()

Description copied from interface: Attribute

Is the attribute collection-valued (represents a Collection, Set, List, or Map).

Specified by:

isCollection in interface Attribute<D,J>

Returns:

boolean indicating whether the attribute is collection-valued

getBindableType

public Bindable.BindableType getBindableType()

Description copied from interface: Bindable

Return the bindable type of the represented object.

Specified by:

getBindableType in interface Bindable<D>

Returns:

bindable type

createSqmPath

public SqmPath<J> createSqmPath(SqmPath<?> lhs,
 SqmPathSource<?> intermediatePathSource)

Description copied from interface: SqmPathSource

Create an SQM path for this source relative to the given left hand side

Specified by:

createSqmPath in interface SqmPathSource<D>

getRelationalJavaType

public JavaType<?> getRelationalJavaType()

Specified by:

getRelationalJavaType in interface SqmExpressible<D>