IStatisticsProvider.java

/*******************************************************************************
 * Copyright (c) 2008 Cambridge Semantics Incorporated.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * File:        $Source$
 * Created by:  Matthew Roy ( <a href="mailto:mroy@cambridgesemantics.com">mroy@cambridgesemantics.com </a>)
 * Created on:  Aug 26, 2008
 * Revision:	$Id$
 * 
 * Contributors:
 *     Cambridge Semantics Incorporated - initial API and implementation
 *******************************************************************************/
package org.openanzo.services;


/**
 * @author Matthew Roy ( <a href="mailto:mroy@cambridgesemantics.com">mroy@cambridgesemantics.com</a>)
 * 
 */
public interface IStatisticsProvider {
    /**
     * Get the StatisticsObject for this component
     * 
     * @return Statistics Object for this component
     */
    public abstract DynamicServiceStats getStatistics();

    /**
     * Get the unique name for this stats provider
     * 
     * @return Name for the stats provider
     */
    public abstract String getName();

    /**
     * Get the description of this IStatisticsProvider
     * 
     * @return Description for the stats provider
     */
    public abstract String getDescription();
}