com.yahoo.fs4

Class DocumentInfo

java.lang.Object

com.yahoo.fs4.DocumentInfo

All Implemented Interfaces:

Cloneable

public class DocumentInfo
extends Object
implements Cloneable

Meta attributes on documents (not the document summaries themselves). Used in query results and get docusum packages

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private int	distributionKey
private com.yahoo.document.GlobalId	globalId
private double	metric
private int	partId

Constructor Summary

Constructors

Constructor and Description
DocumentInfo(ByteBuffer buffer, QueryResultPacket owner)
DocumentInfo(com.yahoo.document.GlobalId globalId, int metric, int partId, int distributionKey)

Method Summary

Modifier and Type	Method and Description
Object	clone() Implements the Cloneable interface
private double	decodeMetric(ByteBuffer buffer)
int	getDistributionKey() Unique key for the node this document resides on
com.yahoo.document.GlobalId	getGlobalId()
double	getMetric() Raw rank score
int	getPartId() Partition this document resides on
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

globalId

private final com.yahoo.document.GlobalId globalId

metric

private final double metric

partId

private final int partId

distributionKey

private final int distributionKey

Constructor Detail

DocumentInfo

DocumentInfo(ByteBuffer buffer,
             QueryResultPacket owner)

DocumentInfo

public DocumentInfo(com.yahoo.document.GlobalId globalId,
                    int metric,
                    int partId,
                    int distributionKey)

Method Detail

decodeMetric

private double decodeMetric(ByteBuffer buffer)

getGlobalId

public com.yahoo.document.GlobalId getGlobalId()

getMetric

public double getMetric()

Raw rank score

getPartId

public int getPartId()

Partition this document resides on

getDistributionKey

public int getDistributionKey()

Unique key for the node this document resides on

toString

public String toString()

Overrides:

toString in class Object

clone

public Object clone()

Implements the Cloneable interface

Overrides:

clone in class Object