ICorrelationModelProvider.java

/* AWE - Amanzi Wireless Explorer
 * http://awe.amanzi.org
 * (C) 2008-2009, AmanziTel AB
 *
 * This library is provided under the terms of the Eclipse Public License
 * as described at http://www.eclipse.org/legal/epl-v10.html. Any use,
 * reproduction or distribution of the library constitutes recipient's
 * acceptance of this agreement.
 *
 * This library is distributed WITHOUT ANY WARRANTY; without even the
 * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

package org.amanzi.awe.correlation.provider;

import org.amanzi.awe.correlation.model.ICorrelationModel;
import org.amanzi.neo.models.exceptions.ModelException;
import org.amanzi.neo.models.measurement.IMeasurementModel;
import org.amanzi.neo.models.network.INetworkModel;
import org.amanzi.neo.providers.internal.INamedModelProvider;

/**
 * TODO Purpose of
 * <p>
 * </p>
 * 
 * @author Vladislav_Kondratenko
 * @since 1.0.0
 */
public interface ICorrelationModelProvider extends INamedModelProvider<ICorrelationModel, INetworkModel> {

    ICorrelationModel createCorrelationModel(INetworkModel networkModel, IMeasurementModel correlatedModel,
            String correlationPropertyName, String correlatedProperty) throws ModelException;

    ICorrelationModel findCorrelationModel(INetworkModel networkModel, IMeasurementModel correlatedModel,
            String correlationProperty, String correlatedProperty) throws ModelException;

    void removeModel(ICorrelationModel model) throws ModelException;
}