© 2002 BEA Systems, Inc.


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

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  java.lang.String home
          The name of the content home bean.
protected  long max
          Limits the number of content items returned.
protected  java.lang.String query
          A content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule.
protected  java.lang.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
 
Constructor Summary
ContentQueryTag()
           
 
Method Summary
 int doStartTag()
          Processes the start tag.
 java.lang.String getContentHome()
          Gets the name of the content home bean.
protected  Content[] getDocuments()
          Get the array of content documents.
 java.lang.String getMax()
          Retrieves the max number of content items that can be returned.
 java.lang.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 A CONTENT_MANAGER_HOME
 java.lang.String getSortBy()
          Gets the list of document attributes to sort the content by.
 void release()
          Reinitializes the instance data in this object.
 void setContentHome(java.lang.String aHome)
          Sets the name of the content home bean.
 void setMax(long l)
          Sets the max number of content items returned.
 void setMax(java.lang.String aNumber)
          Sets the max number of content items returned.
 void setQuery(java.lang.String aQuery)
          Sets the content query string that can be appended as an 'and' phrase to the content query in the contentSelector rule.
 void setSortBy(java.lang.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, getContentManager, getContextParams, getUseCache, 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

max

protected long max
Limits the number of content items returned.

sortBy

protected java.lang.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.

query

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

home

protected java.lang.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.
Constructor Detail

ContentQueryTag

public ContentQueryTag()
Method Detail

getMax

public java.lang.String getMax()
Retrieves the max number of content items that can be returned.

Returns:
The max number of content items that can be returned.

setMax

public void setMax(java.lang.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

public void setMax(long l)
Sets the max number of content items returned.

Parameters:
l - long representing a number.

setSortBy

public void setSortBy(java.lang.String anOrderbyClause)
Sets the list of document attributes to sort the content by.

Parameters:
anOrderbyClause - Designates how to sort the results.

getSortBy

public java.lang.String getSortBy()
Gets the list of document attributes to sort the content by.

Returns:
The sortBy string.

setQuery

public void setQuery(java.lang.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.

getQuery

public java.lang.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.

setContentHome

public void setContentHome(java.lang.String aHome)
Sets the name of the content home bean.

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

getContentHome

public java.lang.String getContentHome()
Gets the name of the content home bean.

Returns:
The EJB Home name for the content manager bean.

getDocuments

protected Content[] getDocuments()
                          throws JspException
Get the array of content documents.

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

getRequest

protected AdviceRequest getRequest()
                            throws JspException
Returns a ContentQuery AdviceRequest object after populating the following fields

Returns:
A ContentQuery AdviceRequest.
Throws:
JspTagException - If there is a problem creating the request.

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.
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport

release

public void release()
Reinitializes the instance data in this object.

Overrides:
release in class ContentTagSupport

© 2002 BEA Systems, Inc.

Copyright © 2002 BEA Systems, Inc. All Rights Reserved