path: root/wizards/com/sun/star/wizards/common/ConfigSet.java

/*************************************************************************
 *
 *  $RCSfile: ConfigSet.java,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: kz $  $Date: 2004-05-19 12:35:40 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library 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 library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 */
package com.sun.star.wizards.common;

import java.util.*;

import javax.swing.ListModel;
import javax.swing.event.ListDataEvent;


import org.w3c.dom.*;

/**
 *
 * @author  rpiterman
 */
public class ConfigSet implements ConfigNode, XMLProvider, ListModel {
    private Class childClass;
    private Map childrenMap = new HashMap();
    private List childrenList = new Vector();
    public Object root;

    /**
     * After reading the configuration set items,
     * the ConfigSet checks this field.
     * If it is true, it will remove any nulls from
     * the vector.
     * subclasses can change this field in the constructor
     * to avoid this "deletion" of nulls.
     */
    protected boolean noNulls = true;

    /** Utility field used by event firing mechanism. */
    private javax.swing.event.EventListenerList listenerList = null;

    public ConfigSet(Class childType) {
        childClass = childType;
    }

    public void add(String name, Object child) {
        childrenMap.put(name, child);
        try {
            int i = ((Indexable) child).getIndex();
            int oldSize = getSize();
            while (getSize() <= i)
                childrenList.add(null);
            childrenList.set(i, child);
            if (oldSize > i)
                oldSize = i;
            fireListDataListenerIntervalAdded(oldSize, i);
        } catch (ClassCastException cce) {
            childrenList.add(child);
            fireListDataListenerIntervalAdded(getSize() - 1, getSize() - 1);
        }
    }

    public void add(int i, Object o) {
        int name = i;
        while (getElement("" + name) != null)
            name++;

        childrenMap.put("" + name, o);
        childrenList.add(i, o);

        fireListDataListenerIntervalAdded(i, i);
    }

    protected Object createChild() throws InstantiationException, IllegalAccessException {
        return childClass.newInstance();
    }

    public void writeConfiguration(Object configView, Object param) {
        Object[] names = childrenMap.keySet().toArray();

        if (ConfigNode.class.isAssignableFrom(childClass)) {
            String children[] = Configuration.getChildrenNames(configView);
            for (int i = 0; i<children.length; i++)
                  try {
                      Configuration.removeNode(configView,children[i]);
                  }
                  catch (Exception ex) {
                      ex.printStackTrace();
                  }


            for (int i = 0; i < names.length; i++) {
                try {
                    ConfigNode child = (ConfigNode) getElement(names[i]);
                    Object childView = Configuration.addConfigNode(configView, (String) names[i]);
                    child.writeConfiguration(childView, param);
                } catch (Exception ex) {
                    ex.printStackTrace();
                }
            }
        }
        //for a set of primitive / String type.
        else
            throw new IllegalArgumentException("Unable to write primitive sets to configuration (not implemented)");

    }

    public void readConfiguration(Object configurationView, Object param) {
        String[] names = Configuration.getChildrenNames(configurationView);

        if (ConfigNode.class.isAssignableFrom(childClass)) {

            for (int i = 0; i < names.length; i++) {
                try {
                    ConfigNode child = (ConfigNode) createChild();
                    child.setRoot(root);
                    child.readConfiguration(Configuration.getNode(names[i], configurationView), param);
                    add(names[i], child);
                } catch (Exception ex) {
                    ex.printStackTrace();
                }
            }
            //remove any nulls from the list
            if (noNulls)
                for (int i = 0; i < childrenList.size(); i++)
                    if (childrenList.get(i) == null)
                        childrenList.remove(i--);
        }
        //for a set of primitive / String type.
        else
            for (int i = 0; i < names.length; i++) {
                try {
                    Object child = Configuration.getNode(names[i], configurationView);
                    add(names[i], child);
                } catch (Exception ex) {
                    ex.printStackTrace();
                }
            }
    }

    public void remove(Object obj) {
        Object key = getKey(obj);
        childrenMap.remove(key);
        int i = childrenList.indexOf(obj);
        childrenList.remove(obj);
        fireListDataListenerIntervalRemoved(i, i);
    }

    public void remove(int i) {
        Object o = getElementAt(i);
        remove(o);
    }

    public void update(int i) {
        fireListDataListenerContentsChanged(i, i);
    }

    public Node createDOM(Node parent) {

        Object[] items = items();

        for (int i = 0; i < items.length; i++) {
            Object item = items[i];
            if (item instanceof XMLProvider)
                 ((XMLProvider) item).createDOM(parent);

        }
        return parent;
    }

    public Object[] items() {
        return childrenList.toArray();
    }

    public Object getKey(Object object) {
        for (Iterator i = childrenMap.entrySet().iterator(); i.hasNext();) {

            Map.Entry me = (Map.Entry) i.next();
            if (me.getValue() == object)
                return me.getKey();

        }
        return null;
    }

    public Object getKey(int i) {
        int c = 0;
        while (i > -1) {
            if (getElementAt(c) != null)
                i--;
            c++;
        }
        if (c == 0)
            return null;
        else
            return getKey(getElementAt(c - 1));
    }

    public void setRoot(Object newRoot) {
        root = newRoot;
    }

    /** Registers ListDataListener to receive events.
     * @param listener The listener to register.
     *
     */
    public synchronized void addListDataListener(javax.swing.event.ListDataListener listener) {
        if (listenerList == null) {
            listenerList = new javax.swing.event.EventListenerList();
        }
        listenerList.add(javax.swing.event.ListDataListener.class, listener);
    }

    /** Removes ListDataListener from the list of listeners.
     * @param listener The listener to remove.
     *
     */
    public synchronized void removeListDataListener(javax.swing.event.ListDataListener listener) {
        listenerList.remove(javax.swing.event.ListDataListener.class, listener);
    }

    /** Notifies all registered listeners about the event.
     *
     * @param event The event to be fired
     *
     */
    private void fireListDataListenerIntervalAdded(int i0, int i1) {
        ListDataEvent event = new ListDataEvent(this, ListDataEvent.INTERVAL_ADDED, i0, i1);
        if (listenerList == null)
            return;
        Object[] listeners = listenerList.getListenerList();
        for (int i = listeners.length - 2; i >= 0; i -= 2) {
            if (listeners[i] == javax.swing.event.ListDataListener.class) {
                ((javax.swing.event.ListDataListener) listeners[i + 1]).intervalAdded(event);
            }
        }
    }

    /** Notifies all registered listeners about the event.
     *
     * @param event The event to be fired
     *
     */
    private void fireListDataListenerIntervalRemoved(int i0, int i1) {
        ListDataEvent event = new ListDataEvent(this, ListDataEvent.INTERVAL_REMOVED, i0, i1);
        if (listenerList == null)
            return;
        Object[] listeners = listenerList.getListenerList();
        for (int i = listeners.length - 2; i >= 0; i -= 2) {
            if (listeners[i] == javax.swing.event.ListDataListener.class) {
                ((javax.swing.event.ListDataListener) listeners[i + 1]).intervalRemoved(event);
            }
        }
    }

    /** Notifies all registered listeners about the event.
     *
     * @param event The event to be fired
     *
     */
    private void fireListDataListenerContentsChanged(int i0, int i1) {
        ListDataEvent event = new ListDataEvent(this, ListDataEvent.CONTENTS_CHANGED, i0, i1);
        if (listenerList == null)
            return;
        Object[] listeners = listenerList.getListenerList();
        for (int i = listeners.length - 2; i >= 0; i -= 2) {
            if (listeners[i] == javax.swing.event.ListDataListener.class) {
                ((javax.swing.event.ListDataListener) listeners[i + 1]).contentsChanged(event);
            }
        }
    }

    public Object getElementAt(int i) {
        return childrenList.get(i);
    }

    public Object getElement(Object o) {
        return childrenMap.get(o);
    }

    public int getSize() {
        return childrenList.size();
    }

    public Set keys() {
        return childrenMap.keySet();
    }

    public int getIndexOf(Object item) {
        return childrenList.indexOf(item);
    }

    /**
     * Set members might include a property
     * which orders them.
     * This method reindexes the given member to be
     * the index number 0
     * Do not forget to call commit() after calling this method.
     * @param confView
     * @param memebrName
     */
    public void reindexSet(Object confView, String memberName, String indexPropertyName) throws Exception {
        /*
         * First I read all memebrs of the set,
         * except the one that should be number 0
         * to a vector, ordered by there index property
         */
        String[] names = Configuration.getChildrenNames(confView);
        Vector v = new Vector(names.length);
        Object member = null;
        int index = 0;
        for (int i = 0; i < names.length; i++)
            if (!names[i].equals(memberName)) {
                member = Configuration.getConfigurationNode(names[i], confView);
                index = Configuration.getInt(indexPropertyName, member);
                while (index >= v.size())
                    v.add(null);
                v.setElementAt(member, index);

            }
        /**
         * Now I reindex them
         */

        index = 1;
        for (int i = 0; i < v.size(); i++) {
            member = v.get(i);
            if (member != null)
                Configuration.set(index++, indexPropertyName, member);
        }

    }

}