org.apache.solr.analytics.facet

Class PivotNode<T>

java.lang.Object

org.apache.solr.analytics.facet.AnalyticsFacet

org.apache.solr.analytics.facet.SortableFacet

org.apache.solr.analytics.facet.PivotNode<T>

All Implemented Interfaces:

Consumer<String>

Direct Known Subclasses:

PivotNode.PivotBranch, PivotNode.PivotLeaf

public abstract class PivotNode<T>
extends SortableFacet
implements Consumer<String>

Representation of one layer of a Pivot Facet. A PivotFacet node is individually sortable, and is collected during the streaming phase of the AnalyticsDriver.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PivotNode.PivotBranch<T> A pivot node that has pivot children.
static class	PivotNode.PivotLeaf A pivot node that has no pivot children.

Nested classes/interfaces inherited from class org.apache.solr.analytics.facet.SortableFacet

SortableFacet.FacetBucket, SortableFacet.FacetSortSpecification

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,T>	currentPivot

Fields inherited from class org.apache.solr.analytics.facet.SortableFacet

sort

Fields inherited from class org.apache.solr.analytics.facet.AnalyticsFacet

collectionManager, expressionCalculator, name, reductionData

Constructor Summary

Constructors

Constructor and Description
PivotNode(String name, StringValueStream expression)

Method Summary

Modifier and Type	Method and Description
void	addFacetValueCollectionTargets(Map<String,T> pivot) Determine which facet values match the current document.
void	exportPivot(DataOutput output, Map<String,T> pivot) Export the shard data through a bit-stream for the given pivot, to be imported by the importPivot(java.io.DataInput, java.util.Map<java.lang.String, T>) method in the originating shard.
protected abstract void	exportPivotValue(DataOutput output, T pivotData) Export the given pivot data, containing ReductionData and pivot children if they exist.
abstract Iterable<Map<String,Object>>	getPivotedResponse(Map<String,T> pivot) Create the response of the facet to be returned in the overall analytics response.
void	importPivot(DataInput input, Map<String,T> pivot) Import the shard data from a bit-stream for the given pivot, exported by the exportPivot(java.io.DataOutput, java.util.Map<java.lang.String, T>) method in the each of the collection's shards.
protected abstract void	importPivotValue(DataInput input, String pivotValue) Import the next pivot value's set of ReductionData and children's ReductionData if they exist.

Methods inherited from class org.apache.solr.analytics.facet.SortableFacet

applyOptions, createOldResponse, createResponse, getSort, setSort

Methods inherited from class org.apache.solr.analytics.facet.AnalyticsFacet

exportFacetValue, exportShardData, getName, importFacetValue, importShardData, setExpressionCalculator, setReductionCollectionManager

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.Consumer

accept, andThen

Field Detail

currentPivot

protected Map<String,T> currentPivot

Constructor Detail

PivotNode

public PivotNode(String name,
                 StringValueStream expression)

Method Detail

addFacetValueCollectionTargets

public void addFacetValueCollectionTargets(Map<String,T> pivot)

Determine which facet values match the current document. Add the ReductionCollectionManager.ReductionDataCollections of the relevant facet values to the targets of the streaming ReductionCollectionManager so that they are updated with the current document's data.

importPivot

public void importPivot(DataInput input,
                        Map<String,T> pivot)
                 throws IOException

Import the shard data from a bit-stream for the given pivot, exported by the exportPivot(java.io.DataOutput, java.util.Map<java.lang.String, T>) method in the each of the collection's shards.

Parameters:

input - The bit-stream to import the data from

pivot - the values for this pivot node and the pivot children (if they exist)

Throws:

IOException - if an exception occurs while reading from the DataInput

importPivotValue

protected abstract void importPivotValue(DataInput input,
                                         String pivotValue)
                                  throws IOException

Import the next pivot value's set of ReductionData and children's ReductionData if they exist.

Parameters:

input - the bit-stream to import the reduction data from

pivotValue - the next pivot value

Throws:

IOException - if an exception occurs while reading from the input

exportPivot

public void exportPivot(DataOutput output,
                        Map<String,T> pivot)
                 throws IOException

Export the shard data through a bit-stream for the given pivot, to be imported by the importPivot(java.io.DataInput, java.util.Map<java.lang.String, T>) method in the originating shard.

Parameters:

output - The bit-stream to output the data through

pivot - the values for this pivot node and the pivot children (if they exist)

Throws:

IOException - if an exception occurs while writing to the DataOutput

exportPivotValue

protected abstract void exportPivotValue(DataOutput output,
                                         T pivotData)
                                  throws IOException

Export the given pivot data, containing ReductionData and pivot children if they exist.

Parameters:

output - the bit-stream to output the reduction data to

pivotData - the next pivot value data

Throws:

IOException - if an exception occurs while reading from the input

getPivotedResponse

public abstract Iterable<Map<String,Object>> getPivotedResponse(Map<String,T> pivot)

Create the response of the facet to be returned in the overall analytics response.

Parameters:

pivot - the pivot to create a response for

Returns:

the response of the facet