ContentQueryTag Class
- 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.
-
Hierarchy
-
Object
TagSupport
TagSupport
ContentTagSupport
ContentQueryTag
-
All Implemented Interfaces
-
IterationTag
, Serializable
, Tag
protected String |
-
home
- The name of the content home bean.
|
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 |
-
sortBy
- A list of document attributes to sort the content by.
|
public int |
-
doStartTag ()
- Processes the start tag.
|
public String |
-
getContentHome ()
- Gets the name of the content home bean.
|
protected Node [] |
-
getDocuments ()
- Get the array of content documents.
|
public String |
-
getMax ()
- Retrieves the max number of content items that can be returned.
|
public 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
|
public String |
-
getSortBy ()
- Gets the list of document attributes to sort the content by.
|
public void |
-
release ()
- Reinitializes the instance data in this object.
|
public void |
-
setContentHome (String aHome)
- Sets the name of the content home bean.
|
public void |
-
setMax (String aNumber)
- Sets the max number of content items returned.
|
public void |
-
setMax (long l)
- Sets the max number of content items returned.
|
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.
|
public void |
-
setSortBy (String anOrderbyClause)
- Sets the list of document attributes to sort the content by.
|
Methods from com.bea.p13n.servlets.jsp.taglib.ContentTagSupport |
checkContentCache , getCacheId , getCacheScope , getCacheTimeout , getContextParams , getUseCache , initRepositoryManager , setCacheId , setCacheScope , setCacheTimeout , setCacheTimeout , setContextParams , setContextParams , setInContentCache , setUseCache , setUseCache
|
Methods from javax.servlet.jsp.tagext.TagSupport |
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue |
Methods from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
home
protected String
home
- 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.
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.
ContentQueryTag
public ContentQueryTag()
doStartTag() Method
public int doStartTag()
throws JspException
Processes the start tag.
-
Overrides
-
TagSupport.doStartTag()
Returns
- The SKIP_BODY constant since this tag does not have a body.
Exceptions
-
JspException
- If the id variable is missing or if an error.
occurrs during content retrieval.
getContentHome() Method
DEPRECATED Not used any more.
public String
getContentHome()
Gets the name of the content home bean.
Returns
- The EJB Home name for the content manager bean.
getDocuments() Method
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.
Exceptions
-
JspException
getMax() Method
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() Method
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() Method
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.
Exceptions
-
JspException
getSortBy() Method
public String
getSortBy()
Gets the list of document attributes to sort the content by.
Returns
- The sortBy string.
release() Method
public void release()
Reinitializes the instance data in this object.
-
Overrides
-
ContentTagSupport.release()
setContentHome(String) Method
DEPRECATED Not used any more.
public void setContentHome(String
aHome)
Sets the name of the content home bean.
Parameters
-
aHome
- The EJB Home name for the content manager bean.
setMax(String) Method
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.
setMax(long) Method
public void setMax(long l)
Sets the max number of content items returned.
Parameters
-
l
- long representing a number.
setQuery(String) Method
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.
setSortBy(String) Method
public void setSortBy(String
anOrderbyClause)
Sets the list of document attributes to sort the content by.
Parameters
-
anOrderbyClause
- Designates how to sort the results.