com.yahoo.prelude.templates

Class DefaultTemplateSet

java.lang.Object

com.yahoo.prelude.templates.GenericTemplateSet

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

com.yahoo.prelude.templates.DefaultTemplateSet

Direct Known Subclasses:

TiledTemplateSet

Deprecated.

use JsonRenderer instead

@Deprecated
public class DefaultTemplateSet
extends UserTemplate<com.yahoo.text.XMLWriter>

A template set which provides XML rendering of results and hits.

This can be extended to create custom programmatic templates. Create a subclass which has static inner classes extending DefaultTemplate for the templates you wish to override and call the set method for those templates in the subclass template set constructor. Some of the default templates contained utility functions, and can be overridden in place of DefaultTemplate to gain access to these. See TiledTemplateSet for an example.

Author:

bratseth

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.
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.

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

DEFAULT_ENCODING, DEFAULT_MIMETYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
	DefaultTemplateSet() Deprecated.
protected	DefaultTemplateSet(String name) Deprecated. Create a template set with a name.

Method Summary

Modifier and Type	Method and Description
void	error(Context context, com.yahoo.text.XMLWriter writer) Deprecated. Render the error message for a result set.
void	footer(Context context, com.yahoo.text.XMLWriter writer) Deprecated. Render the result set footer.
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. Render a single top level hit.
void	hitFooter(Context context, com.yahoo.text.XMLWriter writer) Deprecated. Render a footer for a single top level hit.
void	noHits(Context context, com.yahoo.text.XMLWriter writer) Deprecated. Invoked when the result set has no hits.
protected static void	renderCoverageAttributes(Coverage coverage, com.yahoo.text.XMLWriter writer) Deprecated.
protected void	renderField(Context context, Hit hit, Map.Entry<String,Object> entry, com.yahoo.text.XMLWriter writer) Deprecated.
protected void	renderFieldContent(Context context, Hit hit, String name, com.yahoo.text.XMLWriter writer) Deprecated.
protected void	renderGroup(HitGroup hit, com.yahoo.text.XMLWriter writer) Deprecated. Renders a hit group.
protected void	renderHitAttributes(Hit hit, com.yahoo.text.XMLWriter writer) Deprecated. Writes a hit's default attributes like 'type', 'source', 'relevancy'.
protected void	renderHitFields(Context context, Hit hit, com.yahoo.text.XMLWriter writer) Deprecated. Renders all fields of a hit.
protected void	renderHitGroup(HitGroup hit, Context context, com.yahoo.text.XMLWriter writer) Deprecated. Opens (but does not close) the group hit tag
protected void	renderHitGroupOfTypeGroupHit(Context context, HitGroup hit, com.yahoo.text.XMLWriter writer) Deprecated.
protected void	renderId(com.yahoo.net.URI uri, com.yahoo.text.XMLWriter writer) Deprecated.
private void	renderSimpleField(String fieldName, Object fieldValue, com.yahoo.text.XMLWriter writer) Deprecated.
private void	renderSyntheticRelevancyField(Hit hit, com.yahoo.text.XMLWriter writer) Deprecated.
private void	renderTime(com.yahoo.text.XMLWriter writer, Result result) Deprecated.
protected boolean	shouldRenderField(Hit hit, String fieldName) Deprecated. Returns whether a field should be rendered.
com.yahoo.text.XMLWriter	wrapWriter(Writer writer) Deprecated. Uses an XML writer in this template
private void	writeCloseFieldElement(com.yahoo.text.XMLWriter writer) Deprecated.
private void	writeOpenFieldElement(String fieldName, com.yahoo.text.XMLWriter writer) Deprecated.

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

Field Detail

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.

Constructor Detail

DefaultTemplateSet

protected DefaultTemplateSet(String name)

Deprecated.

Create a template set with a name. This will be initialized with the default templates - use the set methods from the subclass constructor to override any of these with other template classes.

DefaultTemplateSet

public DefaultTemplateSet()

Deprecated.

Method Detail

wrapWriter

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

Deprecated.

Uses an XML writer in this template

Overrides:

wrapWriter in class UserTemplate<com.yahoo.text.XMLWriter>

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".

Specified by:

header in class UserTemplate<com.yahoo.text.XMLWriter>

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

renderTime

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

Deprecated.

footer

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

Deprecated.

Description copied from class: UserTemplate

Render the result set footer.

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

Specified by:

footer in class UserTemplate<com.yahoo.text.XMLWriter>

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 void hit(Context context,
                com.yahoo.text.XMLWriter writer)
         throws IOException

Deprecated.

Description copied from class: UserTemplate

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.

Specified by:

hit in class UserTemplate<com.yahoo.text.XMLWriter>

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 void hitFooter(Context context,
                      com.yahoo.text.XMLWriter writer)
               throws IOException

Deprecated.

Description copied from class: UserTemplate

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.

Specified by:

hitFooter in class UserTemplate<com.yahoo.text.XMLWriter>

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 void error(Context context,
                  com.yahoo.text.XMLWriter writer)
           throws IOException

Deprecated.

Description copied from class: UserTemplate

Render the error message for a result set.

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

Specified by:

error in class UserTemplate<com.yahoo.text.XMLWriter>

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 void noHits(Context context,
                   com.yahoo.text.XMLWriter writer)
            throws IOException

Deprecated.

Description copied from class: UserTemplate

Invoked when the result set has no hits.

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

Specified by:

noHits in class UserTemplate<com.yahoo.text.XMLWriter>

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

renderCoverageAttributes

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

Deprecated.

Throws:

IOException

renderHitAttributes

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

Deprecated.

Writes a hit's default attributes like 'type', 'source', 'relevancy'.

Throws:

IOException

renderHitGroup

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

Deprecated.

Opens (but does not close) the group hit tag

Throws:

IOException

renderGroup

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

Deprecated.

Renders a hit group.

Throws:

IOException

renderHitGroupOfTypeGroupHit

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

Deprecated.

Throws:

IOException

renderId

protected void renderId(com.yahoo.net.URI uri,
                        com.yahoo.text.XMLWriter writer)
                 throws IOException

Deprecated.

Throws:

IOException

renderHitFields

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

Deprecated.

Renders all fields of a hit. Simply calls renderField(Context, Hit, java.util.Map.Entry, XMLWriter) for every field.

Throws:

IOException

renderSyntheticRelevancyField

private void renderSyntheticRelevancyField(Hit hit,
                                           com.yahoo.text.XMLWriter writer)
                                    throws IOException

Deprecated.

Throws:

IOException

renderField

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

Deprecated.

Throws:

IOException

writeOpenFieldElement

private void writeOpenFieldElement(String fieldName,
                                   com.yahoo.text.XMLWriter writer)
                            throws IOException

Deprecated.

Throws:

IOException

writeCloseFieldElement

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

Deprecated.

Throws:

IOException

renderFieldContent

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

Deprecated.

Throws:

IOException

renderSimpleField

private void renderSimpleField(String fieldName,
                               Object fieldValue,
                               com.yahoo.text.XMLWriter writer)
                        throws IOException

Deprecated.

Throws:

IOException

shouldRenderField

protected boolean shouldRenderField(Hit hit,
                                    String fieldName)

Deprecated.

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