SearchResult.java

/*
 * Carrot2 project.
 *
 * Copyright (C) 2002-2016, Dawid Weiss, Stanisław Osiński.
 * All rights reserved.
 *
 * Refer to the full license file "carrot2.LICENSE"
 * in the root folder of the repository checkout or at:
 * http://www.carrot2.org/carrot2.LICENSE
 */

package org.carrot2.workbench.core.ui;

import java.util.List;
import java.util.concurrent.CopyOnWriteArrayList;

import org.carrot2.core.Controller;
import org.carrot2.core.ProcessingResult;

/**
 * Search process model is the core model around which all other views revolve (editors,
 * views, actions). It can perform transformation of {@link SearchInput} into a
 * {@link ProcessingResult} and inform its listeners about changes going on in the model.
 */
public final class SearchResult
{
    /**
     * Input for this result.
     */
    private final SearchInput input;

    /**
     * Processing result from a {@link Controller}, associated with {@link #input}.
     */
    private ProcessingResult result;

    /**
     * An array of listeners interested in events happening on this search result.
     */
    private List<ISearchResultListener> listeners = new CopyOnWriteArrayList<ISearchResultListener>();

    /**
     * 
     */
    public SearchResult(SearchInput input)
    {
        this.input = input;
    }

    /*
     * 
     */
    public SearchInput getInput()
    {
        return input;
    }

    /**
     * Update {@link ProcessingResult} associated with this object, notifying all
     * interested listeners.
     */
    void setProcessingResult(ProcessingResult result)
    {
        this.result = result;
        fireProcessingResultUpdated();
    }

    /**
     * Returns the current processing result or <code>null</code> if not available.
     */
    public ProcessingResult getProcessingResult()
    {
        return this.result;
    }

    /*
     * 
     */
    public void addListener(ISearchResultListener listener)
    {
        this.listeners.add(listener);
    }

    /*
     * 
     */
    public void removeListener(ISearchResultListener listener)
    {
        this.listeners.remove(listener);
    }

    /**
     * Asynchronously fire processing results updated event.
     */
    private void fireProcessingResultUpdated()
    {
        for (ISearchResultListener listener : listeners)
            listener.beforeProcessingResultUpdated();

        for (ISearchResultListener listener : listeners)
            listener.processingResultUpdated(result);

        for (ISearchResultListener listener : listeners)
            listener.afterProcessingResultUpdated();
    }

    /**
     * Check if processing result is not null.
     */
    public boolean hasProcessingResult()
    {
        return getProcessingResult() != null;
    }
}