org.hibernate.loader.plan.build.internal.spaces

Class CompositePropertyMapping

java.lang.Object

org.hibernate.loader.plan.build.internal.spaces.CompositePropertyMapping

All Implemented Interfaces:

PropertyMapping

public class CompositePropertyMapping
extends Object
implements PropertyMapping

A PropertyMapping for handling composites! Woohoo!

TODO : Consider moving this into the attribute/association walking SPI (org.hibernate.persister.walking) and having the notion of PropertyMapping built and exposed there

There is duplication here too wrt ComponentJoin.ComponentPropertyMapping. like above, consider moving to a singly-defined CompositePropertyMapping in the attribute/association walking SPI

Author:

Steve Ebersole

Constructor Summary

Constructors

Constructor and Description
CompositePropertyMapping(CompositeType compositeType, PropertyMapping parentPropertyMapping, String parentPropertyName) Builds a CompositePropertyMapping

Method Summary

Modifier and Type	Method and Description
protected void	checkIncomingPropertyName(String propertyName) Used to check the validity of the propertyName argument passed into toType(String), toColumns(String, String) and toColumns(String).
CompositeType	getType() Get the type of the thing containing the properties
protected String	resolveParentPropertyPath(String propertyName) Builds the relative path.
String[]	toColumns(String propertyName) Given a property path, return the corresponding column name(s).
String[]	toColumns(String alias, String propertyName) Obtain aliased column/formula fragments for the specified property path.
protected String	toParentPropertyPath(String propertyName) Used to build a property path relative to parentPropertyMapping.
Type	toType(String propertyName) Given a component path expression, get the type of the property

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositePropertyMapping

public CompositePropertyMapping(CompositeType compositeType,
                                PropertyMapping parentPropertyMapping,
                                String parentPropertyName)

Builds a CompositePropertyMapping

Parameters:

compositeType - The composite being described by this PropertyMapping

parentPropertyMapping - The PropertyMapping of our parent (composites have to have a parent/owner)

parentPropertyName - The name of this composite within the parentPropertyMapping

Method Detail

toType

public Type toType(String propertyName)
            throws QueryException

Description copied from interface: PropertyMapping

Given a component path expression, get the type of the property

Specified by:

toType in interface PropertyMapping

Throws:

QueryException

toParentPropertyPath

protected String toParentPropertyPath(String propertyName)

Used to build a property path relative to parentPropertyMapping. First, the incoming propertyName argument is validated (using checkIncomingPropertyName(java.lang.String)). Then the relative path is built (using resolveParentPropertyPath(java.lang.String)).

Parameters:

propertyName - The incoming propertyName.

Returns:

The relative path.

checkIncomingPropertyName

protected void checkIncomingPropertyName(String propertyName)

Used to check the validity of the propertyName argument passed into toType(String), toColumns(String, String) and toColumns(String).

Parameters:

propertyName - The incoming propertyName argument to validate

resolveParentPropertyPath

protected String resolveParentPropertyPath(String propertyName)

Builds the relative path. Used to delegate toType(String), toColumns(String, String) and toColumns(String) calls out to parentPropertyMapping.

Called from toParentPropertyPath(java.lang.String).

Override this to adjust how the relative property path is built for this mapping.

Parameters:

propertyName - The incoming property name to "path append".

Returns:

The relative path

toColumns

public String[] toColumns(String alias,
                          String propertyName)
                   throws QueryException

Description copied from interface: PropertyMapping

Obtain aliased column/formula fragments for the specified property path.

Specified by:

toColumns in interface PropertyMapping

Throws:

QueryException

toColumns

public String[] toColumns(String propertyName)
                   throws QueryException,
                          UnsupportedOperationException

Description copied from interface: PropertyMapping

Given a property path, return the corresponding column name(s).

Specified by:

toColumns in interface PropertyMapping

Throws:

QueryException

UnsupportedOperationException

getType

public CompositeType getType()

Description copied from interface: PropertyMapping

Get the type of the thing containing the properties

Specified by:

getType in interface PropertyMapping