org.grouplens.lenskit.eval.metrics.topn

Class TopNMetricBuilder<T extends TopNMetricBuilder,K extends Metric>

java.lang.Object

org.grouplens.lenskit.eval.metrics.topn.TopNMetricBuilder<T,K>

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<K>

Direct Known Subclasses:

IndependentRecallTopNMetric.Builder, MRRTopNMetric.Builder, NDCGTopNMetric.Builder, PrecisionRecallTopNMetric.Builder, TopNEntropyMetric.Builder, TopNLengthMetric.Builder, TopNPopularityMetric.Builder

public abstract class TopNMetricBuilder<T extends TopNMetricBuilder,K extends Metric>
extends java.lang.Object
implements org.apache.commons.lang3.builder.Builder<K>

Field Summary

Fields

Modifier and Type	Field and Description
protected ItemSelector	candidates
protected ItemSelector	exclude
protected int	listSize
protected java.lang.String	prefix
protected java.lang.String	suffix

Constructor Summary

Constructors

Constructor and Description
TopNMetricBuilder()

Method Summary

Modifier and Type	Method and Description
abstract K	build()
ItemSelector	getCandidates() Get the candidate item selector.
ItemSelector	getExclude() Get the exclude item selector.
int	getListSize() Get the list size.
java.lang.String	getPrefix() Get the prefix (or null if no prefix is set) to be applied to each column label.
java.lang.String	getSuffix() Get the suffix (or null if no suffix is set) to be applied to each column label.
T	setCandidates(ItemSelector sel) Set the candidate selector.
T	setExclude(ItemSelector sel) Set the exclude item selector.
T	setListSize(int n) Set the recommendation list size.
T	setPrefix(java.lang.String prefix) Set the prefix to be applied to each column label.
T	setSuffix(java.lang.String suffix) Set the suffix to be applied to each column label.

Methods inherited from class java.lang.Object

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

Field Detail

listSize

protected int listSize

candidates

protected ItemSelector candidates

exclude

protected ItemSelector exclude

prefix

protected java.lang.String prefix

suffix

protected java.lang.String suffix

Constructor Detail

TopNMetricBuilder

public TopNMetricBuilder()

Method Detail

getListSize

public int getListSize()

Get the list size.

Returns:

The number of items to return in a recommendation list.

getCandidates

public ItemSelector getCandidates()

Get the candidate item selector.

Returns:

The candidate item selector.

getExclude

public ItemSelector getExclude()

Get the exclude item selector.

Returns:

The exclude item selector.

getPrefix

public java.lang.String getPrefix()

Get the prefix (or null if no prefix is set) to be applied to each column label. If not null, this prefix will be added to the beginning of each column label, separated by a '.' This property might not be supported by the built metric.

Returns:

the prefix

getSuffix

public java.lang.String getSuffix()

Get the suffix (or null if no suffix is set) to be applied to each column label. If not null, this suffix will be added to the end of each column label, separated by a '.' This property might not be supported by the built metric.

Returns:

setListSize

public T setListSize(int n)

Set the recommendation list size. The default size is 10.

Parameters:

n - The recommendation list size.

Returns:

The builder (for chaining).

setCandidates

public T setCandidates(ItemSelector sel)

Set the candidate selector. The default is ItemSelectors.testItems().

Parameters:

sel - The candidate item selector.

Returns:

The builder (for chaining).

setExclude

public T setExclude(ItemSelector sel)

Set the exclude item selector. The default is ItemSelectors.trainingItems().

Parameters:

sel - The exclude item selector.

Returns:

The builder (for chaining).

setPrefix

public T setPrefix(java.lang.String prefix)

Set the prefix to be applied to each column label. If not null, the prefix will be added to the beginning of each column label, separated by a '.'

Parameters:

prefix - the prefix to apply or null to set no prefix.

Returns:

the builder (for chaining)

setSuffix

public T setSuffix(java.lang.String suffix)

Set the suffix to be applied to each column label. If not null, the suffix will be added to the end of each column label, separated by a '.'

Parameters:

suffix - the suffix to apply or null to set no suffix.

Returns:

the builder (for chaining)

build

public abstract K build()

Specified by:

build in interface org.apache.commons.lang3.builder.Builder<K extends Metric>