com.bea.p13n.servlets.jsp.taglib
Class ContentQueryTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      com.bea.p13n.servlets.jsp.TagSupport
          com.bea.p13n.servlets.jsp.taglib.ContentTagSupport
              com.bea.p13n.servlets.jsp.taglib.ContentQueryTag

All Implemented Interfaces:

IterationTag, Serializable, Tag

public class ContentQueryTag

extends ContentTagSupport

The tag handler of the personalization jsp extension tag 'contentQuery'. The contentQuery tag allows arbitrary personalized content to be selected based on a content query.

See Also:

Serialized Form

Field Summary

protected String	home Deprecated. Not used any longer
protected long	max Limits the number of content items returned.
protected String	query A content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule.
protected String[]	searchPaths Search paths.
protected String	sortBy A list of document attributes to sort the content by.

Fields inherited from class com.bea.p13n.servlets.jsp.taglib.ContentTagSupport

cacheId, cacheScope, cacheTimeout, contextParams, useCache

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

id, pageContext

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

ContentQueryTag()

Method Summary

int	doStartTag() Processes the start tag.
String	getContentHome() Deprecated. Not used any more.
protected Node[]	getDocuments() Get the array of content documents.
String	getMax() Retrieves the max number of content items that can be returned.
String	getQuery() Gets the content query string that is appended as an 'and' phrase to the content query in the contentSelector rule.
protected AdviceRequest	getRequest() Returns a ContentQuery AdviceRequest object after populating the following fields The current HTTP Request The current HTTP Session The current User A new TimeInstant A new Time A new Date A CONTENT_QUERY_STRING A CONTENT_QUERY_MAX_ITEMS A CONTENT_QUERY_SORT_BY
String[]	getSearchPaths() Get the value of searchPaths.
String	getSortBy() Gets the list of document attributes to sort the content by.
void	release() Reinitializes the instance data in this object.
void	setContentHome(String aHome) Deprecated. Not used any more.
void	setMax(long l) Sets the max number of content items returned.
void	setMax(String aNumber) Sets the max number of content items returned.
void	setQuery(String aQuery) Sets the content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule.
void	setSearchPaths(String searchPaths) Set the value of searchPaths.
void	setSortBy(String anOrderbyClause) Sets the list of document attributes to sort the content by.

Methods inherited from class com.bea.p13n.servlets.jsp.taglib.ContentTagSupport

checkContentCache, getCacheId, getCacheScope, getCacheTimeout, getContextParams, getUseCache, initRepositoryManager, setCacheId, setCacheScope, setCacheTimeout, setCacheTimeout, setContextParams, setContextParams, setInContentCache, setUseCache, setUseCache

Methods inherited from class com.bea.p13n.servlets.jsp.TagSupport

createAdviceRequest, createAdvisor

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

doAfterBody, doEndTag, 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

Field Detail

home

protected String home

Deprecated. Not used any longer

The name of the content home bean. This maps to a JNDI name for the content home that handles a specific type of content and its provider.

max

protected long max

Limits the number of content items returned.

query

protected String query

A content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule.

searchPaths

protected String[] searchPaths

Search paths.

sortBy

protected String sortBy

A list of document attributes to sort the content by. The syntax follows the SQL 'order by' clause. The sort specification is limited to a list of the metadata attribute names and the keywords ASC and DESC.

Constructor Detail

ContentQueryTag

public ContentQueryTag()

Method Detail

doStartTag

public int doStartTag()
               throws JspException

Processes the start tag.

Returns:

The SKIP_BODY constant since this tag does not have a body.

Throws:

JspException - If the id variable is missing or if an error. occurrs during content retrieval.

getContentHome

public String getContentHome()

Deprecated. Not used any more.

Gets the name of the content home bean.

Returns:

The EJB Home name for the content manager bean.

getDocuments

protected Node[] getDocuments()
                       throws JspException

Get the array of content documents.

Returns:

An array of content objects found. Returns an empty array if none found.

Throws:

JspException

getMax

public String getMax()

Retrieves the max number of content items that can be returned.

Returns:

The max number of content items that can be returned.

getQuery

public String getQuery()

Gets the content query string that is appended as an 'and' phrase to the content query in the contentSelector rule.

Returns:

The query string.

getRequest

protected AdviceRequest getRequest()
                            throws JspException

Returns a ContentQuery AdviceRequest object after populating the following fields

• The current HTTP Request
• The current HTTP Session
• The current User
• A new TimeInstant
• A new Time
• A new Date
• A CONTENT_QUERY_STRING
• A CONTENT_QUERY_MAX_ITEMS
• A CONTENT_QUERY_SORT_BY

Returns:

A ContentQuery AdviceRequest.

Throws:

JspTagException - If there is a problem creating the request.

JspException

getSearchPaths

public String[] getSearchPaths()

Get the value of searchPaths.

getSortBy

public String getSortBy()

Gets the list of document attributes to sort the content by.

Returns:

The sortBy string.

release

public void release()

Reinitializes the instance data in this object.

Specified by:

release in interface Tag

Overrides:

release in class ContentTagSupport

setContentHome

public void setContentHome(String aHome)

Deprecated. Not used any more.

Sets the name of the content home bean.

Parameters:

aHome - The EJB Home name for the content manager bean.

setMax

public void setMax(long l)

Sets the max number of content items returned.

Parameters:

l - long representing a number.

setMax

public void setMax(String aNumber)

Sets the max number of content items returned.

Parameters:

aNumber - String representing a number. If it isn't a number, max is left at the default.

setQuery

public void setQuery(String aQuery)

Sets the content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule.

Parameters:

aQuery - The query string.

setSearchPaths

public void setSearchPaths(String searchPaths)

Set the value of searchPaths.

setSortBy

public void setSortBy(String anOrderbyClause)

Sets the list of document attributes to sort the content by.

Parameters:

anOrderbyClause - Designates how to sort the results.