querytag.java

Jive 是一个系统工程

/**
 * $Header: /home/coolserv/.cvs/coolserv/jive/source/taglib/com/coolservlets/forum/tags/QueryTag.java,v 1.3 2000/12/15 13:50:20 gnielsen Exp $
 * $Revision: 1.3 $
 * $Date: 2000/12/15 13:50:20 $
 *
 * Copyright (C) 2000 CoolServlets.com. All rights reserved.
 *
 * ===================================================================
 * The Apache Software License, Version 1.1
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by
 *        CoolServlets.com (http://www.coolservlets.com)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Jive" and "CoolServlets.com" must not be used to
 *    endorse or promote products derived from this software without
 *    prior written permission. For written permission, please
 *    contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Jive",
 *    nor may "Jive" appear in their name, without prior written
 *    permission of CoolServlets.com.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL COOLSERVLETS.COM OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of CoolServlets.com. For more information
 * on CoolServlets.com, please see <http://www.coolservlets.com>.
 */

package com.coolservlets.forum.tags;

import java.io.*;
import java.util.*;
import javax.servlet.*;
import javax.servlet.jsp.*;
import javax.servlet.jsp.tagext.*;
import javax.servlet.http.*;
import com.coolservlets.forum.tags.*;

/**
 * JSP Tag <b>query</b>, used to set forum message query properties
 * and values which are used by the <b>message_loop</b>
 * tag to determine what messages to select.
 * <p>
 * Requires that attribute <b>id</b> be set to the name of a
 * script variable for later use in the JSP by the <b>message_loop</b>
 * tag.
 * <p>
 * The name of the query property must be set using the
 * <b>property</b> attribute.
 * The body of the <b>query</b> tag is used as the value of the
 * query propperty.
 * <p>
 * Multiple query properties can be set by reusing
 * the <b>query</b> with the same <b>id</b>.
 * The query properties you can set are the <b>queryString</b> as a string,
 * <b>beforeDate</b> as a long, <b>afterDate</b> as a long, and
 * <b>userID</b> as an int.
 * <p>
 * JSP Tag Lib Descriptor
 * <p><pre>
 *  &lt;name&gt;query&lt;/name&gt;
 *  &lt;tagclass&gt;com.coolservlets.forum.tags.QueryTag&lt;/tagclass&gt;
 *  &lt;bodycontent&gt;JSP&lt;/bodycontent&gt;
 *  &lt;info&gt;Create a query to use for selecting forum messages&lt;/info&gt;
 *  &lt;attribute&gt;
 *    &lt;name&gt;id&lt;/name&gt;
 *    &lt;required&gt;true&lt;/required&gt;
 *    &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
 *  &lt;/attribute&gt;
 *  &lt;attribute&gt;
 *    &lt;name&gt;property&lt;/name&gt;
 *    &lt;required&gt;true&lt;/required&gt;
 *    &lt;rtexprvalue&gt;false&lt;/rtexprvalue&gt;
 *  &lt;/attribute&gt;
 * </pre>
 *
 * @author Glenn Nielsen
 */
public class QueryTag extends BodyTagSupport
{
  private String property = null;
  private Map query = new HashMap();

  /**
   * Always include the body so it can be used as the query
   * property value.
   *
   * @return EVAL_BODY_TAG
   */
  public final int doStartTag() throws JspException
  {
    return EVAL_BODY_TAG;
  }

  /**
   * Use the body of the tag as the value for a query property
   *
   * @return SKIP_BODY
   */
  public final int doAfterBody() throws JspException
  {
    // Use the body of the tag as the value for a query property
    BodyContent body = getBodyContent();
    String s = body.getString();
    // Clear the body since we use the tag body as the value for a query property
    body.clearBody();

    // Add to previous query tag if it exists
    QueryTag qt =
      (QueryTag)pageContext.getAttribute(id,PageContext.PAGE_SCOPE);
    if( qt != null ) {
      qt.addQuery(property,s);
    } else { // Creating a new query tag
      addQuery(property,s);
      query.put(property,(Object)s);
      pageContext.setAttribute(id,this,PageContext.PAGE_SCOPE);
    }
    return SKIP_BODY;
  }

  /**
   * Set name of query property to add
   */
  public final void setProperty(String str)
  {
    property = str;
  }

  /**
   * Add a query property/value pair
   */
  public final void addQuery(String prop, String value)
  {
    query.put(prop,(Object)value);
  }

  /**
   * Return the query HashMap
   *
   * @return Map of query property/value pairs
   */
  public final Map getQuery()
  {
    return query;
  }
}