com.yahoo.search.result

Class Templating

java.lang.Object

com.yahoo.search.result.Templating

Deprecated.

do not use

@Deprecated
public class Templating
extends Object

Helper methods and data store for result attributes geared towards result rendering and presentation.

Author:

Steinar Knutsen

Field Summary

Fields

Modifier and Type	Field and Description
private com.yahoo.processing.rendering.Renderer<Result>	renderer Deprecated.
private Result	result Deprecated.

Constructor Summary

Constructors

Constructor and Description
Templating(Result result) Deprecated.

Method Summary

Modifier and Type	Method and Description
String	getCurrentResultURL() Deprecated.
int	getFirstHitNo() Deprecated. Returns The first hit presented in the result as an index into the global list of all hits generated by the user query.
int	getLastHitNo() Deprecated. Returns the number of the last result of the current hit page.
long	getNextFirstHitNo() Deprecated. Returns the first hit of the next result page, 0 if there aren't any more hits available
long	getNextLastHitNo() Deprecated. Returns the first hit of the next result page, 0 if there aren't any more hits available
String	getNextResultURL() Deprecated. An URL that may be used to obtain the next result page.
private String	getPath(com.yahoo.container.jdisc.HttpRequest request) Deprecated.
int	getPrevFirstHitNo() Deprecated. The first hit presented on the previous result page as an index into the global list of all hits generated by the user query
String	getPreviousResultURL() Deprecated. An URL that may be used to obtain the previous result page.
int	getPrevLastHitNo() Deprecated. The last hit presented on the previous result page as an index into the global list of all hits generated by the user query
com.yahoo.processing.rendering.Renderer<Result>	getRenderer() Deprecated. since 5.1.21, use Presentation.getRenderer()
UserTemplate	getTemplates() Deprecated. Returns the templates which will render the result.
private void	parameters(com.yahoo.container.jdisc.HttpRequest request, StringBuilder nextURL) Deprecated.
private void	parametersExceptOffset(com.yahoo.container.jdisc.HttpRequest request, StringBuilder nextURL) Deprecated.
void	setRenderer(com.yahoo.processing.rendering.Renderer<Result> renderer) Deprecated. since 5.1.21, use Presentation.setRenderer(com.yahoo.component.ComponentSpecification)
void	setTemplates(UserTemplate templates) Deprecated. Sets the template set which should render this result set
boolean	usesDefaultTemplate() Deprecated. For internal use only.

Methods inherited from class java.lang.Object

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

Field Detail

result

private final Result result

Deprecated.

renderer

private com.yahoo.processing.rendering.Renderer<Result> renderer

Deprecated.

Constructor Detail

Templating

public Templating(Result result)

Deprecated.

Method Detail

getFirstHitNo

public int getFirstHitNo()

Deprecated.

Returns The first hit presented in the result as an index into the global list of all hits generated by the user query.

getNextFirstHitNo

public long getNextFirstHitNo()

Deprecated.

Returns the first hit of the next result page, 0 if there aren't any more hits available

getNextLastHitNo

public long getNextLastHitNo()

Deprecated.

Returns the first hit of the next result page, 0 if there aren't any more hits available

getLastHitNo

public int getLastHitNo()

Deprecated.

Returns the number of the last result of the current hit page.

getPrevFirstHitNo

public int getPrevFirstHitNo()

Deprecated.

The first hit presented on the previous result page as an index into the global list of all hits generated by the user query

getPrevLastHitNo

public int getPrevLastHitNo()

Deprecated.

The last hit presented on the previous result page as an index into the global list of all hits generated by the user query

getNextResultURL

public String getNextResultURL()

Deprecated.

An URL that may be used to obtain the next result page.

getPreviousResultURL

public String getPreviousResultURL()

Deprecated.

An URL that may be used to obtain the previous result page.

getCurrentResultURL

public String getCurrentResultURL()

Deprecated.

getPath

private String getPath(com.yahoo.container.jdisc.HttpRequest request)

Deprecated.

parametersExceptOffset

private void parametersExceptOffset(com.yahoo.container.jdisc.HttpRequest request,
                                    StringBuilder nextURL)

Deprecated.

parameters

private void parameters(com.yahoo.container.jdisc.HttpRequest request,
                        StringBuilder nextURL)

Deprecated.

getTemplates

public UserTemplate getTemplates()

Deprecated.

Returns the templates which will render the result. This is never null. If default rendering is used, it is a TemplateSet containing no templates.

setTemplates

public void setTemplates(UserTemplate templates)

Deprecated.

Sets the template set which should render this result set

Parameters:

templates - the templates which should render this result, or null to use the default xml rendering

getRenderer

@Deprecated
public com.yahoo.processing.rendering.Renderer<Result> getRenderer()

Deprecated. since 5.1.21, use Presentation.getRenderer()

setRenderer

@Deprecated
public void setRenderer(com.yahoo.processing.rendering.Renderer<Result> renderer)

Deprecated. since 5.1.21, use Presentation.setRenderer(com.yahoo.component.ComponentSpecification)

usesDefaultTemplate

public boolean usesDefaultTemplate()

Deprecated.

For internal use only.