com.yahoo.prelude.templates

Class TiledTemplateSet

java.lang.Object

com.yahoo.prelude.templates.GenericTemplateSet

com.yahoo.prelude.templates.UserTemplate<com.yahoo.text.XMLWriter>

com.yahoo.prelude.templates.DefaultTemplateSet

com.yahoo.prelude.templates.TiledTemplateSet

Direct Known Subclasses:

PageTemplateSet

Deprecated.

use a Renderer instead

@Deprecated
public class TiledTemplateSet
extends DefaultTemplateSet

A template set which implements the 'tiled' format. This template implementation requires a few rules to be observed for it to work properly:

• As hit fields are rendered as XML tag names, their name must be compatible with XML tag names.
• Results sections, meta section, provider tags are rendered based on hits having specific types (as in Hit.types(), see table below for a list of hit types that are needed in order for hits to render properly.
• Some fields inside hits corresponding to provider tags (/result/meta/provider) are formatted in a specific way, see provider fields formatting options below. Other fields are rendered the usual way.

Hit types required for proper rendering

XML tag path	Required hit type
/result/section	A hit group and have a "section" type
/result/meta	A hit group and have a "meta" type
/result/meta/provider	A hit that has a "logging" type

Provider fields formatting options

Field	Formatting	Field type
provider	name attribute of <provider> tag	Provided by container
scheme	scheme attribute of <provider> tag	Provided by container
host	host attribute of <provider> tag	Provided by container
port	port attribute of <provider> tag	Provided by container
path	path attribute of <provider> tag	Provided by container
status	result attribute of <provider> tag	Provided by container
latency_connect	<latency type="connect"> tag	Provided by container
latency_start	<latency type="start"> tag	Provided by container
latency_finish	<latency type="finish"> tag	Provided by container
query_param_*	<parameter name="..."> tag	Provided by container
header_*	<header name="..."> tag	Provided by container
response_header_*	<response-header name="..."> tag	Provided by container
count_first	<count type="first"> tag	Provided by container
count_last	<count type="last"> tag	Provided by container
count_total	<count type="total"> tag	Provided by container
count_deep	<count type="deep"> tag	Provided by container
queryattrs_xorronum	<queryattrs name="xorronum"> tag	Provided by YST searcher
queryattrs_RankFeaturesRewriterAttr	<queryattrs name="RankFeaturesRewriterAttr"> tag	Provided by YST searcher
queryattrs_intlannotator	<queryattrs name="intlannotator"> tag	Provided by YST searcher
queryattrs_category	<queryattrs name="category"> tag	Provided by YST searcher
wordcounts_*	<wordcounts word="..."> tag	Provided by YST searcher

Author:

bratseth, laboisse

Field Summary

Fields

Modifier and Type	Field and Description
private FormattingOptions	hitOptions Deprecated.
private FormattingOptions	hitOptionsForProvider Deprecated.

Fields inherited from class com.yahoo.prelude.templates.GenericTemplateSet

DEFAULT_ENCODING, DEFAULT_MIMETYPE

Constructor Summary

Constructors

Constructor and Description
TiledTemplateSet() Deprecated.
TiledTemplateSet(String templateName) Deprecated.

Method Summary

Modifier and Type	Method and Description
private String	asXML(Object value) Deprecated.
void	header(Context context, com.yahoo.text.XMLWriter writer) Deprecated. Render the result set header.
void	hit(Context context, com.yahoo.text.XMLWriter writer) Deprecated. Overrides UserTemplate.hit(Context, Writer) to print 'logging' type meta hits as /result/meta/provider tags.
protected void	renderField(Context context, Hit hit, Map.Entry<String,Object> entry, com.yahoo.text.XMLWriter writer) Deprecated.
protected void	renderHitAttributes(Hit hit, com.yahoo.text.XMLWriter writer) Deprecated. Augments default hit attributes rendering with formatting options.
protected void	renderHitFields(Context context, Hit hit, com.yahoo.text.XMLWriter writer) Deprecated. Renders all fields of the hit
protected void	renderHitGroup(HitGroup hit, Context context, com.yahoo.text.XMLWriter writer) Deprecated. Overrides DefaultTemplateSet.renderHitGroup(HitGroup, Context, XMLWriter) for /result/section and /result/meta hit groups.
private void	renderParameters(Map<String,String> parameters, com.yahoo.text.XMLWriter writer) Deprecated.
protected void	renderProvider(Context context, Hit hit, com.yahoo.text.XMLWriter writer) Deprecated. Renders /result/meta/provider.
protected void	renderProviderField(Context context, Hit hit, Map.Entry<String,Object> entry, com.yahoo.text.XMLWriter writer) Deprecated. Renders one field under /result/meta/provider.
protected void	renderProviderHitAttributes(Hit hit, com.yahoo.text.XMLWriter writer) Deprecated. Specific hit attributes rendering for 'provider' meta hits under /result/meta.
protected void	renderProviderHitFields(Context context, Hit hit, com.yahoo.text.XMLWriter writer) Deprecated. Renders fields under /result/meta/provider.
protected void	renderSection(HitGroup hit, com.yahoo.text.XMLWriter writer) Deprecated. Renders /result/section.
protected void	renderSectionContent(HitGroup hit, com.yahoo.text.XMLWriter writer) Deprecated.
protected boolean	shouldRenderField(Hit hit, String fieldName) Deprecated. Returns whether a field should be rendered.
String	toString() Deprecated.
com.yahoo.text.XMLWriter	wrapWriter(Writer writer) Deprecated. Uses an XML writer in this template

Methods inherited from class com.yahoo.prelude.templates.DefaultTemplateSet

error, footer, hitFooter, noHits, renderCoverageAttributes, renderFieldContent, renderGroup, renderHitGroupOfTypeGroupHit, renderId

Methods inherited from class com.yahoo.prelude.templates.UserTemplate

createContext, dumpAndXMLQuoteUTF8, dumpBytes, isDefaultTemplateSet, queryContext

Methods inherited from class com.yahoo.prelude.templates.GenericTemplateSet

getBoldCloseTag, getBoldOpenTag, getEncoding, getMimeType, getName, getRequestedEncoding, getSeparatorTag, getSummaryClass, getTemplate, setHighlightTags, setSummaryClass, setTemplate, setTemplateNotNull

Methods inherited from class java.lang.Object

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

Field Detail

hitOptionsForProvider

private FormattingOptions hitOptionsForProvider

Deprecated.

hitOptions

private FormattingOptions hitOptions

Deprecated.

Constructor Detail

TiledTemplateSet

public TiledTemplateSet()

Deprecated.

TiledTemplateSet

public TiledTemplateSet(String templateName)

Deprecated.

Method Detail

wrapWriter

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

Deprecated.

Description copied from class: DefaultTemplateSet

Uses an XML writer in this template

Overrides:

wrapWriter in class DefaultTemplateSet

header

public void header(Context context,
                   com.yahoo.text.XMLWriter writer)
            throws IOException

Deprecated.

Description copied from class: UserTemplate

Render the result set header.

The result set is available in the context object under the name "result".

Overrides:

header in class DefaultTemplateSet

Parameters:

context - wrapper which will contain, among other thing, the result set instance

writer - the destination for rendering the result

Throws:

IOException - may be propagated from the writer

renderHitAttributes

protected void renderHitAttributes(Hit hit,
                                   com.yahoo.text.XMLWriter writer)
                            throws IOException

Deprecated.

Augments default hit attributes rendering with formatting options. There's also a hacky part: if hit is actually a hit group, tries to use the 'type' field in place of the hit's type, to avoid having the 'group' hit type.

Overrides:

renderHitAttributes in class DefaultTemplateSet

Throws:

IOException

renderField

protected void renderField(Context context,
                           Hit hit,
                           Map.Entry<String,Object> entry,
                           com.yahoo.text.XMLWriter writer)
                    throws IOException

Deprecated.

Overrides:

renderField in class DefaultTemplateSet

Throws:

IOException

renderHitFields

protected void renderHitFields(Context context,
                               Hit hit,
                               com.yahoo.text.XMLWriter writer)
                        throws IOException

Deprecated.

Renders all fields of the hit

Overrides:

renderHitFields in class DefaultTemplateSet

Throws:

IOException

shouldRenderField

protected boolean shouldRenderField(Hit hit,
                                    String fieldName)

Deprecated.

Description copied from class: DefaultTemplateSet

Returns whether a field should be rendered. This default implementation always returns true

Overrides:

shouldRenderField in class DefaultTemplateSet

hit

public void hit(Context context,
                com.yahoo.text.XMLWriter writer)
         throws IOException

Deprecated.

Overrides UserTemplate.hit(Context, Writer) to print 'logging' type meta hits as /result/meta/provider tags. Fails back to super.hit(context, writer) in other cases.

Overrides:

hit in class DefaultTemplateSet

Parameters:

context - wrapper which will contain, among other thing, the hit instance

writer - the destination for rendering the hit

Throws:

IOException - may be propagated from the writer

renderHitGroup

protected void renderHitGroup(HitGroup hit,
                              Context context,
                              com.yahoo.text.XMLWriter writer)
                       throws IOException

Deprecated.

Overrides DefaultTemplateSet.renderHitGroup(HitGroup, Context, XMLWriter) for /result/section and /result/meta hit groups. Fails back to super.renderHitGroup(hit, context, writer) otherwise.

Overrides:

renderHitGroup in class DefaultTemplateSet

Throws:

IOException

renderSection

protected void renderSection(HitGroup hit,
                             com.yahoo.text.XMLWriter writer)
                      throws IOException

Deprecated.

Renders /result/section. Doesn't use renderHitAttributes(Hit, XMLWriter).

Throws:

IOException

renderSectionContent

protected void renderSectionContent(HitGroup hit,
                                    com.yahoo.text.XMLWriter writer)
                             throws IOException

Deprecated.

Throws:

IOException

renderParameters

private void renderParameters(Map<String,String> parameters,
                              com.yahoo.text.XMLWriter writer)
                       throws IOException

Deprecated.

Throws:

IOException

renderProvider

protected void renderProvider(Context context,
                              Hit hit,
                              com.yahoo.text.XMLWriter writer)
                       throws IOException

Deprecated.

Renders /result/meta/provider. Uses renderProviderHitAttributes(Hit, XMLWriter) instead of the default renderHitAttributes(Hit, XMLWriter).

Throws:

IOException

See Also:

renderProviderHitAttributes(Hit, XMLWriter), renderProviderHitFields(Context, Hit, XMLWriter)

renderProviderHitAttributes

protected void renderProviderHitAttributes(Hit hit,
                                           com.yahoo.text.XMLWriter writer)
                                    throws IOException

Deprecated.

Specific hit attributes rendering for 'provider' meta hits under /result/meta.

Throws:

IOException

renderProviderHitFields

protected void renderProviderHitFields(Context context,
                                       Hit hit,
                                       com.yahoo.text.XMLWriter writer)
                                throws IOException

Deprecated.

Renders fields under /result/meta/provider.

Throws:

IOException

See Also:

renderProviderField(Context, Hit, java.util.Map.Entry, XMLWriter)

renderProviderField

protected void renderProviderField(Context context,
                                   Hit hit,
                                   Map.Entry<String,Object> entry,
                                   com.yahoo.text.XMLWriter writer)
                            throws IOException

Deprecated.

Renders one field under /result/meta/provider.

Throws:

IOException

asXML

private String asXML(Object value)

Deprecated.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object