Package com.yahoo.search.pagetemplates.result

Class PageTemplatesXmlRenderer

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.pagetemplates.result.PageTemplatesXmlRenderer

All Implemented Interfaces:

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

public class PageTemplatesXmlRenderer
extends com.yahoo.processing.rendering.AsynchronousSectionedRenderer<Result>

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_ENCODING
static String	DEFAULT_MIMETYPE

Fields inherited from class com.yahoo.component.AbstractComponent

isDeconstructable

Constructor Summary

Constructors

Constructor	Description
PageTemplatesXmlRenderer()
PageTemplatesXmlRenderer(Executor executor)	Creates a json renderer using a custom executor.

Method Summary

Modifier and Type	Method	Description
void	beginList(com.yahoo.processing.response.DataList<?> list)
void	beginResponse(OutputStream stream)
void	data(com.yahoo.processing.response.Data data)
void	endList(com.yahoo.processing.response.DataList<?> list)
void	endResponse()
void	error(com.yahoo.text.XMLWriter writer, Result result)
String	getEncoding()
String	getMimeType()
String	getRequestedEncoding(Query query)	Returns the encoding of the query, or the encoding given by the template if none is set
void	init()
static void	renderMessageDefaultErrorHit(com.yahoo.text.XMLWriter writer, ErrorMessage error)
static boolean	simpleRenderDefaultErrorHit(com.yahoo.text.XMLWriter writer, ErrorHit defaultErrorHit)

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

clientClosed, deconstruct, getExecution, getRecursionLevel, getResponse, onClientClosed, renderBeforeHandover, renderResponse, renderResponseBeforeHandover, setNetworkWiring

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

clone, render

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

See Also:

Constant Field Values

DEFAULT_ENCODING

public static final String DEFAULT_ENCODING

See Also:

Constant Field Values

Constructor Detail

PageTemplatesXmlRenderer

public PageTemplatesXmlRenderer()

PageTemplatesXmlRenderer

public PageTemplatesXmlRenderer(Executor executor)

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()

Overrides:

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

getEncoding

public String getEncoding()

Specified by:

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

getMimeType

public String getMimeType()

Specified by:

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

error

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

simpleRenderDefaultErrorHit

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

renderMessageDefaultErrorHit

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

beginResponse

public void beginResponse(OutputStream stream)

Specified by:

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

getRequestedEncoding

public final String getRequestedEncoding(Query query)

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)

Specified by:

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

data

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

Specified by:

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

endList

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

Specified by:

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

endResponse

public void endResponse()

Specified by:

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