SearchResult.java

/*
 * Copyright (c) JForum Team
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms,
 * with or without modification, are permitted provided
 * that the following conditions are met:
 *
 * 1) Redistributions of source code must retain the above
 * copyright notice, this list of conditions and the
 * following  disclaimer.
 * 2)  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.
 * 3) Neither the name of "Rafael Steil" 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
 *
 * Created on 29/07/2007 23:57:58
 *
 * The JForum Project
 * http://www.jforum.net
 */
package net.jforum.entities.util;

import java.util.Iterator;
import java.util.List;

import net.jforum.entities.Post;
import net.jforum.security.RoleManager;

/**
 * @author Rafael Steil
 */
public class SearchResult extends PaginatedResult<Post> {
	public SearchResult(List<Post> results, int totalRecords) {
		super(results, totalRecords);
	}

	/**
	 * Apply security filters on the results
	 * FIXME the best approach would probably be to filter the documents directly in Lucene
	 * when they are being retrieved. Filtering here *may* mess up some records
	 * @param roleManager the set of roles to be used as filters
	 * @return the filtered data
	 */
	@SuppressWarnings("unchecked")
	public SearchResult filter(RoleManager roleManager) {
		for (Iterator<Post> iter = this.getResults().iterator(); iter.hasNext(); ) {
			Post post = iter.next();

			if (!roleManager.isForumAllowed(post.getForum().getId())) {
				iter.remove();
				this.totalRecords--;
			}
		}

		return this;
	}
}