org.integratedmodelling.api.modelling.IModifiableUnit Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of klab-api Show documentation
The newest version!
/*******************************************************************************
 *  Copyright (C) 2007, 2014:
 *  
 *    - 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.api.modelling;

import org.integratedmodelling.exceptions.KlabValidationException;

/**
 * Modifiable units admit a modifier after @ to localize them somewhere in time or space. For now
 * the only ones are currencies, which admit a time after the modifier so we can convert say
 * USD@2003 into EUR@2005.
 * 
 * @author Ferd
 *
 */
public interface IModifiableUnit extends IUnit {

    /**
     * @param modifier
     * @throws KlabValidationException
     */
    public abstract void validateModifier(String modifier) throws KlabValidationException;

    /**
     * @param to
     * @param modFrom
     * @param modTo
     * @return result of conversion through modifiers
     * @throws KlabValidationException
     */
    public abstract double convert(IModifiableUnit to, String modFrom, String modTo)
            throws KlabValidationException;

}