com.yahoo.fs4

Class GetDocSumsPacket

java.lang.Object

com.yahoo.fs4.BasicPacket

com.yahoo.fs4.Packet

com.yahoo.fs4.GetDocSumsPacket

public class GetDocSumsPacket
extends Packet

A packet for requesting a list of document summaries. This packet can be encoded only.

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private int	flags
static int	GDF_FLAGS
static int	GDF_LOCATION
static int	GDF_MLD features bits, as given in searchlib/src/searchlib/common/packets.h definition of enum getdocsums_features
static int	GDF_PROPERTIES
static int	GDF_QUERYSTACK
static int	GDF_RANKP_QFLAGS
static int	GDF_RESCLASSNAME
static int	GDFLAG_ALLOW_SLIME
static int	GDFLAG_IGNORE_ROW flag bits, as given in fastserver4/src/network/transport.h definition of enum getdocsums_flags
private static Logger	log
private Query	query
private QueryPacketData	queryPacketData
private Result	result
private boolean	sendQuery True if we should send the query with this docsum, false otherwise.
static String	sessionIdKey Session id key.
private String	summaryClass

Fields inherited from class com.yahoo.fs4.Packet

channel, CHANNEL_ID_OFFSET

Fields inherited from class com.yahoo.fs4.BasicPacket

CODE_MASK, encodedBody, encodingBuffer, length

Constructor Summary

Constructors

Modifier	Constructor and Description
private	GetDocSumsPacket(Result result, String summaryClass, boolean sendQuery)

Method Summary

Modifier and Type	Method and Description
static GetDocSumsPacket	create(Result result, String summaryClass, boolean sendQuery) Creates a get docsums packet for a certain result
void	encodeBody(ByteBuffer buffer) Encodes the body of this package onto the given buffer at the current position.
private void	encodeDocIds(ByteBuffer buffer)
private void	encodeQuery(ByteBuffer buffer)
private void	encodeQueryFromPacketData(ByteBuffer buffer, boolean reencodePropertyMaps)
private void	encodeSummaryClass(ByteBuffer buffer)
int	getCode() Returns the code of this package
int	getNumDocsums()
String	getSummaryClass() Return the document summary class we want the fdispatch to use when replying to us
private void	setFieldsFromHits()
String	toString()

Methods inherited from class com.yahoo.fs4.Packet

decode, encode, getChannel, hasChannelId, patchChannelId, setChannel

Methods inherited from class com.yahoo.fs4.BasicPacket

allocateAndEncode, codeDecodedHook, decodeAndDecompressBody, decodeBody, encode, encodeAndCompressBody, getLength, getTimestamp, grantEncodingBuffer, grantEncodingBuffer, isEncoded, setCompressionLimit, setCompressionType, setEncodedBody, setTimestamp

Methods inherited from class java.lang.Object

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

Field Detail

sessionIdKey

public static final String sessionIdKey

Session id key. Yep, putting this here is ugly as hell

See Also:

Constant Field Values

log

private static final Logger log

result

private final Result result

query

private final Query query

summaryClass

private final String summaryClass

queryPacketData

private QueryPacketData queryPacketData

flags

private int flags

sendQuery

private final boolean sendQuery

True if we should send the query with this docsum, false otherwise. Sending the query is necessary if we need to return summary features or generate a dynamic summary

GDF_MLD

public static final int GDF_MLD

features bits, as given in searchlib/src/searchlib/common/packets.h definition of enum getdocsums_features

See Also:

Constant Field Values

GDF_QUERYSTACK

public static final int GDF_QUERYSTACK

See Also:

Constant Field Values

GDF_RANKP_QFLAGS

public static final int GDF_RANKP_QFLAGS

See Also:

Constant Field Values

GDF_LOCATION

public static final int GDF_LOCATION

See Also:

Constant Field Values

GDF_RESCLASSNAME

public static final int GDF_RESCLASSNAME

See Also:

Constant Field Values

GDF_PROPERTIES

public static final int GDF_PROPERTIES

See Also:

Constant Field Values

GDF_FLAGS

public static final int GDF_FLAGS

See Also:

Constant Field Values

GDFLAG_IGNORE_ROW

public static final int GDFLAG_IGNORE_ROW

flag bits, as given in fastserver4/src/network/transport.h definition of enum getdocsums_flags

See Also:

Constant Field Values

GDFLAG_ALLOW_SLIME

public static final int GDFLAG_ALLOW_SLIME

See Also:

Constant Field Values

Constructor Detail

GetDocSumsPacket

private GetDocSumsPacket(Result result,
                         String summaryClass,
                         boolean sendQuery)

Method Detail

create

public static GetDocSumsPacket create(Result result,
                                      String summaryClass,
                                      boolean sendQuery)

Creates a get docsums packet for a certain result

encodeBody

public void encodeBody(ByteBuffer buffer)

Description copied from class: BasicPacket

Encodes the body of this package onto the given buffer at the current position. The position of the buffer after encoding is the byte following the last encoded byte.

Overrides:

encodeBody in class BasicPacket

setFieldsFromHits

private void setFieldsFromHits()

encodeQueryFromPacketData

private void encodeQueryFromPacketData(ByteBuffer buffer,
                                       boolean reencodePropertyMaps)

encodeSummaryClass

private void encodeSummaryClass(ByteBuffer buffer)

encodeQuery

private void encodeQuery(ByteBuffer buffer)

encodeDocIds

private void encodeDocIds(ByteBuffer buffer)

getCode

public int getCode()

Description copied from class: BasicPacket

Returns the code of this package

Specified by:

getCode in class BasicPacket

toString

public String toString()

Overrides:

toString in class Packet

getNumDocsums

public int getNumDocsums()

getSummaryClass

public String getSummaryClass()

Return the document summary class we want the fdispatch to use when replying to us