org.elasticsearch.search.facet.query
Class InternalQueryFacet

java.lang.Object
  org.elasticsearch.search.facet.query.InternalQueryFacet

All Implemented Interfaces:

Streamable, ToXContent, Facet, InternalFacet, QueryFacet

public class InternalQueryFacet
extends java.lang.Object
implements QueryFacet, InternalFacet

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.search.facet.Facet

Facet.Type

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

ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

InternalQueryFacet(java.lang.String name, long count)

Method Summary

Facet	aggregate(java.lang.Iterable<Facet> facets) Aggregate the data of the provided facets and returns the aggregated value.
long	count() The count of the facet.
long	getCount() The count of the facet.
java.lang.String	getName() The "logical" name of the search facet.
Facet.Type	getType() The type of the facet.
java.lang.String	name() The "logical" name of the facet.
static QueryFacet	readCountFacet(StreamInput in)
void	readFrom(StreamInput in)
void	toXContent(XContentBuilder builder, ToXContent.Params params)
Facet.Type	type() The type of the facet.
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Constructor Detail

InternalQueryFacet

public InternalQueryFacet(java.lang.String name,
                          long count)

Method Detail

type

public Facet.Type type()

Description copied from interface: Facet

The type of the facet.

Specified by:

type in interface Facet

getType

public Facet.Type getType()

Description copied from interface: Facet

The type of the facet.

Specified by:

getType in interface Facet

name

public java.lang.String name()

The "logical" name of the facet.

Specified by:

name in interface Facet

getName

public java.lang.String getName()

Description copied from interface: Facet

The "logical" name of the search facet.

Specified by:

getName in interface Facet

count

public long count()

The count of the facet.

Specified by:

count in interface QueryFacet

getCount

public long getCount()

The count of the facet.

Specified by:

getCount in interface QueryFacet

aggregate

public Facet aggregate(java.lang.Iterable<Facet> facets)

Description copied from interface: InternalFacet

Aggregate the data of the provided facets and returns the aggregated value. Note, this method might should handle cases of facets provided with different names, and should excllude them.

Specified by:

aggregate in interface InternalFacet

toXContent

public void toXContent(XContentBuilder builder,
                       ToXContent.Params params)
                throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

readCountFacet

public static QueryFacet readCountFacet(StreamInput in)
                                 throws java.io.IOException

Throws:

java.io.IOException

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Specified by:

readFrom in interface Streamable

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Specified by:

writeTo in interface Streamable

Throws:

java.io.IOException