com.yahoo.prelude.fastsearch

Class FastHit

java.lang.Object

com.yahoo.component.provider.FreezableClass

com.yahoo.component.provider.ListenableFreezableClass

com.yahoo.search.result.Hit

com.yahoo.prelude.fastsearch.FastHit

All Implemented Interfaces:

com.yahoo.component.provider.Freezable, com.yahoo.component.provider.ListenableFreezable, com.yahoo.processing.response.Data, Cloneable, Comparable<Hit>

public class FastHit
extends Hit

A regular hit from a Vespa backend

Author:

bratseth, Steinar Knutsen

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	FastHit.FieldIterator Iterator over all the field content of a FastHit
private static class	FastHit.FieldNameIterator Iterator over all the field names stored in a FastHit
private static class	FastHit.FieldSet A set view of all the field names in this hit.
private static class	FastHit.SummaryData Summary data (values of a number of fields) received for this hit
private static class	FastHit.SummaryIterator<VALUE> Abstract superclass of iterators over all the field content of a FastHit.

Nested classes/interfaces inherited from class com.yahoo.search.result.Hit

Hit.RawUtf8Consumer

Field Summary

Fields

Modifier and Type	Field and Description
private CacheKey	cacheKey
private int	distributionKey The index of the content node this hit originated at
private static com.yahoo.document.GlobalId	emptyGlobalId
private com.yahoo.document.GlobalId	globalId The global id of this document in the backend node which produced it
private com.yahoo.net.URI	indexUri Full information pointing to the location of further data for this hit.
private int	partId The local identifier of the content store for this hit on the node it originated at
private QueryPacketData	queryPacketData
private Set<String>	removedFields Removed field values, which should therefore not be returned if present in summary data
private List<FastHit.SummaryData>	summaries Summaries added to this hit which are not yet decoded into fields.

Fields inherited from class com.yahoo.search.result.Hit

RANKFEATURES_FIELD, SDDOCNAME_FIELD

Constructor Summary

Constructors

Constructor and Description
FastHit() Creates an empty and temporarily invalid summary hit
FastHit(String uri, double relevancy)
FastHit(String uri, double relevance, String source)

Method Summary

Modifier and Type	Method and Description
void	addSummary(DocsumDefinition docsumDef, com.yahoo.data.access.Inspector value) For internal use
static String	asHexString(com.yahoo.document.GlobalId gid) Deprecated. do not use
private static StringBuilder	asHexString(StringBuilder sb, com.yahoo.document.GlobalId gid)
void	changeFieldKey(String oldKey, String newKey) Deprecated. do not use
void	clearFields() Removes all fields of this
Iterator<Map.Entry<String,Object>>	fieldIterator() Returns a modifiable iterator over the fields of this
Set<String>	fieldKeys() Returns the keys of the fields of this hit as a modifiable view.
private Iterator<String>	fieldNameIterator() Returns a modifiable iterator over the field names of this
Map<String,Object>	fields() Returns the fields of this as a read-only map.
void	forEachField(BiConsumer<String,Object> consumer) Receive a callback on the given object for each field in this hit.
void	forEachFieldAsRaw(Hit.RawUtf8Consumer consumer) Receive a callback on the given object for each field in this hit, where the callback will provide raw utf-8 byte data for strings whose data is already available at this form.
(package private) CacheKey	getCacheKey()
int	getDistributionKey() Returns the index of the node this hit originated at
Object	getField(String name) Returns a field value from this Hit.
com.yahoo.document.GlobalId	getGlobalId() Returns the global id of this document in the backend node which produced it
com.yahoo.net.URI	getId() Returns the explicitly set uri if available, returns "index:[source]/[partid]/[id]" otherwise
int	getPartId()
QueryPacketData	getQueryPacketData() Returns a serial encoding of the query which produced this hit, ot null if not available.
private Object	getSummaryValue(String name)
protected boolean	hasField(String name) Returns whether this field is present in the field map in the parent hit
protected boolean	hasFields() Returns whether any fields are present in the field map in the parent hit
int	hashCode() Returns the hashCode of this hit, which is the hashcode of its uri.
boolean	isMeta() Returns false - this is a concrete hit containing requested content
private Set<String>	mapFieldKeys()
Object	removeField(String name) Removes a field from this
(package private) void	setCacheKey(CacheKey cacheKey)
void	setDistributionKey(int distributionKey) Sets the index of the node this hit originated at
Object	setField(String name, Object value) Sets the value of a field
void	setGlobalId(com.yahoo.document.GlobalId globalId)
void	setPartId(int partId) Sets the part id number, which specifies the node where this hit is found.
void	setQueryPacketData(QueryPacketData queryPacketData) Add the binary data common for the query packet to a Vespa backend and a summary fetch packet to a Vespa backend.
String	toString()

Methods inherited from class com.yahoo.search.result.Hit

assignId, buildHitField, buildHitField, buildHitField, clone, close, compareTo, equals, getAddNumber, getDisplayId, getFieldXML, getFilled, getFilledInternal, getQuery, getRelevance, getSearcherSpecificMetaData, getSource, getSourceNumber, getTypeString, getUnboldedField, isAuxiliary, isCached, isFillable, isFilled, request, reserve, setAddNumber, setAuxiliary, setCached, setFillable, setFilled, setFilledInternal, setId, setId, setMeta, setQuery, setRelevance, setRelevance, setSearcherSpecificMetaData, setSource, setSourceNumber, stripCharacter, types

Methods inherited from class com.yahoo.component.provider.ListenableFreezableClass

addFreezeListener, freeze

Methods inherited from class com.yahoo.component.provider.FreezableClass

ensureNotFrozen, isFrozen

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.yahoo.component.provider.ListenableFreezable

addFreezeListener

Methods inherited from interface com.yahoo.component.provider.Freezable

freeze, isFrozen

Field Detail

emptyGlobalId

private static final com.yahoo.document.GlobalId emptyGlobalId

distributionKey

private int distributionKey

The index of the content node this hit originated at

partId

private int partId

The local identifier of the content store for this hit on the node it originated at

globalId

private com.yahoo.document.GlobalId globalId

The global id of this document in the backend node which produced it

indexUri

private com.yahoo.net.URI indexUri

Full information pointing to the location of further data for this hit. Lazily set

queryPacketData

private transient QueryPacketData queryPacketData

cacheKey

private transient CacheKey cacheKey

summaries

private List<FastHit.SummaryData> summaries

Summaries added to this hit which are not yet decoded into fields. Fields are resolved by returning the first non-null value found by 1) the field value from the Map of fields in the Hit supertype, and 2) each of the summaries, reverse add order This ensures that values set from code overwrites any value received as summary data, and fetching a new summary overrides previous summaries. The reason we keep this rather than eagerly decoding into a the field map is to reduce garbage collection and decoding cost, with the assumption that most fields passes through the container with no processing most of the time.

removedFields

private Set<String> removedFields

Removed field values, which should therefore not be returned if present in summary data

Constructor Detail

FastHit

public FastHit()

Creates an empty and temporarily invalid summary hit

FastHit

public FastHit(String uri,
               double relevancy)

FastHit

public FastHit(String uri,
               double relevance,
               String source)

Method Detail

isMeta

public boolean isMeta()

Returns false - this is a concrete hit containing requested content

Overrides:

isMeta in class Hit

getId

public com.yahoo.net.URI getId()

Returns the explicitly set uri if available, returns "index:[source]/[partid]/[id]" otherwise

Overrides:

getId in class Hit

Returns:

uri of hit

getGlobalId

public com.yahoo.document.GlobalId getGlobalId()

Returns the global id of this document in the backend node which produced it

setGlobalId

public void setGlobalId(com.yahoo.document.GlobalId globalId)

getPartId

public int getPartId()

setPartId

public void setPartId(int partId)

Sets the part id number, which specifies the node where this hit is found. The row count is used to decode the part id into a column and a row number: the number of n least significant bits required to hold the highest row number are the row bits, the rest are column bits. Note: Remove partId when all dispatching happens from the container dispatcher, not fdispatch

getDistributionKey

public int getDistributionKey()

Returns the index of the node this hit originated at

setDistributionKey

public void setDistributionKey(int distributionKey)

Sets the index of the node this hit originated at

setQueryPacketData

public void setQueryPacketData(QueryPacketData queryPacketData)

Add the binary data common for the query packet to a Vespa backend and a summary fetch packet to a Vespa backend. This method can only be called once for a single hit.

Parameters:

queryPacketData - binary data from a query packet resulting in this hit

Throws:

IllegalStateException - if the method is called more than once

NullPointerException - if trying to set query packet data to null

getQueryPacketData

public QueryPacketData getQueryPacketData()

Returns a serial encoding of the query which produced this hit, ot null if not available.

getCacheKey

CacheKey getCacheKey()

setCacheKey

void setCacheKey(CacheKey cacheKey)

addSummary

public void addSummary(DocsumDefinition docsumDef,
                       com.yahoo.data.access.Inspector value)

For internal use

getField

public Object getField(String name)

Returns a field value from this Hit. The value is either a stored value from the Document represented by this Hit, or a generated value added during later processing.

The values available from the matching Document are a subset of the values set in the document, determined by the filled status of this Hit. More fields may be requested by requesting further filling.

Lookups on names which does not exists in the document and is not added by later processing return null.

Lookups on fields which exist in the document, in a summary class which is already requested filled returns the following types, even when the field has no actual value:

• string and uri fields: A Java String.
  The empty string ("") if no value is assigned in the document.
• Dynamic summary string fields: A Java String before JuniperSearcher and a HitField after.
• Numerics: The corresponding numeric Java type.
  If the field has no value assigned in the document, the special numeric NanNumber.NaN is returned.
• raw fields: A RawData instance
• tensor fields: A Tensor instance
• multivalue fields: A Inspector instance

Overrides:

getField in class Hit

setField

public Object setField(String name,
                       Object value)

Description copied from class: Hit

Sets the value of a field

Overrides:

setField in class Hit

Returns:

the previous value, or null if none

forEachField

public void forEachField(BiConsumer<String,Object> consumer)

Description copied from class: Hit

Receive a callback on the given object for each field in this hit. This is more efficient than accessing the fields as a map or iterator.

Overrides:

forEachField in class Hit

forEachFieldAsRaw

public void forEachFieldAsRaw(Hit.RawUtf8Consumer consumer)

Description copied from class: Hit

Receive a callback on the given object for each field in this hit, where the callback will provide raw utf-8 byte data for strings whose data is already available at this form. This is the most resource efficient way of traversing all the fields of a hit in renderers which produces utf-8.

Overrides:

forEachFieldAsRaw in class Hit

fields

public Map<String,Object> fields()

Description copied from class: Hit

Returns the fields of this as a read-only map. This is more costly than fieldIterator()

Overrides:

fields in class Hit

fieldIterator

public Iterator<Map.Entry<String,Object>> fieldIterator()

Description copied from class: Hit

Returns a modifiable iterator over the fields of this

Overrides:

fieldIterator in class Hit

fieldKeys

public Set<String> fieldKeys()

Returns the keys of the fields of this hit as a modifiable view. This follows the rules of key sets returned from maps: Key removals are reflected in the map, add and addAll is not supported.

Overrides:

fieldKeys in class Hit

fieldNameIterator

private Iterator<String> fieldNameIterator()

Returns a modifiable iterator over the field names of this

clearFields

public void clearFields()

Removes all fields of this

Overrides:

clearFields in class Hit

removeField

public Object removeField(String name)

Removes a field from this

Overrides:

removeField in class Hit

Returns:

the removed value of the field, or null if none

mapFieldKeys

private Set<String> mapFieldKeys()

hasField

protected boolean hasField(String name)

Returns whether this field is present in the field map in the parent hit

Overrides:

hasField in class Hit

hasFields

protected boolean hasFields()

Returns whether any fields are present in the field map in the parent hit

Overrides:

hasFields in class Hit

changeFieldKey

@Deprecated
public void changeFieldKey(String oldKey,
                                       String newKey)

Deprecated. do not use

Changes the key under which a value is found. This is useful because it allows keys to be changed without accessing the value (which may be lazily created).

Overrides:

changeFieldKey in class Hit

getSummaryValue

private Object getSummaryValue(String name)

toString

public String toString()

Overrides:

toString in class Hit

hashCode

public int hashCode()

Description copied from class: Hit

Returns the hashCode of this hit, which is the hashcode of its uri.

Overrides:

hashCode in class Hit

asHexString

@Deprecated
public static String asHexString(com.yahoo.document.GlobalId gid)

Deprecated. do not use

asHexString

private static StringBuilder asHexString(StringBuilder sb,
                                         com.yahoo.document.GlobalId gid)