/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

using System;

using Term = Lucene.Net.Index.Term;

namespace Lucene.Net.Search
{
	
	/// <summary> A Filter that restricts search results to values that have a matching prefix in a given
	/// field.
	/// </summary>
	[Serializable]
	public class PrefixFilter:MultiTermQueryWrapperFilter
	{
		
		public PrefixFilter(Term prefix):base(new PrefixQuery(prefix))
		{
		}
		
		public virtual Term GetPrefix()
		{
			return ((PrefixQuery) query).GetPrefix();
		}
		
		/// <summary>Prints a user-readable version of this query. </summary>
		public override System.String ToString()
		{
			System.Text.StringBuilder buffer = new System.Text.StringBuilder();
			buffer.Append("PrefixFilter(");
			buffer.Append(GetPrefix().ToString());
			buffer.Append(")");
			return buffer.ToString();
		}
	}
}