org.elasticsearch.search.facet.range
Class InternalRangeFacet

java.lang.Object
  org.elasticsearch.search.facet.range.InternalRangeFacet

All Implemented Interfaces:

java.lang.Iterable<RangeFacet.Entry>, Streamable, ToXContent, Facet, InternalFacet, RangeFacet

public class InternalRangeFacet
extends java.lang.Object
implements RangeFacet, InternalFacet

Nested Class Summary

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

RangeFacet.Entry

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

InternalRangeFacet(java.lang.String name, java.lang.String keyFieldName, java.lang.String valueFieldName, RangeFacet.Entry[] entries)

Method Summary

Facet	aggregate(java.lang.Iterable<Facet> facets) Aggregate the data of the provided facets and returns the aggregated value.
java.util.List<RangeFacet.Entry>	entries() An ordered list of range facet entries.
java.util.List<RangeFacet.Entry>	getEntries() An ordered list of range facet entries.
java.lang.String	getKeyFieldName() The key field name used with this facet.
java.lang.String	getName() The "logical" name of the search facet.
Facet.Type	getType() The type of the facet.
java.lang.String	getValueFieldName() The value field name used with this facet.
java.util.Iterator<RangeFacet.Entry>	iterator()
java.lang.String	keyFieldName() The key field name used with this facet.
java.lang.String	name() The "logical" name of the search facet.
void	readFrom(StreamInput in)
static InternalRangeFacet	readRangeFacet(StreamInput in)
void	toXContent(XContentBuilder builder, ToXContent.Params params)
Facet.Type	type() The type of the facet.
java.lang.String	valueFieldName() The value field name used with this 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

InternalRangeFacet

public InternalRangeFacet(java.lang.String name,
                          java.lang.String keyFieldName,
                          java.lang.String valueFieldName,
                          RangeFacet.Entry[] entries)

Method Detail

name

public java.lang.String name()

Description copied from interface: Facet

The "logical" name of the search 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

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

keyFieldName

public java.lang.String keyFieldName()

Description copied from interface: RangeFacet

The key field name used with this facet.

Specified by:

keyFieldName in interface RangeFacet

getKeyFieldName

public java.lang.String getKeyFieldName()

Description copied from interface: RangeFacet

The key field name used with this facet.

Specified by:

getKeyFieldName in interface RangeFacet

valueFieldName

public java.lang.String valueFieldName()

Description copied from interface: RangeFacet

The value field name used with this facet.

Specified by:

valueFieldName in interface RangeFacet

getValueFieldName

public java.lang.String getValueFieldName()

Description copied from interface: RangeFacet

The value field name used with this facet.

Specified by:

getValueFieldName in interface RangeFacet

entries

public java.util.List<RangeFacet.Entry> entries()

Description copied from interface: RangeFacet

An ordered list of range facet entries.

Specified by:

entries in interface RangeFacet

getEntries

public java.util.List<RangeFacet.Entry> getEntries()

Description copied from interface: RangeFacet

An ordered list of range facet entries.

Specified by:

getEntries in interface RangeFacet

iterator

public java.util.Iterator<RangeFacet.Entry> iterator()

Specified by:

iterator in interface java.lang.Iterable<RangeFacet.Entry>

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

readRangeFacet

public static InternalRangeFacet readRangeFacet(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

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException