@Deprecated public class TemplateSet<T extends Writer> extends UserTemplate<T>
A template set contains instances of the various templates required to render a result.
Normal usage is to create an instance and populate it with templates, but this class also supports subclassing to refine the behaviour, like returning different templates for different hit types.
Modifier and Type | Field and Description |
---|---|
private static DefaultTemplateSet |
defaultTemplateSet
Deprecated.
|
private static String |
queryContextTemplateName
Deprecated.
|
DEFAULT_ENCODING, DEFAULT_MIMETYPE
Constructor and Description |
---|
TemplateSet(String name,
String mimeType,
String encoding)
Deprecated.
Creates a template set containing no templates
|
Modifier and Type | Method and Description |
---|---|
void |
error(Context context,
T writer)
Deprecated.
Render the error message for a result set.
|
void |
footer(Context context,
T writer)
Deprecated.
Render the result set footer.
|
static UserTemplate<com.yahoo.text.XMLWriter> |
getDefault()
Deprecated.
Returns the default template set.
|
Template<T> |
getError(Result result)
Deprecated.
Returns the error body template
|
Template<T> |
getFooter(Result result)
Deprecated.
Returns the result footer template
|
Template<T> |
getHeader(Result result)
Deprecated.
Returns the result header template
|
Template<T> |
getHit(Hit resultHit)
Deprecated.
Returns the hit template
|
Template<T> |
getHitFooter(Hit hit)
Deprecated.
Returns the hit footer template
|
Template<T> |
getNohits(Result result)
Deprecated.
Returns the empty body template
|
Template<T> |
getQueryContext(Result result)
Deprecated.
|
void |
header(Context context,
T writer)
Deprecated.
Render the result set header.
|
void |
hit(Context context,
T writer)
Deprecated.
Render a single top level hit.
|
void |
hitFooter(Context context,
T writer)
Deprecated.
Render a footer for a single top level hit.
|
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.
|
void |
setError(Template<T> error)
Deprecated.
Sets the error template
|
void |
setFooter(Template<T> footer)
Deprecated.
Sets the footer template
|
void |
setHeader(Template<T> header)
Deprecated.
Sets the header template
|
void |
setHit(Template<T> hit)
Deprecated.
Sets the hit template
|
void |
setNohits(Template<T> nohits)
Deprecated.
Sets the nohits template
|
void |
setQueryContext(Template<T> template)
Deprecated.
|
String |
toString()
Deprecated.
|
createContext, dumpAndXMLQuoteUTF8, dumpBytes, isDefaultTemplateSet, wrapWriter
getBoldCloseTag, getBoldOpenTag, getEncoding, getMimeType, getName, getRequestedEncoding, getSeparatorTag, getSummaryClass, getTemplate, setHighlightTags, setSummaryClass, setTemplate, setTemplateNotNull
private static final String queryContextTemplateName
private static final DefaultTemplateSet defaultTemplateSet
public static UserTemplate<com.yahoo.text.XMLWriter> getDefault()
public Template<T> getHeader(Result result)
result
- the result which will use the templatepublic void setHeader(Template<T> header)
header
- the template to use for rendering getHeadersNullPointerException
- if the given template is nullpublic Template<T> getFooter(Result result)
result
- the result which will use the templatepublic void setFooter(Template<T> footer)
footer
- the template to use for rendering footersNullPointerException
- if the given template is nullpublic Template<T> getNohits(Result result)
result
- the result which will use the templatepublic Template<T> getQueryContext(Result result)
public void setQueryContext(Template<T> template)
template
- The template to be used for rendering query contexts, never null.public void setNohits(Template<T> nohits)
nohits
- the template to use for rendering empty resultsNullPointerException
- if the given template is nullpublic Template<T> getError(Result result)
result
- the result which will use the templatepublic void setError(Template<T> error)
error
- the template to use for rendering errorsNullPointerException
- if the given template is nullpublic Template<T> getHit(Hit resultHit)
resultHit
- the hit which will use the templatepublic void setHit(Template<T> hit)
hit
- the template to use for rendering hitsNullPointerException
- if the given template is nullpublic Template<T> getHitFooter(Hit hit)
hit
- the hit which will use the templatepublic void header(Context context, T writer) throws IOException
UserTemplate
The result set is available in the context object under the name "result".
header
in class UserTemplate<T extends Writer>
context
- wrapper which will contain, among other thing, the result
set instancewriter
- the destination for rendering the resultIOException
- may be propagated from the writerpublic void footer(Context context, T writer) throws IOException
UserTemplate
The result set is available in the context object under the name "result".
footer
in class UserTemplate<T extends Writer>
context
- wrapper which will contain, among other thing, the result
set instancewriter
- the destination for rendering the resultIOException
- may be propagated from the writerpublic void hit(Context context, T writer) throws IOException
UserTemplate
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.
hit
in class UserTemplate<T extends Writer>
context
- wrapper which will contain, among other thing, the hit
instancewriter
- the destination for rendering the hitIOException
- may be propagated from the writerpublic void error(Context context, T writer) throws IOException
UserTemplate
The result set is available in the context object under the name "result".
error
in class UserTemplate<T extends Writer>
context
- wrapper which will contain, among other thing, main error
and result set instances.writer
- the destination for rendering the hitIOException
- may be propagated from the writerpublic void hitFooter(Context context, T writer) throws IOException
UserTemplate
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.
hitFooter
in class UserTemplate<T extends Writer>
context
- wrapper which will contain, among other thing, the hit
instancewriter
- the destination for rendering the hitIOException
- may be propagated from the writerpublic void noHits(Context context, T writer) throws IOException
UserTemplate
The result set is available in the context object under the name "result".
noHits
in class UserTemplate<T extends Writer>
context
- wrapper which will contain, among other thing, the result
set instancewriter
- the destination for rendering the hitIOException
- may be propagated from the writerpublic void queryContext(Context context, T writer) throws IOException
UserTemplate
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)
queryContext
in class UserTemplate<T extends Writer>
context
- wrapper which will contain, among other things, the result
set instancewriter
- the destination for rendering the hitIOException
- may be propagated from the writerCopyright © 2017. All rights reserved.