com.jaeksoft.searchlib.renderer

Class Renderer

java.lang.Object

com.jaeksoft.searchlib.renderer.Renderer

All Implemented Interfaces:

Comparable<Renderer>

public class Renderer
extends Object
implements Comparable<Renderer>

Constructor Summary

Constructors

Constructor and Description
Renderer()
Renderer(Renderer source)
Renderer(XPathParser xpp)

Method Summary

Methods

Modifier and Type	Method and Description
void	addField(RendererField field)
void	addLogField(RendererLogField logField)
int	compareTo(Renderer o)
void	configureAuthRequest(AbstractSearchRequest searchRequest, javax.servlet.http.HttpServletRequest servletRequest)
void	copyTo(Renderer target)
void	fieldDown(RendererField field) Move field down
void	fieldUp(RendererField field) Move field up
String	getApiUrl()
String	getAuthDomain()
String	getAuthGroupAllowField()
String	getAuthGroupDenyField()
String	getAuthPassword()
String	getAuthPluginClass()
String	getAuthServer()
String	getAuthType()
String	getAuthUserAllowField()
String	getAuthUserDenyField()
String	getAuthUsername()
String	getAutocompletionName()
String	getContentTypeField()
String	getCss()
String	getFacetWidth()
List<RendererField>	getFields()
String	getFilenameField()
String	getFooter()
String	getHeader()
String	getHocrField()
String	getIFrameHtmlCode(String width, String height)
List<RendererLogField>	getLogFields()
String	getName()
String	getNoResultFoundText()
String	getOneResultFoundText()
String	getRequestName()
String	getResultFoundText(int resultsCount)
String	getResultsFoundText()
String	getSearchButtonLabel()
boolean	isLogEnabled()
void	removeField(RendererField field)
void	removeLogField(RendererLogField logField)
void	setAuthDomain(String authDomain)
void	setAuthGroupAllowField(String authGroupAllowField)
void	setAuthGroupDenyField(String authGroupDenyField)
void	setAuthPassword(String authPassword)
void	setAuthPluginClass(String authPluginClass)
void	setAuthServer(String authServer)
void	setAuthType(String authTypeName)
void	setAuthUserAllowField(String authUserAllowField)
void	setAuthUserDenyField(String authUserDenyField)
void	setAuthUsername(String authUsername)
void	setAutocompletionName(String autocompletionName)
void	setContentTypeField(String contentTypeField)
void	setCss(String css)
void	setDefaultCss()
void	setFacetWidth(String facetWidth)
void	setFilenameField(String filenameField)
void	setFooter(String footer)
void	setHeader(String header)
void	setHocrField(String hocrField)
void	setLogEnabled(boolean logReportEnabled)
void	setName(String name)
void	setNoResultFoundText(String noResultFoundText)
void	setOneResultFoundText(String oneResultFoundText)
void	setRequestName(String requestName)
void	setResultsFoundText(String resultsFoundText)
void	setSearchButtonLabel(String searchButtonLabel)
void	writeXml(XmlWriter xmlWriter)

Methods inherited from class java.lang.Object

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

Constructor Detail

Renderer

public Renderer()

Renderer

public Renderer(XPathParser xpp)
         throws ParserConfigurationException,
                SAXException,
                IOException,
                XPathExpressionException

Throws:

ParserConfigurationException

SAXException

IOException

XPathExpressionException

Renderer

public Renderer(Renderer source)

Method Detail

setDefaultCss

public void setDefaultCss()
                   throws SearchLibException

Throws:

SearchLibException

copyTo

public void copyTo(Renderer target)

addField

public void addField(RendererField field)

removeField

public void removeField(RendererField field)

fieldUp

public void fieldUp(RendererField field)

Move field up

Parameters:

field -

fieldDown

public void fieldDown(RendererField field)

Move field down

Parameters:

field -

getFields

public List<RendererField> getFields()

setName

public void setName(String name)

Parameters:

name - the name to set

getName

public String getName()

Returns:

the name

setRequestName

public void setRequestName(String requestName)

Parameters:

name - the requestName to set

getRequestName

public String getRequestName()

Returns:

the requestName

setSearchButtonLabel

public void setSearchButtonLabel(String searchButtonLabel)

Parameters:

searchButtonLabel - the searchButtonLabel to set

getSearchButtonLabel

public String getSearchButtonLabel()

Returns:

the searchButtonLabel

compareTo

public final int compareTo(Renderer o)

Specified by:

compareTo in interface Comparable<Renderer>

writeXml

public void writeXml(XmlWriter xmlWriter)
              throws SAXException

Throws:

SAXException

getApiUrl

public String getApiUrl()
                 throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getIFrameHtmlCode

public String getIFrameHtmlCode(String width,
                       String height)
                         throws UnsupportedEncodingException

Throws:

UnsupportedEncodingException

getResultsFoundText

public String getResultsFoundText()

setResultsFoundText

public void setResultsFoundText(String resultsFoundText)

getOneResultFoundText

public String getOneResultFoundText()

setOneResultFoundText

public void setOneResultFoundText(String oneResultFoundText)

getNoResultFoundText

public String getNoResultFoundText()

setNoResultFoundText

public void setNoResultFoundText(String noResultFoundText)

Parameters:

noResultFoundText -

getResultFoundText

public final String getResultFoundText(int resultsCount)

getFooter

public String getFooter()

Returns:

the footer

setFooter

public void setFooter(String footer)

Parameters:

footer - the footer to set

getHeader

public String getHeader()

Returns:

the header

setHeader

public void setHeader(String header)

Parameters:

header - the header to set

getFacetWidth

public String getFacetWidth()

Returns:

the facetWidth

setFacetWidth

public void setFacetWidth(String facetWidth)

Parameters:

facetWidth - the facetWidth to set

getCss

public String getCss()

Returns:

the css

setCss

public void setCss(String css)

Parameters:

css - the css to set

isLogEnabled

public boolean isLogEnabled()

setLogEnabled

public void setLogEnabled(boolean logReportEnabled)

addLogField

public void addLogField(RendererLogField logField)

removeLogField

public void removeLogField(RendererLogField logField)

getLogFields

public List<RendererLogField> getLogFields()

getContentTypeField

public String getContentTypeField()

Returns:

the contentTypeField

setContentTypeField

public void setContentTypeField(String contentTypeField)

Parameters:

contentTypeField - the contentTypeField to set

getFilenameField

public String getFilenameField()

Returns:

the filenameField

setFilenameField

public void setFilenameField(String filenameField)

Parameters:

filenameField - the filenameField to set

getHocrField

public String getHocrField()

Returns:

the hocrField

setHocrField

public void setHocrField(String hocrField)

Parameters:

hocrField - the hocrField to set

getAuthUsername

public String getAuthUsername()

Returns:

the authUsername

setAuthUsername

public void setAuthUsername(String authUsername)

Parameters:

authUsername - the authUsername to set

getAuthPassword

public String getAuthPassword()

Returns:

the authPassword

setAuthPassword

public void setAuthPassword(String authPassword)

Parameters:

authPassword - the authPassword to set

getAuthDomain

public String getAuthDomain()

Returns:

the authDomain

setAuthDomain

public void setAuthDomain(String authDomain)

Parameters:

authDomain - the authDomain to set

getAuthServer

public String getAuthServer()

Returns:

the authServer

setAuthServer

public void setAuthServer(String authServer)

Parameters:

authServer - the authServer to set

getAuthUserAllowField

public String getAuthUserAllowField()

Returns:

the authUserAllowField

setAuthUserAllowField

public void setAuthUserAllowField(String authUserAllowField)

Parameters:

authUserAllowField - the authUserAllowField to set

getAuthGroupAllowField

public String getAuthGroupAllowField()

Returns:

the authGroupAllowField

setAuthGroupAllowField

public void setAuthGroupAllowField(String authGroupAllowField)

Parameters:

authGroupAllowField - the authGroupAllowField to set

getAuthUserDenyField

public String getAuthUserDenyField()

Returns:

the authUserDenyField

setAuthUserDenyField

public void setAuthUserDenyField(String authUserDenyField)

Parameters:

authUserDenyField - the authUserDenyField to set

getAuthGroupDenyField

public String getAuthGroupDenyField()

Returns:

the authGroupDenyField

setAuthGroupDenyField

public void setAuthGroupDenyField(String authGroupDenyField)

Parameters:

authGroupDenyField - the authGroupDenyField to set

setAuthType

public void setAuthType(String authTypeName)

getAuthType

public String getAuthType()

configureAuthRequest

public void configureAuthRequest(AbstractSearchRequest searchRequest,
                        javax.servlet.http.HttpServletRequest servletRequest)
                          throws ParseException,
                                 IOException,
                                 SearchLibException

Throws:

ParseException

IOException

SearchLibException

getAuthPluginClass

public String getAuthPluginClass()

Returns:

the authPluginClass

setAuthPluginClass

public void setAuthPluginClass(String authPluginClass)

Parameters:

authPluginClass - the authPluginClass to set

getAutocompletionName

public String getAutocompletionName()

Returns:

the autocompletionName

setAutocompletionName

public void setAutocompletionName(String autocompletionName)

Parameters:

autocompletionName - the autocompletionName to set