package org.apache.lucene.search;

/**
 * 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.
 */

import org.apache.lucene.search.BooleanClause.Occur;

/**
 * A Filter that wrapped with an indication of how that filter
 * is used when composed with another filter.
 * (Follows the boolean logic in BooleanClause for composition 
 * of queries.)
 * @author BPDThebault
 */

public class FilterClause implements java.io.Serializable
{
	Occur occur = null;
	Filter filter = null;

	/**
	 * Create a new FilterClause
	 * @param filter A Filter object containing a BitSet
	 * @param occur A parameter implementation indicating SHOULD, MUST or MUST NOT
	 */
	
	public FilterClause( Filter filter,Occur occur)
	{
		this.occur = occur;
		this.filter = filter;
	}

	/**
	 * Returns this FilterClause's filter
	 * @return A Filter object
	 */
	
	public Filter getFilter()
	{
		return filter;
	}

	/**
	 * Returns this FilterClause's occur parameter
	 * @return An Occur object
	 */
	
	public Occur getOccur()
	{
		return occur;
	}

}