com.yahoo.search.query.ranking

Class RankFeatures

java.lang.Object

com.yahoo.search.query.ranking.RankFeatures

All Implemented Interfaces:

Cloneable

public class RankFeatures
extends Object
implements Cloneable

Contains the rank features of a query.

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private Map<String,Object>	features

Constructor Summary

Constructors

Modifier	Constructor and Description
	RankFeatures()
private	RankFeatures(Map<String,Object> features)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	asMap() Returns the map holding the features of this.
RankFeatures	clone()
int	encode(ByteBuffer buffer)
boolean	equals(Object other)
String	get(String name) Returns a rank feature as a string by full name or null if not set
Object	getObject(String name) Returns this value as whatever type it was stored as.
Optional<com.yahoo.tensor.Tensor>	getTensor(String name) Returns a tensor rank feature, or empty if there is no value with this name.
int	hashCode()
boolean	isEmpty()
void	prepare(RankProperties rankProperties) Prepares this for encoding, not for external use.
void	put(String name, String value) Sets a rank feature by full name to a value
void	put(String name, com.yahoo.tensor.Tensor value) Sets a tensor rank feature
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

features

private final Map<String,Object> features

Constructor Detail

RankFeatures

public RankFeatures()

RankFeatures

private RankFeatures(Map<String,Object> features)

Method Detail

put

public void put(String name,
                String value)

Sets a rank feature by full name to a value

put

public void put(String name,
                com.yahoo.tensor.Tensor value)

Sets a tensor rank feature

get

public String get(String name)

Returns a rank feature as a string by full name or null if not set

getObject

public Object getObject(String name)

Returns this value as whatever type it was stored as. Returns null if the value is not set.

getTensor

public Optional<com.yahoo.tensor.Tensor> getTensor(String name)

Returns a tensor rank feature, or empty if there is no value with this name.

Throws:

IllegalArgumentException - if the value is set but is not a tensor

asMap

public Map<String,Object> asMap()

Returns the map holding the features of this. This map may be modified to change the rank features of the query.

isEmpty

public boolean isEmpty()

prepare

public void prepare(RankProperties rankProperties)

Prepares this for encoding, not for external use. See encode on Query for details.

If the query feature is found in the rank feature set, remove all these entries and insert them into the rank property set instead. We want to hide from the user that the query feature value is sent down as a rank property and picked up by the query feature executor in the backend.

encode

public int encode(ByteBuffer buffer)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RankFeatures clone()

Overrides:

clone in class Object

toString

public String toString()

Overrides:

toString in class Object