com.yahoo.search.rendering

Class DefaultRenderer

java.lang.Object

com.yahoo.component.AbstractComponent

com.yahoo.processing.rendering.Renderer<RESPONSE>

com.yahoo.processing.rendering.AsynchronousRenderer<RESPONSE>

com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

com.yahoo.search.rendering.DefaultRenderer

All Implemented Interfaces:

com.yahoo.component.Component, Cloneable, Comparable<com.yahoo.component.Component>

Deprecated.

use JsonRenderer instead

@Deprecated
public final class DefaultRenderer
extends com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

XML rendering of search results. This is NOT the default (but it once was).

Author:

tonytv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DefaultRenderer.RenderingVisitor Deprecated.

Field Summary

Fields

Modifier and Type	Field and Description
private static com.yahoo.text.Utf8String	CODE Deprecated.
private static com.yahoo.text.Utf8String	COVERAGE Deprecated.
private static com.yahoo.text.Utf8String	COVERAGE_DOCS Deprecated.
private static com.yahoo.text.Utf8String	COVERAGE_FULL Deprecated.
private static com.yahoo.text.Utf8String	COVERAGE_NODES Deprecated.
static String	DEFAULT_ENCODING Deprecated.
static String	DEFAULT_MIMETYPE Deprecated.
private static com.yahoo.text.Utf8String	ERROR Deprecated.
private static com.yahoo.text.Utf8String	FIELD Deprecated.
private com.yahoo.concurrent.CopyOnWriteHashMap<String,com.yahoo.text.Utf8String>	fieldNameMap Deprecated.
private static com.yahoo.text.Utf8String	GROUP Deprecated.
private static com.yahoo.text.Utf8String	HIT Deprecated.
private static com.yahoo.text.Utf8String	ID Deprecated.
private static com.yahoo.text.Utf8String	NAME Deprecated.
private static com.yahoo.text.Utf8String	QUERY_TIME Deprecated.
private static com.yahoo.text.Utf8String	RELEVANCY Deprecated.
private static com.yahoo.text.Utf8String	RESULT Deprecated.
private static com.yahoo.text.Utf8String	RESULTS Deprecated.
private static com.yahoo.text.Utf8String	RESULTS_FULL Deprecated.
private static com.yahoo.text.Utf8String	SEARCH_TIME Deprecated.
private static com.yahoo.text.Utf8String	SOURCE Deprecated.
private static com.yahoo.text.Utf8String	SUMMARY_FETCH_TIME Deprecated.
private static com.yahoo.text.Utf8String	TOTAL_HIT_COUNT Deprecated.
private static com.yahoo.text.Utf8String	TYPE Deprecated.
private com.yahoo.text.XMLWriter	writer Deprecated.

Fields inherited from class com.yahoo.component.AbstractComponent

isDeconstructable

Constructor Summary

Constructors

Constructor and Description
DefaultRenderer() Deprecated.
DefaultRenderer(Executor executor) Deprecated. Creates a json renderer using a custom executor.

Method Summary

Modifier and Type	Method and Description
private String	asXML(Object value) Deprecated.
void	beginList(com.yahoo.processing.response.DataList<?> list) Deprecated.
void	beginResponse(OutputStream stream) Deprecated.
void	data(com.yahoo.processing.response.Data data) Deprecated.
protected void	emptyResult(com.yahoo.text.XMLWriter writer, Result result) Deprecated.
void	endList(com.yahoo.processing.response.DataList<?> list) Deprecated.
void	endResponse() Deprecated.
void	error(com.yahoo.text.XMLWriter writer, Result result) Deprecated.
String	getEncoding() Deprecated.
String	getMimeType() Deprecated.
String	getRequestedEncoding(Query query) Deprecated. Returns the encoding of the query, or the encoding given by the template if none is set
private Result	getResult() Deprecated.
private void	header(com.yahoo.text.XMLWriter writer, Result result) Deprecated.
void	init() Deprecated.
void	queryContext(com.yahoo.text.XMLWriter writer, QueryContext queryContext, Query owner) Deprecated.
protected static void	renderCoverageAttributes(Coverage coverage, com.yahoo.text.XMLWriter writer) Deprecated.
private void	renderField(com.yahoo.text.XMLWriter writer, String name, Object value) Deprecated.
private void	renderFieldContent(com.yahoo.text.XMLWriter writer, Object value) Deprecated.
private void	renderGroup(com.yahoo.text.XMLWriter writer, HitGroup hit) Deprecated.
private void	renderHitAttributes(com.yahoo.text.XMLWriter writer, Hit hit) Deprecated.
private void	renderHitFields(com.yahoo.text.XMLWriter writer, Hit hit) Deprecated.
private void	renderHitGroup(com.yahoo.text.XMLWriter writer, HitGroup hit) Deprecated.
private void	renderHitGroupOfTypeGroupHit(com.yahoo.text.XMLWriter writer, HitGroup hit) Deprecated.
private void	renderId(com.yahoo.text.XMLWriter writer, HitGroup hit) Deprecated.
static void	renderMessageDefaultErrorHit(com.yahoo.text.XMLWriter writer, ErrorMessage error) Deprecated.
private void	renderSimpleField(com.yahoo.text.XMLWriter writer, String relevancyFieldName, Relevance relevance) Deprecated.
private void	renderSingularHit(com.yahoo.text.XMLWriter writer, Hit hit) Deprecated.
private void	renderSyntheticRelevanceField(com.yahoo.text.XMLWriter writer, Hit hit) Deprecated.
private void	renderTime(com.yahoo.text.XMLWriter writer, Result result) Deprecated.
static boolean	simpleRenderDefaultErrorHit(com.yahoo.text.XMLWriter writer, ErrorHit defaultErrorHit) Deprecated.
private boolean	simpleRenderHit(com.yahoo.text.XMLWriter writer, Hit hit) Deprecated.
private com.yahoo.text.XMLWriter	wrapWriter(Writer writer) Deprecated.
private void	writeCloseFieldElement(com.yahoo.text.XMLWriter writer) Deprecated.
private void	writeOpenFieldElement(com.yahoo.text.XMLWriter writer, String relevancyFieldName) Deprecated.

Methods inherited from class com.yahoo.processing.rendering.AsynchronousSectionedRenderer

clientClosed, deconstruct, getExecution, getRecursionLevel, getResponse, onClientClosed, render, renderBeforeHandover, setNetworkWiring

Methods inherited from class com.yahoo.processing.rendering.Renderer

clone

Methods inherited from class com.yahoo.component.AbstractComponent

compareTo, getClassName, getId, getIdString, hasInitializedId, initId, isDeconstructable, setIsDeconstructable, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MIMETYPE

public static final String DEFAULT_MIMETYPE

Deprecated.

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

Deprecated.

See Also:

Constant Field Values

RESULT

private static final com.yahoo.text.Utf8String RESULT

Deprecated.

GROUP

private static final com.yahoo.text.Utf8String GROUP

Deprecated.

ID

private static final com.yahoo.text.Utf8String ID

Deprecated.

FIELD

private static final com.yahoo.text.Utf8String FIELD

Deprecated.

HIT

private static final com.yahoo.text.Utf8String HIT

Deprecated.

ERROR

private static final com.yahoo.text.Utf8String ERROR

Deprecated.

TOTAL_HIT_COUNT

private static final com.yahoo.text.Utf8String TOTAL_HIT_COUNT

Deprecated.

QUERY_TIME

private static final com.yahoo.text.Utf8String QUERY_TIME

Deprecated.

SUMMARY_FETCH_TIME

private static final com.yahoo.text.Utf8String SUMMARY_FETCH_TIME

Deprecated.

SEARCH_TIME

private static final com.yahoo.text.Utf8String SEARCH_TIME

Deprecated.

NAME

private static final com.yahoo.text.Utf8String NAME

Deprecated.

CODE

private static final com.yahoo.text.Utf8String CODE

Deprecated.

COVERAGE_DOCS

private static final com.yahoo.text.Utf8String COVERAGE_DOCS

Deprecated.

COVERAGE_NODES

private static final com.yahoo.text.Utf8String COVERAGE_NODES

Deprecated.

COVERAGE_FULL

private static final com.yahoo.text.Utf8String COVERAGE_FULL

Deprecated.

COVERAGE

private static final com.yahoo.text.Utf8String COVERAGE

Deprecated.

RESULTS_FULL

private static final com.yahoo.text.Utf8String RESULTS_FULL

Deprecated.

RESULTS

private static final com.yahoo.text.Utf8String RESULTS

Deprecated.

TYPE

private static final com.yahoo.text.Utf8String TYPE

Deprecated.

RELEVANCY

private static final com.yahoo.text.Utf8String RELEVANCY

Deprecated.

SOURCE

private static final com.yahoo.text.Utf8String SOURCE

Deprecated.

fieldNameMap

private final com.yahoo.concurrent.CopyOnWriteHashMap<String,com.yahoo.text.Utf8String> fieldNameMap

Deprecated.

writer

private com.yahoo.text.XMLWriter writer

Deprecated.

Constructor Detail

DefaultRenderer

public DefaultRenderer()

Deprecated.

DefaultRenderer

public DefaultRenderer(Executor executor)

Deprecated.

Creates a json renderer using a custom executor. Using a custom executor is useful for tests to avoid creating new threads for each renderer registry.

Method Detail

init

public void init()

Deprecated.

Overrides:

init in class com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

getEncoding

public String getEncoding()

Deprecated.

Specified by:

getEncoding in class com.yahoo.processing.rendering.Renderer<Result>

getMimeType

public String getMimeType()

Deprecated.

Specified by:

getMimeType in class com.yahoo.processing.rendering.Renderer<Result>

wrapWriter

private com.yahoo.text.XMLWriter wrapWriter(Writer writer)

Deprecated.

header

private void header(com.yahoo.text.XMLWriter writer,
                    Result result)
             throws IOException

Deprecated.

Throws:

IOException

renderTime

private void renderTime(com.yahoo.text.XMLWriter writer,
                        Result result)

Deprecated.

renderCoverageAttributes

protected static void renderCoverageAttributes(Coverage coverage,
                                               com.yahoo.text.XMLWriter writer)
                                        throws IOException

Deprecated.

Throws:

IOException

error

public void error(com.yahoo.text.XMLWriter writer,
                  Result result)
           throws IOException

Deprecated.

Throws:

IOException

emptyResult

protected void emptyResult(com.yahoo.text.XMLWriter writer,
                           Result result)
                    throws IOException

Deprecated.

Throws:

IOException

queryContext

public void queryContext(com.yahoo.text.XMLWriter writer,
                         QueryContext queryContext,
                         Query owner)
                  throws IOException

Deprecated.

Throws:

IOException

renderSingularHit

private void renderSingularHit(com.yahoo.text.XMLWriter writer,
                               Hit hit)

Deprecated.

renderHitFields

private void renderHitFields(com.yahoo.text.XMLWriter writer,
                             Hit hit)

Deprecated.

renderField

private void renderField(com.yahoo.text.XMLWriter writer,
                         String name,
                         Object value)

Deprecated.

renderFieldContent

private void renderFieldContent(com.yahoo.text.XMLWriter writer,
                                Object value)

Deprecated.

asXML

private String asXML(Object value)

Deprecated.

renderSyntheticRelevanceField

private void renderSyntheticRelevanceField(com.yahoo.text.XMLWriter writer,
                                           Hit hit)

Deprecated.

renderSimpleField

private void renderSimpleField(com.yahoo.text.XMLWriter writer,
                               String relevancyFieldName,
                               Relevance relevance)

Deprecated.

writeCloseFieldElement

private void writeCloseFieldElement(com.yahoo.text.XMLWriter writer)

Deprecated.

writeOpenFieldElement

private void writeOpenFieldElement(com.yahoo.text.XMLWriter writer,
                                   String relevancyFieldName)

Deprecated.

renderHitAttributes

private void renderHitAttributes(com.yahoo.text.XMLWriter writer,
                                 Hit hit)

Deprecated.

renderHitGroup

private void renderHitGroup(com.yahoo.text.XMLWriter writer,
                            HitGroup hit)
                     throws IOException

Deprecated.

Throws:

IOException

renderGroup

private void renderGroup(com.yahoo.text.XMLWriter writer,
                         HitGroup hit)

Deprecated.

renderHitGroupOfTypeGroupHit

private void renderHitGroupOfTypeGroupHit(com.yahoo.text.XMLWriter writer,
                                          HitGroup hit)

Deprecated.

renderId

private void renderId(com.yahoo.text.XMLWriter writer,
                      HitGroup hit)

Deprecated.

simpleRenderHit

private boolean simpleRenderHit(com.yahoo.text.XMLWriter writer,
                                Hit hit)
                         throws IOException

Deprecated.

Throws:

IOException

simpleRenderDefaultErrorHit

public static boolean simpleRenderDefaultErrorHit(com.yahoo.text.XMLWriter writer,
                                                  ErrorHit defaultErrorHit)
                                           throws IOException

Deprecated.

Throws:

IOException

renderMessageDefaultErrorHit

public static void renderMessageDefaultErrorHit(com.yahoo.text.XMLWriter writer,
                                                ErrorMessage error)
                                         throws IOException

Deprecated.

Throws:

IOException

getResult

private Result getResult()

Deprecated.

beginResponse

public void beginResponse(OutputStream stream)
                   throws IOException

Deprecated.

Specified by:

beginResponse in class com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

Throws:

IOException

getRequestedEncoding

public final String getRequestedEncoding(Query query)

Deprecated.

Returns the encoding of the query, or the encoding given by the template if none is set

beginList

public void beginList(com.yahoo.processing.response.DataList<?> list)
               throws IOException

Deprecated.

Specified by:

beginList in class com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

Throws:

IOException

data

public void data(com.yahoo.processing.response.Data data)
          throws IOException

Deprecated.

Specified by:

data in class com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

Throws:

IOException

endList

public void endList(com.yahoo.processing.response.DataList<?> list)

Deprecated.

Specified by:

endList in class com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

endResponse

public void endResponse()

Deprecated.

Specified by:

endResponse in class com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>