IModelDelegate.java

/*
 * Chrysalix
 * See the COPYRIGHT.txt file distributed with this work for information
 * regarding copyright ownership.  Some portions may be licensed
 * to Red Hat, Inc. under one or more contributor license agreements.
 * See the AUTHORS.txt file in the distribution for a full listing of 
 * individual contributors.
 *
 * Chrysalix is free software. Unless otherwise indicated, all code in Chrysalix
 * is licensed to you under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * Chrysalix 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 GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.modelspace.ddl.relational;

import java.util.List;
import java.util.Map;

import org.modelspace.ModelspaceException;

/**
 * Interface for delegate Relational Models
 */
public interface IModelDelegate {

    /**
     * Get the model children
     * 
     * @return the children
     * @throws ModelspaceException
     *         if an error occurs
     */
    public List< RelationalObject > getChildren() throws ModelspaceException;

    /**
     * Get the model name
     * 
     * @return name
     */
    public String getName();

    /**
     * Get the namespace mappings if any
     * 
     * @return the prefix to uri mapping
     * @throws ModelspaceException
     *         if an error occurs
     */
    public Map< String, String > getNamespaceMap() throws ModelspaceException;

    /**
     * Determine if model has children
     * 
     * @return 'true' if has children, 'false' if not
     */
    public boolean hasChildren();

}