org.integratedmodelling.api.lang.INamespaceQualified 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.lang;

import org.integratedmodelling.api.modelling.INamespace;

/**
 * @author  Ferd
 */
public interface INamespaceQualified {

    /**
     * The namespace, which should be in the form of a dot-separated path
     * @return the namespace
     */
    abstract INamespace getNamespace();

    /**
     * The fully qualified name of the object. Must return getNamespace() + "." + getId()
     * @return the name for the object, including the namespace ID and the object local name.
     */
    abstract String getName();

    /*
     * we need this here and there. Hopefully remove soon.
     */
    @SuppressWarnings("javadoc")
    void setNamespace(INamespace namespace);
}