package org.apache.lucene.search.highlight;

/**
 * Copyright 2002-2004 The Apache Software Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Simple {@link Formatter} implementation to highlight terms with a pre and
 * post tag
 * 
 * @author MAHarwood
 */
public class SimpleHTMLFormatter implements Formatter
{
	String preTag;

	String postTag;

	public SimpleHTMLFormatter(String preTag, String postTag)
	{
		this.preTag = preTag;
		this.postTag = postTag;
	}

	/**
	 * Default constructor uses HTML: &lt;B&gt; tags to markup terms
	 */
	public SimpleHTMLFormatter()
	{
		this.preTag = "<B>";
		this.postTag = "</B>";
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.apache.lucene.search.highlight.Formatter#highlightTerm(java.lang.String,
	 *      org.apache.lucene.search.highlight.TokenGroup)
	 */
	public String highlightTerm(String originalText, TokenGroup tokenGroup)
	{
		StringBuffer returnBuffer;
		if (tokenGroup.getTotalScore() > 0)
		{
			returnBuffer = new StringBuffer();
			returnBuffer.append(preTag);
			returnBuffer.append(originalText);
			returnBuffer.append(postTag);
			return returnBuffer.toString();
		}
		return originalText;
	}
}
