/*
 *  @(#)SearchQuery.java
 *
 *  Copyright (c) 2002-2003, Erik C. Thauvin (erik@thauvin.net)
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are
 *  met:
 *
 *  Redistributions of source code must retain the above copyright notice,
 *  this list of conditions and the following disclaimer.
 *
 *  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.
 *
 *  Neither the name of the author nor the names of its contributors may be
 *  used to endorse or promote products derived from this software without
 *  specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 *  IS" AND ANY EXPRESS 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 THE COPYRIGHT OWNER OR
 *  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.
 *
 *  $Id$
 *
 */
package net.thauvin.google.taglibs;

import net.thauvin.google.TagUtility;


/**
 * A custom tag used to retrieve the query string of a Google search.
 *
 * @author Erik C. Thauvin
 * @created April 29, 2002
 * @version $Revision$, $Date$
 * @since 1.0
 */
public class SearchQuery extends SearchResultSupport
{
	private String type = null;

	/**
	 * Sets the type attribute.
	 *
	 * @param type The new attribute value.
	 * @since 1.0.1
	 */
	public final void setType(String type)
	{
		this.type = type;
	}

	/**
	 * Release method.
	 */
	public void release()
	{
		super.release();

		type = null;
	}

	/**
	 * Returns the property provided by this tag.
	 *
	 * @return The property name.
	 */
	protected String getPropertyName()
	{
		if (TagUtility.isValidString(type) && type.equalsIgnoreCase("full"))
		{
			return "searchQuery";
		}

		return "searchKeywords";
	}

	/**
	 * Returns the name of this tag.
	 *
	 * @return The tag name.
	 */
	protected String getTagName()
	{
		return "searchQuery";
	}
}
