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

Class DistanceProjectionDefinition<F>

java.lang.Object

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

org.hibernate.search.engine.search.projection.definition.spi.DistanceProjectionDefinition<F>

All Implemented Interfaces:

ProjectionDefinition<F>, ToStringTreeAppendable

Direct Known Subclasses:

DistanceProjectionDefinition.MultiValued, DistanceProjectionDefinition.SingleValued

@Incubating
public abstract class DistanceProjectionDefinition<F>
extends AbstractProjectionDefinition<F>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DistanceProjectionDefinition.MultiValued
static final class	DistanceProjectionDefinition.SingleValued

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	fieldPath
protected final String	parameterName
protected final DistanceUnit	unit

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 Details

fieldPath

protected final String fieldPath

parameterName

protected final String parameterName

unit

protected final DistanceUnit unit

Method Details

type

protected String type()

Specified by:

type in class AbstractProjectionDefinition<F>

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<F>

Parameters:

appender - A ToStringTreeAppender.

multi

protected abstract boolean multi()