com.yahoo.search.grouping.result

Class HitRenderer

java.lang.Object

com.yahoo.search.grouping.result.HitRenderer

public abstract class HitRenderer
extends Object

This is a helper class for rendering grouping results.

Author:

Simon Thoresen

Field Summary

Fields

Modifier and Type	Field and Description
private static com.yahoo.text.Utf8String	ATR_LABEL
private static com.yahoo.text.Utf8String	ATR_RELEVANCE
private static com.yahoo.text.Utf8String	ATR_TYPE
private static com.yahoo.text.Utf8String	TAG_BUCKET_FROM
private static com.yahoo.text.Utf8String	TAG_BUCKET_TO
private static com.yahoo.text.Utf8String	TAG_CONTINUATION
private static com.yahoo.text.Utf8String	TAG_CONTINUATION_ID
private static com.yahoo.text.Utf8String	TAG_GROUP
private static com.yahoo.text.Utf8String	TAG_GROUP_ID
private static com.yahoo.text.Utf8String	TAG_GROUP_LIST
private static com.yahoo.text.Utf8String	TAG_HIT_LIST
private static com.yahoo.text.Utf8String	TAG_OUTPUT

Constructor Summary

Constructors

Constructor and Description
HitRenderer()

Method Summary

Modifier and Type	Method and Description
private static Object	getBucketFrom(BucketGroupId id)
private static Object	getBucketTo(BucketGroupId id)
private static Object	getIdValue(ValueGroupId id)
private static void	renderContinuation(String id, Continuation continuation, com.yahoo.text.XMLWriter writer)
private static void	renderContinuations(Map<String,Continuation> continuations, com.yahoo.text.XMLWriter writer)
private static void	renderGroupId(GroupId id, com.yahoo.text.XMLWriter writer)
static boolean	renderHeader(HitGroup hit, com.yahoo.text.XMLWriter writer) Renders the header for the given grouping hit.

Methods inherited from class java.lang.Object

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

Field Detail

ATR_LABEL

private static final com.yahoo.text.Utf8String ATR_LABEL

ATR_RELEVANCE

private static final com.yahoo.text.Utf8String ATR_RELEVANCE

ATR_TYPE

private static final com.yahoo.text.Utf8String ATR_TYPE

TAG_BUCKET_FROM

private static final com.yahoo.text.Utf8String TAG_BUCKET_FROM

TAG_BUCKET_TO

private static final com.yahoo.text.Utf8String TAG_BUCKET_TO

TAG_CONTINUATION

private static final com.yahoo.text.Utf8String TAG_CONTINUATION

TAG_CONTINUATION_ID

private static final com.yahoo.text.Utf8String TAG_CONTINUATION_ID

TAG_GROUP_LIST

private static final com.yahoo.text.Utf8String TAG_GROUP_LIST

TAG_GROUP

private static final com.yahoo.text.Utf8String TAG_GROUP

TAG_GROUP_ID

private static final com.yahoo.text.Utf8String TAG_GROUP_ID

TAG_HIT_LIST

private static final com.yahoo.text.Utf8String TAG_HIT_LIST

TAG_OUTPUT

private static final com.yahoo.text.Utf8String TAG_OUTPUT

Constructor Detail

HitRenderer

public HitRenderer()

Method Detail

renderHeader

public static boolean renderHeader(HitGroup hit,
                                   com.yahoo.text.XMLWriter writer)
                            throws IOException

Renders the header for the given grouping hit. If the hit is not a grouping hit, this method does nothing and returns false.

Post-condition if this is a grouping hit: The hit tag is open.

Parameters:

hit - The hit whose header to render.

writer - The writer to render to.

Returns:

True if the hit was rendered.

Throws:

IOException - Thrown if there was a problem writing.

renderGroupId

private static void renderGroupId(GroupId id,
                                  com.yahoo.text.XMLWriter writer)

getIdValue

private static Object getIdValue(ValueGroupId id)

getBucketFrom

private static Object getBucketFrom(BucketGroupId id)

getBucketTo

private static Object getBucketTo(BucketGroupId id)

renderContinuations

private static void renderContinuations(Map<String,Continuation> continuations,
                                        com.yahoo.text.XMLWriter writer)

renderContinuation

private static void renderContinuation(String id,
                                       Continuation continuation,
                                       com.yahoo.text.XMLWriter writer)