jahiasearcher.java

java 写的一个新闻发布系统

//
//                                   ____.
//                       __/\ ______|    |__/\.     _______
//            __   .____|    |       \   |    +----+       \
//    _______|  /--|    |    |    -   \  _    |    :    -   \_________
//   \\______: :---|    :    :           |    :    |         \________>
//           |__\---\_____________:______:    :____|____:_____\
//                                      /_____|
//
//                 . . . i n   j a h i a   w e   t r u s t . . .
//
//
//
//

package org.jahia.services.search;

import org.jahia.params.*;          		// ParamBean
import org.jahia.exceptions.*;
import org.jahia.data.search.JahiaSearchResult;


/**
 * Jahia Searcher interface.
 *
 * @author Khue Nguyen <a href="mailto:[e-mail]">[e-mail]</a>
 */

public abstract class JahiaSearcher {

	/**
	 * All available searcher names
	 */
	public static final String PAGE_SEARCHER 		= "PageSearcher";
	public static final String CONTAINER_SEARCHER 	= "ContainerSearcher";


	/**
	 * The last performed query.
	 */
	private String query;
	
	/**
	 * The last result.
	 */
	private Object result;

	//--------------------------------------------------------------------------
	/**
	 * Return the searcher name, i.e PAGE_SEARCHER, CONAINER_SEARCHER,...
	 *
	 * @return String name, the searcher name.
	 */
	public abstract String getName();

	//--------------------------------------------------------------------------
	/**
	 * Perform the search for a given query as String.
	 * Return the results as a Object instance.
	 *
	 * @param String query, a valid query.
	 * @param ParamBean jParams, the param bean.
	 * @return JahiaSearchResult result.
	 */
	public abstract JahiaSearchResult search(String query, ParamBean jParams)
	throws JahiaException;

	//--------------------------------------------------------------------------
	/**
	 * Return the last query performed by search(query) method call.
	 *
	 * @return Object the result, the result is an instance of JahiaSearchResult object.
	 */
	public String getQuery()
	{
		return this.query;
	}

	//--------------------------------------------------------------------------
	/**
	 * Set the last performed query.
	 *
	 * @param String query, the last performed query.
	 */
	protected void setQuery(String query)
	{
		this.query = query;
	}

	//--------------------------------------------------------------------------
	/**
	 * Return the results returned by the last search(query) method call.
	 *
	 * @return Object the result, the result is an instance of JahiaSearchResult object.
	 */
	public Object getResult()
	{
		return this.result;
	}

	//--------------------------------------------------------------------------
	/**
	 * Set the result.
	 *
	 * @param Object result, the result of the search result.
	 */
	void setResult(Object result)
	{
		this.result = result;
	}


}