Application: gvSIG desktop » Library: org.gvsig.tools

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 2

 * of the License, or (at your option) 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

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 

 * MA  02110-1301, USA.

 * 

 */

/*

 * AUTHORS (In addition to CIT):

 * 2010 Institute of New Imaging Technologies (INIT): 

 *   http://www.init.uji.es

 * Geographic Information research group: 

 *   http://www.geoinfo.uji.es

 * Universitat Jaume I, Spain

 */

/**

 * 

 */

package org.gvsig.tools.swing.api.dynobject;

import java.util.List;

import org.gvsig.tools.dynobject.DynField;

import org.gvsig.tools.dynobject.DynObject;

/**

 * 

 * The view model of a given {@link DynObject}. It allows to add

 * {@link DynField}s into different

 * view groups, by defining different {@link DynFieldModel}s.

 * 

 * @author 2010 - <a href="cordinyana@gvsig.org">C?sar Ordi?ana</a> - gvSIG Team

 * @author 2010 - <a href="mailto:reinhold@uji.es">Cristian Mart?n&nbsp;</a> -

 *         gvSIG Team

 * @version $Id$

 * 

 */

public interface DynObjectModel {

    /**

     * Creates a new {@link DynFieldModel} with the given <b>group</b> and

     * <b>fieldName</b>.

     * This {@link DynFieldModel} is then added to the list of

     * {@link DynFieldModel}s of this DynObjectModel

     * and then returned.

     * 

     * @param group

     *            the group name of the associated {@link DynField}. If null,

     *            the group name will be set to <b>"General"</b>.

     * @param fieldName

     *            the id name of the associated {@link DynField}.

     * @return

     *         the newly created {@link DynFieldModel} added to the list.

     */

    public DynFieldModel add(String group, String fieldName);

    /**

     * Creates a new {@link DynFieldModel} within the default "General"

     * <b>group</b>, but with the given <b>fieldName</b>.

     * This {@link DynFieldModel} is then added to the list of

     * {@link DynFieldModel}s of this DynObjectModel

     * and then returned.

     * 

     * @param fieldName

     *            the id name of the associated {@link DynField}.

     * @return

     *         the newly created {@link DynFieldModel} added to the list.

     */

    public DynFieldModel add(String fieldName);

    /**

     * Adds a group name to the {@link DynFieldModel}.

     * 

     * @param group

     *            the group name.

     */

    public void addGroup(String group);

    /**

     * Retrieves the list of {@link DynFieldModel}s based on the group name.

     * 

     * @param group

     *            the group name.

     * @return

     *         the list of {@link DynFieldModel}s.

     */

        public List<DynFieldModel> getGroupElements(String group);

    /**

     * Return an array of group names available for this {@link DynFieldModel}.

     * 

     * @return

     *         the array of group names.

     */

    public String[] getGroups();

        /**

         * Determines if a group contains compulsory fields or not

         * 

         * @param groupName

         *            the current groupName

         * 

         * @return if it has compulsory elements or not

         */

        public boolean isGroupCompulsory(String groupName);

        /**

         * Returns a generic label for this group

         * 

         * @return

         */

    public String getGenericLabel() ;

}