Package org.apache.solr.search.facet

Class RelatednessAgg

java.lang.Object

org.apache.lucene.queries.function.ValueSource

org.apache.solr.search.facet.AggValueSource

org.apache.solr.search.facet.RelatednessAgg

public class RelatednessAgg
extends AggValueSource

An aggregation function designed to be nested under other (possibly deeply nested) facets for the purposes of computing the "relatedness" of facet buckets relative to "foreground" and "background" sets -- primarily for the purpose of building "Semantic Knowledge Graphs"

See Also:

• The Semantic Knowledge Graph: A compact, auto-generated model for real-time traversal and ranking of any relationship within a domain

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.apache.lucene.search.Query	bgQ
protected final org.apache.lucene.search.Query	fgQ
protected double	min_pop
static final String	NAME
static final String	SWEEP_COLLECTION

Fields inherited from class org.apache.solr.search.facet.AggValueSource

name

Constructor Summary

Constructors

Constructor	Description
RelatednessAgg(org.apache.lucene.search.Query fgQ, org.apache.lucene.search.Query bgQ)

Method Summary

Modifier and Type	Method	Description
static double	computeRelatedness(long fg_count, long fg_size, long bg_count, long bg_size)	This is an aproximated Z-Score, as described in the "Scoring Semantic Relationships" section of "The Semantic Knowledge Graph: A compact, auto-generated model for real-time traversal and ranking of any relationship within a domain"
FacetMerger	createFacetMerger(Object prototype)
SlotAcc	createSlotAcc(FacetContext fcontext, long numDocs, int numSlots)
String	description()
boolean	equals(Object o)
org.apache.lucene.queries.function.FunctionValues	getValues(Map<Object,Object> context, org.apache.lucene.index.LeafReaderContext readerContext)
int	hashCode()
static double	roundTo5Digits(double val)	Helper function for rounding/truncating relatedness & popularity values to 5 decimal digits, since these values are all probabilistic more then 5 digits aren't really relevant and may give a missleading impression of added precision.
void	setOpts(QParser parser)

Methods inherited from class org.apache.solr.search.facet.AggValueSource

getChildren, name

Methods inherited from class org.apache.lucene.queries.function.ValueSource

asDoubleValuesSource, asLongValuesSource, createWeight, fromDoubleValuesSource, getSortField, newContext, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SWEEP_COLLECTION

public static final String SWEEP_COLLECTION

See Also:

• Constant Field Values

fgQ

protected final org.apache.lucene.search.Query fgQ

bgQ

protected final org.apache.lucene.search.Query bgQ

min_pop

protected double min_pop

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

RelatednessAgg

public RelatednessAgg(org.apache.lucene.search.Query fgQ,
 org.apache.lucene.search.Query bgQ)

Method Details

setOpts

public void setOpts(QParser parser)

description

public String description()

Specified by:

description in class org.apache.lucene.queries.function.ValueSource

equals

public boolean equals(Object o)

Overrides:

equals in class AggValueSource

hashCode

public int hashCode()

Specified by:

hashCode in class org.apache.lucene.queries.function.ValueSource

getValues

public org.apache.lucene.queries.function.FunctionValues getValues(Map<Object,Object> context,
 org.apache.lucene.index.LeafReaderContext readerContext)
                                                            throws IOException

Overrides:

getValues in class AggValueSource

Throws:

IOException

createSlotAcc

public SlotAcc createSlotAcc(FacetContext fcontext,
 long numDocs,
 int numSlots)
                      throws IOException

Overrides:

createSlotAcc in class AggValueSource

Throws:

IOException

createFacetMerger

public FacetMerger createFacetMerger(Object prototype)

Specified by:

createFacetMerger in class AggValueSource

computeRelatedness

public static double computeRelatedness(long fg_count,
 long fg_size,
 long bg_count,
 long bg_size)

This is an aproximated Z-Score, as described in the "Scoring Semantic Relationships" section of "The Semantic Knowledge Graph: A compact, auto-generated model for real-time traversal and ranking of any relationship within a domain"

See Also:

• java-user@lucene Message-ID: 449AEB60.4070300@alias-i.com
• Phrase Extraction: Binomial Hypothesis Testing vs. Coding Loss

roundTo5Digits

public static double roundTo5Digits(double val)

Helper function for rounding/truncating relatedness & popularity values to 5 decimal digits, since these values are all probabilistic more then 5 digits aren't really relevant and may give a missleading impression of added precision.