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.impl.dynobject;

import java.util.ArrayList;

import java.util.LinkedHashMap;

import java.util.List;

import java.util.Map;

import org.gvsig.tools.dynobject.DynStruct;

import org.gvsig.tools.swing.api.dynobject.DynFieldModel;

import org.gvsig.tools.swing.api.dynobject.DynObjectModel;

/**

 * 

 * Abstract class that implements the basics of the DynObjectModel

 * implementation.

 * 

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

 *         gvSIG Team

 * @version $Id$

 * 

 */

public abstract class AbstractDynObjectModel implements DynObjectModel {

    private Map<String, List<DynFieldModel>> modelsList;

    protected DynStruct dynStruct;

        private List<String> compulsoryGroups;

    /**

     * Constructor.

     * 

     * @param dynStruct

     *            the current DynClass.

     * @param initAll

     * <br>

     *            &nbsp;&nbsp;&nbsp;&nbsp;<b>true</b>&nbsp;&nbsp;&nbsp;if we

     *            want to populate the Model with the default given values. <br>

     *            &nbsp;&nbsp;&nbsp;&nbsp;<b>false</b>&nbsp;&nbsp;if we want to

     *            get an empty DynObjectModel.

     */

    public AbstractDynObjectModel(DynStruct definition, boolean initAll) {

        this.dynStruct = definition;

                this.compulsoryGroups = new ArrayList<String>();

        this.modelsList = new LinkedHashMap<String, List<DynFieldModel>>();

                if (initAll) {

            initDynFieldModelList();

        }

    }

        public boolean isGroupCompulsory(String groupName) {

                return this.compulsoryGroups.contains(groupName);

        }

        /**

         * Creates a new DynFieldModel object with a default group set to "General"

         * and a field name set to the <b>fieldName</b> value, and returns the

         * created DynFieldModel.

         */

    public DynFieldModel add(String fieldName) {

        return add(this.getGenericLabel(), fieldName);

    }

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.api.dynobject.DynObjectComponentModel#add(org.gvsig

     * .tools.dynobject.DynField)

     */

    public DynFieldModel add(String group, String fieldName) {

        addGroup(group);

        if (fieldName != null) {

            DynFieldModel elem =

                createDynObjectModelElement(fieldName, dynStruct, group);

            List<DynFieldModel> list = getGroupElements(group);

            if (isNewElement(list, elem)) {

                list.add(list.size(), elem);

                                if (elem.getDynField().isMandatory()) {

                                        if (!this.compulsoryGroups.contains(group)) {

                                                compulsoryGroups.add(group);

                                        }

                                }

            }

            return elem;

        }

        return null;

    }

    public void addGroup(String group) {

        if (group == null){

            return;

        }

        if (!hasGroup(group)) {

            this.modelsList.put(group, new ArrayList<DynFieldModel>());

        }

    }

    /**

     * Creates a new DynFieldModel based on the following parameters:

     * 

     * @param fieldName

     *            a given field name.

     * @param definition

     *            a given DynClass.

     * @param group

     *            a given group name.

     * @return

     */

    protected abstract DynFieldModel createDynObjectModelElement(

        String fieldName, DynStruct definition, String group);

    /*

     * (non-Javadoc)

     * 

     * @see

     * org.gvsig.tools.swing.api.dynobject.DynObjectComponentModel#getFieldModel

     */

    public List<DynFieldModel> getGroupElements(String group) {

        return this.modelsList.get(group);

    }

    public String[] getGroups() {

        return this.modelsList.keySet().toArray(new String[0]);

    }

    /**

     * Determines if a given group name exists or not in the list.

     * 

     * @param group

     *            the group name.

     * @return<br>

     *             &nbsp;&nbsp;&nbsp;&nbsp;<b>true</b>&nbsp;&nbsp;&nbsp;there

     *             are DynModelElements for this DynObjectModel. <br>initDynFieldModelList

     *             &nbsp;&nbsp;&nbsp;&nbsp;<b>false</b>&nbsp;&nbsp;there are no

     *             DynModelElements for this DynObjectModel.

     */

    private boolean hasGroup(String group) {

        return this.modelsList.containsKey(group);

    }

    /**

     * Inits the list of DynFieldModels.

     */

    protected abstract void initDynFieldModelList();

    /**

     * 

     * Determines if the DynFieldModel is already in the List or not. If so,

     * it is not included again.

     * 

     * @param list

     *            the current list of DynFielModelElements

     * @param DynFieldModel

     *            the element to be verified.

     * @return

     *         true if it already exists, false otherwise.

     */

    private boolean isNewElement(List<DynFieldModel> list, DynFieldModel elem) {

        if ((list == null) || (elem == null)) {

            return false;

        }

        DynFieldModel item;

        for (int i = 0; i < list.size(); i++) {

            item = list.get(i);

            if (item.equals(elem)) {

                return false;

            }

        }

        return true;

    }

}