com.yahoo.prelude.templates

Class UserTemplate<T extends Writer>

java.lang.Object

com.yahoo.prelude.templates.GenericTemplateSet

com.yahoo.prelude.templates.UserTemplate<T>

Direct Known Subclasses:

DefaultTemplateSet, LogExceptionUserTemplateDelegator, TemplateSet

Deprecated.

use a renderer instead

@Deprecated
public abstract class UserTemplate<T extends Writer>
extends GenericTemplateSet

A wrapper for a template set, suitable for subclassing.

A subclass of UserTemplate must implement header(), footer(), hit(), hitFooter(), error() and noHits().

Author:

Steinar Knutsen

Field Summary

Fields

Modifier and Type	Field and Description
private static byte[]	ampersand Deprecated.
private static byte[]	greaterThan Deprecated.
private static byte[]	lessThan Deprecated.
private static Logger	log Deprecated.
private static byte[]	quotePrefix Deprecated.

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

DEFAULT_ENCODING, DEFAULT_MIMETYPE

Constructor Summary

Constructors

Constructor and Description
UserTemplate(String name) Deprecated.
UserTemplate(String name, String mimeType, String encoding) Deprecated. The signature of this constructor is the one which is invoked in a production setting.

Method Summary

Modifier and Type	Method and Description
Context	createContext() Deprecated. Creates a new context suitable for this template.
static void	dumpAndXMLQuoteUTF8(com.yahoo.io.ByteWriter writer, byte[] utf) Deprecated. Dump UTF-8 byte array to writer, but escape low ASCII codes except TAB, NL and CR, and escape ampersand, less than and greater than.
static boolean	dumpBytes(com.yahoo.io.ByteWriter writer, FastHit hit, String fieldName) Deprecated. If the field is available as a UTF-8 byte array, dump it to the writer.
abstract void	error(Context context, T writer) Deprecated. Render the error message for a result set.
abstract void	footer(Context context, T writer) Deprecated. Render the result set footer.
abstract void	header(Context context, T writer) Deprecated. Render the result set header.
abstract void	hit(Context context, T writer) Deprecated. Render a single top level hit.
abstract void	hitFooter(Context context, T writer) Deprecated. Render a footer for a single top level hit.
boolean	isDefaultTemplateSet() Deprecated. For internal use only TODO: get rid of this method *
abstract void	noHits(Context context, T writer) Deprecated. Invoked when the result set has no hits.
void	queryContext(Context context, T writer) Deprecated. Override this to add custom rendering for the query context of the result.
private static void	quoteByte(com.yahoo.io.ByteWriter writer, byte b) Deprecated.
T	wrapWriter(Writer writer) Deprecated. This is called once before each result is rendered using this template.

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, toString, wait, wait, wait

Field Detail

ampersand

private static final byte[] ampersand

Deprecated.

lessThan

private static final byte[] lessThan

Deprecated.

greaterThan

private static final byte[] greaterThan

Deprecated.

quotePrefix

private static final byte[] quotePrefix

Deprecated.

log

private static final Logger log

Deprecated.

Constructor Detail

UserTemplate

public UserTemplate(String name,
                    String mimeType,
                    String encoding)

Deprecated.

The signature of this constructor is the one which is invoked in a production setting.

UserTemplate

public UserTemplate(String name)

Deprecated.

Method Detail

wrapWriter

public T wrapWriter(Writer writer)

Deprecated.

This is called once before each result is rendered using this template. The returned writer is used in all subsequent calls. Use this if another (wrapper) writer of the raw incoming writer is desired in the implementation of this template. The class of the returned type must be given as a type argument to the template class, to be able to implement methods taking this wrapper writer as the argument type. This default implementation returns an XMLWriter.

createContext

public Context createContext()

Deprecated.

Creates a new context suitable for this template. The context may be reused for several evaluations, but not multiple concurrent evaluations

isDefaultTemplateSet

public boolean isDefaultTemplateSet()

Deprecated.

For internal use only TODO: get rid of this method *

header

public abstract void header(Context context,
                            T writer)
                     throws IOException

Deprecated.

Render the result set header.

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

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

footer

public abstract void footer(Context context,
                            T writer)
                     throws IOException

Deprecated.

Render the result set footer.

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

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

hit

public abstract void hit(Context context,
                         T writer)
                  throws IOException

Deprecated.

Render a single top level hit.

The result set is available in the context object under the name "result". The hit itself as "hit", the index of the hit as "hitno", and all the fields under their normal names.

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

hitFooter

public abstract void hitFooter(Context context,
                               T writer)
                        throws IOException

Deprecated.

Render a footer for a single top level hit. A typical implementation may do nothing.

The result set is available in the context object under the name "result". The hit itself as "hit", the index of the hit as "hitno", and all the fields under their normal names.

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

error

public abstract void error(Context context,
                           T writer)
                    throws IOException

Deprecated.

Render the error message for a result set.

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

Parameters:

context - wrapper which will contain, among other thing, main error and result set instances.

writer - the destination for rendering the hit

Throws:

IOException - may be propagated from the writer

noHits

public abstract void noHits(Context context,
                            T writer)
                     throws IOException

Deprecated.

Invoked when the result set has no hits.

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

Parameters:

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

writer - the destination for rendering the hit

Throws:

IOException - may be propagated from the writer

queryContext

public void queryContext(Context context,
                         T writer)
                  throws IOException

Deprecated.

Override this to add custom rendering for the query context of the result. Only called when the query context is present.

The result set is available in the context object under the name "result". The query context is retrieved from the result by calling result.getQuery.getContext(false)

Parameters:

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

writer - the destination for rendering the hit

Throws:

IOException - may be propagated from the writer

dumpAndXMLQuoteUTF8

public static void dumpAndXMLQuoteUTF8(com.yahoo.io.ByteWriter writer,
                                       byte[] utf)
                                throws IOException

Deprecated.

Dump UTF-8 byte array to writer, but escape low ASCII codes except TAB, NL and CR, and escape ampersand, less than and greater than.

It is presumed the writer is buffered (which is the case in normal result rendering), as the method may perform a large number of write operations.

public only for testing.

Throws:

IOException

dumpBytes

public static boolean dumpBytes(com.yahoo.io.ByteWriter writer,
                                FastHit hit,
                                String fieldName)
                         throws IOException

Deprecated.

If the field is available as a UTF-8 byte array, dump it to the writer.

Throws:

IOException

quoteByte

private static void quoteByte(com.yahoo.io.ByteWriter writer,
                              byte b)
                       throws IOException

Deprecated.

Throws:

IOException