Package org.opencms.jsp

Class CmsJspTagSearch

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.opencms.jsp.CmsJspScopedVarBodyTagSuport

org.opencms.jsp.CmsJspTagSearch

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, I_CmsCollectorPublishListProvider

public class CmsJspTagSearch
extends CmsJspScopedVarBodyTagSuport
implements I_CmsCollectorPublishListProvider

This tag is used to easily create a search form for a Solr search within a JSP.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CONTENTINFO_ROWS	Default number of items which are checked for change for the "This page" publish dialog.
protected CmsObject	m_cms	The CmsObject for the current user.
protected CmsFlexController	m_controller	The FlexController for the current request.

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
CmsJspTagSearch()	Empty constructor, required for JSP tags.

Method Summary

Modifier and Type	Method	Description
int	doEndTag()
int	doStartTag()
Object	getConfigFile()	Get the value of the specified configuration file (given via the tag's "configFile" attribute).
String	getConfigString()	Getter for the "configString".
String	getFileFormat()	Get the value of the specified format of the configuration file (given via the tag's "fileFormat" attribute).
Set<CmsResource>	getPublishResources(CmsObject cms, I_CmsContentLoadCollectorInfo info)	Gets the publish list for the collector.
static Set<CmsResource>	getPublishResourcesInternal(CmsObject cms, I_CmsContentLoadCollectorInfo info)
protected void	init()	Initializes this formatter tag.
void	release()
void	setAddContentInfo(Boolean doAddInfo)	Setter for "addContentInfo", indicating if content information should be added.
void	setConfigFile(Object fileName)	Setter for the configuration file.
void	setConfigString(String configString)	Setter for the "configString".
void	setContentInfoMaxItems(Integer maxItems)	Setter for "contentInfoMaxItems".
void	setFileFormat(String fileFormat)	Setter for the file format.
void	setIgnoreSearchExclude(Boolean ignoreSearchExclude)	Setter for the "ignoreSearchExclude".

Methods inherited from class org.opencms.jsp.CmsJspScopedVarBodyTagSuport

getScope, getScopeAsInt, getScopeAsString, getScopeInt, getVar, isScopeVarSet, setScope, setVar, storeAttribute, storeAttribute

Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Details

DEFAULT_CONTENTINFO_ROWS

public static final int DEFAULT_CONTENTINFO_ROWS

Default number of items which are checked for change for the "This page" publish dialog.

See Also:

• Constant Field Values

m_cms

protected transient CmsObject m_cms

The CmsObject for the current user.

m_controller

protected CmsFlexController m_controller

The FlexController for the current request.

Constructor Details

CmsJspTagSearch

public CmsJspTagSearch()

Empty constructor, required for JSP tags.

Method Details

getPublishResourcesInternal

public static Set<CmsResource> getPublishResourcesInternal(CmsObject cms,
 I_CmsContentLoadCollectorInfo info)
                                                    throws CmsException

Throws:

CmsException

See Also:

• I_CmsCollectorPublishListProvider.getPublishResources(org.opencms.file.CmsObject, org.opencms.gwt.shared.I_CmsContentLoadCollectorInfo)

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

See Also:

• BodyTagSupport.doEndTag()

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException,
CmsIllegalArgumentException

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

CmsIllegalArgumentException

See Also:

• Tag.doStartTag()

getConfigFile

public Object getConfigFile()

Get the value of the specified configuration file (given via the tag's "configFile" attribute).

Returns:

The config file.

getConfigString

public String getConfigString()

Getter for the "configString".

Returns:

The "configString".

getFileFormat

public String getFileFormat()

Get the value of the specified format of the configuration file (given via the tag's "fileFormat" attribute).

Returns:

The file format.

getPublishResources

public Set<CmsResource> getPublishResources(CmsObject cms,
 I_CmsContentLoadCollectorInfo info)
                                     throws CmsException

Description copied from interface: I_CmsCollectorPublishListProvider

Gets the publish list for the collector.

Specified by:

getPublishResources in interface I_CmsCollectorPublishListProvider

Parameters:

cms - the CMS context to use

info - the collector information

Returns:

the resources to include in the publish list

Throws:

CmsException - if soemthing goes wrong

See Also:

• I_CmsCollectorPublishListProvider.getPublishResources(org.opencms.file.CmsObject, org.opencms.gwt.shared.I_CmsContentLoadCollectorInfo)

release

public void release()

Specified by:

release in interface javax.servlet.jsp.tagext.Tag

Overrides:

release in class CmsJspScopedVarBodyTagSuport

See Also:

• Tag.release()

setAddContentInfo

public void setAddContentInfo(Boolean doAddInfo)

Setter for "addContentInfo", indicating if content information should be added.

Parameters:

doAddInfo - The value of the "addContentInfo" attribute of the tag

setConfigFile

public void setConfigFile(Object fileName)

Setter for the configuration file.

Parameters:

fileName - Name of the configuration file to use for the search.

setConfigString

public void setConfigString(String configString)

Setter for the "configString".

Parameters:

configString - The "configString".

setContentInfoMaxItems

public void setContentInfoMaxItems(Integer maxItems)

Setter for "contentInfoMaxItems".

Parameters:

maxItems - number of items to maximally check for alterations.

setFileFormat

public void setFileFormat(String fileFormat)

Setter for the file format.

Parameters:

fileFormat - File format the configuration file is in.

setIgnoreSearchExclude

public void setIgnoreSearchExclude(Boolean ignoreSearchExclude)

Setter for the "ignoreSearchExclude".

Parameters:

ignoreSearchExclude - The "ignoreSearchExclude".

init

protected void init()
             throws javax.servlet.jsp.JspException

Initializes this formatter tag.

Throws:

javax.servlet.jsp.JspException - in case something goes wrong