org.integratedmodelling.engine.modelling.ScaleMediatorNull Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of klab-engine Show documentation
The newest version!
/*******************************************************************************
 *  Copyright (C) 2007, 2015:
 *  
 *    - Ferdinando Villa 
 *    - integratedmodelling.org
 *    - any other authors listed in @author annotations
 *
 *    All rights reserved. This file is part of the k.LAB software suite,
 *    meant to enable modular, collaborative, integrated 
 *    development of interoperable data and model components. For
 *    details, see http://integratedmodelling.org.
 *    
 *    This program is free software; you can redistribute it and/or
 *    modify it under the terms of the Affero General Public License 
 *    Version 3 or any later version.
 *
 *    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
 *    Affero General Public License for more details.
 *  
 *     You should have received a copy of the Affero General Public License
 *     along with this program; if not, write to the Free Software
 *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *     The license is also available at: https://www.gnu.org/licenses/agpl.html
 *******************************************************************************/
package org.integratedmodelling.engine.modelling;

import java.util.Map;

import org.integratedmodelling.api.knowledge.IProperty;
import org.integratedmodelling.api.metadata.IMetadata;
import org.integratedmodelling.api.modelling.IActiveDirectObservation;
import org.integratedmodelling.api.modelling.IScale;
import org.integratedmodelling.api.modelling.IState;
import org.integratedmodelling.engine.modelling.ScaleMediatorMetadata.ScaleMediatorTag;
import org.integratedmodelling.exceptions.KlabResourceNotFoundException;
import org.integratedmodelling.exceptions.KlabUnsupportedOperationException;

/**
 * pass-through interpolation - don't do any translation; only expose the original scale.
 * 
 * @author luke
 * 
 */
public class ScaleMediatorNull extends ScaleMediator {

    protected static final IMetadata metadata = new ScaleMediatorMetadata(ScaleMediatorTag.oneDimensional,
                                                      ScaleMediatorTag.twoDimensional, ScaleMediatorTag.threeDimensional,
                                                      ScaleMediatorTag.arbitraryDimensions);

    public ScaleMediatorNull(IActiveDirectObservation subject, ObservationController controller)
            throws KlabResourceNotFoundException {
        super(subject, controller);
    }

    @Override
    protected IState getStateForTargetScale(SubjectObservation observation, IProperty property,
            IScale targetScale) throws KlabUnsupportedOperationException {
        // has the output scale been generated for this observation yet?
        if (!targetScale.equals(subject.getScale())) {
            throw new KlabUnsupportedOperationException("Cannot use " + this.getClass().getSimpleName()
                    + " to do scale mediation (target scale must match subject).");
        }

        Map resultMap = observation.outputStates.get(targetScale);
        if (resultMap == null) {
            generateTargetScale(observation, targetScale);
            resultMap = observation.outputStates.get(targetScale);
        }

        return resultMap.get(property);
    }

    @Override
    protected Map generateTargetScale(SubjectObservation observation,
            IScale targetScale) throws KlabUnsupportedOperationException {
        Map result = observation.agentStateNode.getAgentState().getStates();
        observation.outputStates.put(targetScale, result);
        return result;
    }
}