Package org.hibernate.search.engine.search.projection.definition.spi

Class FieldProjectionDefinition<P,F>

java.lang.Object

org.hibernate.search.engine.search.projection.definition.spi.AbstractProjectionDefinition<P>

org.hibernate.search.engine.search.projection.definition.spi.FieldProjectionDefinition<P,F>

All Implemented Interfaces:

ProjectionDefinition<P>, ToStringTreeAppendable

Direct Known Subclasses:

FieldProjectionDefinition.MultiValued, FieldProjectionDefinition.SingleValued

@Incubating
public abstract class FieldProjectionDefinition<P,F>
extends AbstractProjectionDefinition<P>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FieldProjectionDefinition.MultiValued<F>
static class	FieldProjectionDefinition.SingleValued<F>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	fieldPath
protected Class<F>	fieldType
protected ValueConvert	valueConvert

Method Summary

Modifier and Type	Method	Description
void	appendTo(ToStringTreeAppender appender)	Appends information about this to the given appender.
protected abstract boolean	multi()
protected String	type()

Methods inherited from class org.hibernate.search.engine.search.projection.definition.spi.AbstractProjectionDefinition

toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hibernate.search.engine.search.projection.definition.ProjectionDefinition

create

Methods inherited from interface org.hibernate.search.util.common.spi.ToStringTreeAppendable

toStringTree

Field Detail

fieldPath

protected final String fieldPath

fieldType

protected final Class<F> fieldType

valueConvert

protected final ValueConvert valueConvert

Method Detail

type

protected String type()

Specified by:

type in class AbstractProjectionDefinition<P>

appendTo

public void appendTo(ToStringTreeAppender appender)

Description copied from interface: ToStringTreeAppendable

Appends information about this to the given appender.

WARNING: This generally shouldn't be called directly, as ToStringTreeAppender will automatically call this method for ToStringTreeAppendable values passed to ToStringTreeAppender.attribute(String, Object)/ToStringTreeAppender.value(Object).

Implementations should assume that calls to ToStringTreeAppender.startObject()/ToStringTreeAppender.endObject() for this are handled by the caller.

Specified by:

appendTo in interface ToStringTreeAppendable

Overrides:

appendTo in class AbstractProjectionDefinition<P>

Parameters:

appender - A ToStringTreeAppender.

multi

protected abstract boolean multi()