org.hibernate.search.mapper.pojo.model

Interface PojoModelCompositeElement

All Superinterfaces:

PojoModelElement

All Known Subinterfaces:

PojoModelProperty, PojoModelType

@Incubating
public interface PojoModelCompositeElement
extends PojoModelElement

A potentially composite element in the POJO model.

Offers ways to create accessors allowing to retrieve data from objects passed to bridges.

See Also:

PojoModelType, PojoModelProperty

Method Summary

Modifier and Type	Method and Description
PojoElementAccessor<?>	createAccessor()
<T> PojoElementAccessor<T>	createAccessor(Class<T> type)
Stream<? extends PojoModelProperty>	properties()
PojoModelProperty	property(String name)

Methods inherited from interface org.hibernate.search.mapper.pojo.model.PojoModelElement

isAssignableTo

Method Detail

createAccessor

<T> PojoElementAccessor<T> createAccessor(Class<T> type)

Type Parameters:

T - The expected type of values returned by the accessor.

Parameters:

type - The expected type of values returned by the accessor.

Returns:

An accessor able to retrieve this element from an object, provided it has the right type.

Throws:

org.hibernate.search.util.common.SearchException - If this element is not assignable to the given type.

createAccessor

PojoElementAccessor<?> createAccessor()

Returns:

An accessor able to retrieve this element from an object, provided it has the right type.

property

PojoModelProperty property(String name)

Parameters:

name - The name of a property.

Returns:

A element representing the given property on the current element.

properties

Stream<? extends PojoModelProperty> properties()

Returns:

A Stream of all properties of the current element.