com.yahoo.prelude.fastsearch

Class PacketWrapper

java.lang.Object

com.yahoo.prelude.fastsearch.PacketWrapper

All Implemented Interfaces:

Cloneable

public class PacketWrapper
extends Object
implements Cloneable

A wrapper for cache entries to make it possible to check whether the hits are truly correct.

Author:

Steinar Knutsen, Mathias Lidal

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	PacketWrapper.ResultPacketComparator<T extends BasicPacket>

Field Summary

Fields

Modifier and Type	Field and Description
private Optional<Integer>	distributionKey
private int	keySize
private static Logger	log
private LinkedHashMap<DocsumPacketKey,BasicPacket>	packets
private static PacketWrapper.ResultPacketComparator<BasicPacket>	resultPacketComparator
private ArrayList<BasicPacket>	resultPackets

Constructor Summary

Constructors

Constructor and Description
PacketWrapper(CacheKey key, BasicPacket[] packets) Only used by PacketCacheTestCase, should not be used otherwise
PacketWrapper(CacheKey key, DocsumPacketKey[] packetKeys, BasicPacket[] bpackets, Optional<Integer> distributionKey)

Method Summary

Modifier and Type	Method and Description
void	addDocsums(DocsumPacketKey[] packetKeys, BasicPacket[] bpackets, int offset)
void	addDocsums(DocsumPacketKey[] packetKeys, Packet[] packets)
void	addResultPacket(QueryResultPacket resultPacket)
private void	cleanResultPackets()
Object	clone() Straightforward shallow copy.
Optional<Integer>	distributionKey() Returns the distribution key of the content node producing these hits, or empty if the hits were returned through dispatch
List<DocumentInfo>	getDocuments(int offset, int hits) Returns the list of documents, null if not all are available
QueryResultPacket	getFirstResultPacket()
int	getNumPackets()
(package private) BasicPacket	getPacket(DocsumPacketKey packetKey)
(package private) BasicPacket	getPacket(com.yahoo.document.GlobalId globalId, int partid, String summaryClass)
int	getPacketsSize()
List<BasicPacket>	getResultPackets() Only for testing.
(package private) long	getTimestamp()
void	setTimestamp(long timestamp)

Methods inherited from class java.lang.Object

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

Field Detail

log

private static Logger log

keySize

private final int keySize

resultPackets

private ArrayList<BasicPacket> resultPackets

packets

private LinkedHashMap<DocsumPacketKey,BasicPacket> packets

distributionKey

private final Optional<Integer> distributionKey

resultPacketComparator

private static PacketWrapper.ResultPacketComparator<BasicPacket> resultPacketComparator

Constructor Detail

PacketWrapper

public PacketWrapper(CacheKey key,
                     DocsumPacketKey[] packetKeys,
                     BasicPacket[] bpackets,
                     Optional<Integer> distributionKey)

PacketWrapper

public PacketWrapper(CacheKey key,
                     BasicPacket[] packets)

Only used by PacketCacheTestCase, should not be used otherwise

Method Detail

getFirstResultPacket

public QueryResultPacket getFirstResultPacket()

distributionKey

public Optional<Integer> distributionKey()

Returns the distribution key of the content node producing these hits, or empty if the hits were returned through dispatch

getDocuments

public List<DocumentInfo> getDocuments(int offset,
                                       int hits)

Returns the list of documents, null if not all are available

addResultPacket

public void addResultPacket(QueryResultPacket resultPacket)

cleanResultPackets

private void cleanResultPackets()

getResultPackets

public List<BasicPacket> getResultPackets()

Only for testing.

addDocsums

public void addDocsums(DocsumPacketKey[] packetKeys,
                       BasicPacket[] bpackets,
                       int offset)

addDocsums

public void addDocsums(DocsumPacketKey[] packetKeys,
                       Packet[] packets)

getNumPackets

public int getNumPackets()

getPacket

BasicPacket getPacket(com.yahoo.document.GlobalId globalId,
                      int partid,
                      String summaryClass)

getPacket

BasicPacket getPacket(DocsumPacketKey packetKey)

getTimestamp

long getTimestamp()

setTimestamp

public void setTimestamp(long timestamp)

getPacketsSize

public int getPacketsSize()

clone

public Object clone()

Straightforward shallow copy.

Overrides:

clone in class Object