org.elasticsearch.search.facet

Class InternalFacet

java.lang.Object

org.elasticsearch.search.facet.InternalFacet

All Implemented Interfaces:

Streamable, ToXContent, Facet

Direct Known Subclasses:

InternalDateHistogramFacet, InternalFilterFacet, InternalGeoDistanceFacet, InternalHistogramFacet, InternalQueryFacet, InternalRangeFacet, InternalStatisticalFacet, InternalTermsFacet, InternalTermsStatsFacet

public abstract class InternalFacet
extends Object
implements Facet, Streamable, ToXContent

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InternalFacet.ReduceContext
static interface	InternalFacet.Stream
static class	InternalFacet.Streams

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	InternalFacet() Here just for streams...
protected	InternalFacet(String facetName)

Method Summary

Modifier and Type	Method and Description
String	getName() The "logical" name of the search facet.
void	readFrom(StreamInput in)
abstract Facet	reduce(InternalFacet.ReduceContext context)
abstract BytesReference	streamType()
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.search.facet.Facet

getType

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Constructor Detail

InternalFacet

protected InternalFacet()

Here just for streams...

InternalFacet

protected InternalFacet(String facetName)

Method Detail

streamType

public abstract BytesReference streamType()

reduce

public abstract Facet reduce(InternalFacet.ReduceContext context)

getName

public final String getName()

Description copied from interface: Facet

The "logical" name of the search facet.

Specified by:

getName in interface Facet

readFrom

public void readFrom(StreamInput in)
              throws IOException

Specified by:

readFrom in interface Streamable

Throws:

IOException

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Streamable

Throws:

IOException