ResultItem.java

/* Copyright (2012) Schibsted ASA
 *   This file is part of Possom.
 *
 *   Possom is free software: you can redistribute it and/or modify
 *   it under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation, either version 3 of the License, or
 *   (at your option) any later version.
 *
 *   Possom is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Lesser General Public License for more details.
 *
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with Possom.  If not, see <http://www.gnu.org/licenses/>.
 *
 * ResultItem.java
 *
 * Created on 10/05/2007, 12:56:22
 *
 */

package no.sesat.search.result;

import java.io.Serializable;
import java.util.Collection;

/**
 *
 *
 * @version $Id$
 */
public interface ResultItem extends Serializable{

    /** The URL this result item represents.
     *
     * @return
     */
    String getUrl();

    /** Sets the URL to the returned instance which is otherwise equal to this.
     * There is no guarantee that this instance is altered.
     * This allows implementations to be immutable if they choose to be.
     *
     * @param url
     * @return
     */
    ResultItem setUrl(String url);

    /** The title this result item represents.
     *
     * @return
     */
    String getTitle();

    /** Sets the title to the returned instance which is otherwise equal to this.
     * There is no guarantee that this instance is altered.
     * This allows implementations to be immutable if they choose to be.
     *
     * @param title
     * @return
     */
    ResultItem setTitle(String title);

    /**
     *
     * @param field
     * @return
     */
    String getField(String field);

    /** Adds the field to the returned instance which is otherwise equal to this.
     * There is no guarantee that this instance is altered.
     * This allows implementations to be immutable if they choose to be.
     *
     * Use addObjectField to add a non-html string into the result.
     *
     * @param name
     * @param value html formatted string. html to display must be escaped.
     * @return
     */
    ResultItem addField(String name, String value);

    /**
     *
     * @param field
     * @return
     */
    Serializable getObjectField(String field);

    /** Adds the field to the returned instance which is otherwise equal to this.
     * There is no guarantee that this instance is altered.
     * This allows implementations to be immutable if they choose to be.
     *
     * @param field
     * @param value
     * @return
     */
    ResultItem addObjectField(String field, Serializable value);


    /** An unmodifiable copy of the multivalued field collection.
     *
     * @param field
     * @return
     */
    public Collection<String> getMultivaluedField(String field);

    /** Adds (to the multivalued) field to the returned instance which is otherwise equal to this.
     * There is no guarantee that this instance is altered.
     * This allows implementations to be immutable if they choose to be.
     * @param field
     * @param value
     * @return
     */
    public ResultItem addToMultivaluedField(String field, String value);

    /** An unmodifiable list of the field names.
     *
     * @return
     */
    Collection<String> getFieldNames();
}