org.grouplens.lenskit.scored

Class AbstractScoredId

java.lang.Object

org.grouplens.lenskit.scored.AbstractScoredId

All Implemented Interfaces:

ScoredId

public abstract class AbstractScoredId
extends Object
implements ScoredId

A base class for ScoredId implementations providing equals and hashCode methods.

Since:

1.1

Compatibility

Public

Constructor Summary

Constructors

Constructor and Description
AbstractScoredId()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Set<TypedSymbol<?>>	getChannelSymbols() Determine the typed symbols associated with all side channels of a ScoredId.
Collection<DoubleSymbolValue>	getUnboxedChannels() Get the unboxed channels associated with a scored ID.
Set<Symbol>	getUnboxedChannelSymbols() Determine the symbols associated with all unboxed double side channels of a ScoredId.
boolean	hasChannel(TypedSymbol<?> sym) Determine if a ScoredId has a specific typed channel.
int	hashCode()
boolean	hasUnboxedChannel(Symbol sym) Determine if a ScoredId has a specific channel.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.grouplens.lenskit.scored.ScoredId

getChannels, getChannelValue, getId, getScore, getUnboxedChannelValue

Constructor Detail

AbstractScoredId

public AbstractScoredId()

Method Detail

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

getUnboxedChannels

@Nonnull
public Collection<DoubleSymbolValue> getUnboxedChannels()

Description copied from interface: ScoredId

Get the unboxed channels associated with a scored ID.

Specified by:

getUnboxedChannels in interface ScoredId

Returns:

The unboxed channels associated with this ID and their values.

getChannelSymbols

public Set<TypedSymbol<?>> getChannelSymbols()

Description copied from interface: ScoredId

Determine the typed symbols associated with all side channels of a ScoredId.

Specified by:

getChannelSymbols in interface ScoredId

Returns:

A set of TypedSymbol objects, each of which maps to a value in one of the ScoredId's side channels.

getUnboxedChannelSymbols

public Set<Symbol> getUnboxedChannelSymbols()

Description copied from interface: ScoredId

Determine the symbols associated with all unboxed double side channels of a ScoredId.

Specified by:

getUnboxedChannelSymbols in interface ScoredId

Returns:

A set of Symbol objects, each of which maps to a value in one of the ScoredId's unboxed double side channels.

hasChannel

public boolean hasChannel(TypedSymbol<?> sym)

Determine if a ScoredId has a specific typed channel. This implementation scans the result of ScoredId.getChannels() for a matching channel.

Specified by:

hasChannel in interface ScoredId

Parameters:

sym - The typed side channel's symbol.

Returns:

true if the ScoredId has a channel associated with this symbol, false otherwise.

hasUnboxedChannel

public boolean hasUnboxedChannel(Symbol sym)

Determine if a ScoredId has a specific channel. This implementation delgates to hasChannel(TypedSymbol).

Specified by:

hasUnboxedChannel in interface ScoredId

Parameters:

sym -

Returns: