org.eobjects.analyzer.descriptors.ResultDescriptor Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of AnalyzerBeans-api

Public API for component developers of AnalyzerBeans

The newest version!

/**
 * AnalyzerBeans
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program 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 this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.eobjects.analyzer.descriptors;

import java.io.Serializable;
import java.util.Set;

import org.eobjects.analyzer.result.AnalyzerResult;
import org.eobjects.analyzer.result.AnalyzerResultReducer;

/**
 * Descriptor of a {@link AnalyzerResult} object.
 */
public interface ResultDescriptor extends Serializable {

    /**
     * Gets the result class of this component.
     * 
     * @return the result class of this component.
     */
    public Class getResultClass();

    /**
     * Gets a result metric by name
     * 
     * @param name
     *            the name of the result metric
     * @return the result metric with the given name, or null if no such metric
     *         exist.
     */
    public MetricDescriptor getResultMetric(String name);

    /**
     * Gets the result metrics of this component's result
     * 
     * @return the result metrics of this component's result
     */
    public Set getResultMetrics();

    /**
     * Gets the {@link AnalyzerResultReducer} class of this component, if
     * available.
     * 
     * @return a reducer class, or null if none is available
     */
    public Class> getResultReducerClass();

}