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

package org.apache.jetspeed.services.search;

import java.util.ArrayList;
import java.util.List;


/**
 * Container for search result entries
 *
 * @author <a href="mailto:taylor@apache.org">David Sean taylor</a>
 * @version $Id: SearchResults.java,v 1.3 2004/02/23 03:48:47 jford Exp $
 */
public class SearchResults
{
    private List results = null;

    /**
     */
    public SearchResults()
    {
        init(0);
    }

    /**
     * 
     * @param initialCapacity
     */
    public SearchResults(int initialCapacity)
    {
        init(initialCapacity);
    }

    /**
     * 
     * @param initialCapacity
     */
    private void init(int initialCapacity)
    {
        results = new ArrayList(initialCapacity);
    }

    /**
     * 
     * @param searchResult
     * @return 
     */
    public boolean add(ParsedObject searchResult)
    {
        return results.add(searchResult);
    }

    /**
     * 
     * @param index
     * @param searchResult
     */
    public void add(int index, ParsedObject searchResult)
    {
        results.add(index, searchResult);
        return;
    }

    /**
     * 
     * @param index
     * @return 
     */
    public ParsedObject get(int index)
    {
        return(ParsedObject) results.get(index);
    }

    /**
     * 
     * @return 
     */
    public int size()
    {
        return results.size();
    }

    /**
     * 
     * @return 
     */
    public List getResults()
    {
        return this.results;
    }
}
