| gvSIG desktop 1

/* gvSIG. Sistema de Informaci?n Geogr?fica de la Generalitat Valenciana

 *

 * Copyright (C) 2005 IVER T.I. and Generalitat Valenciana.

 *

 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307,USA.

 *

 * For more information, contact:

 *

 *  Generalitat Valenciana

 *   Conselleria d'Infraestructures i Transport

 *   Av. Blasco Ib??ez, 50

 *   46010 VALENCIA

 *   SPAIN

 *

 *      +34 963862235

 *   gvsig@gva.es

 *      www.gvsig.gva.es

 *

 *    or

 *

 *   IVER T.I. S.A

 *   Salamanca 50

 *   46005 Valencia

 *   Spain

 *

 *   +34 963163400

 *   dac@iver.es

 */

package com.iver.cit.gvsig.fmap.rendering;

import java.util.Hashtable;

import java.util.Iterator;

import java.util.logging.Level;

import java.util.logging.Logger;

import com.iver.cit.gvsig.fmap.core.IFeature;

import com.iver.cit.gvsig.fmap.core.symbols.IMultiLayerSymbol;

import com.iver.cit.gvsig.fmap.core.symbols.ISymbol;

import com.iver.utiles.IPersistance;

import com.iver.utiles.XMLEntity;

/**

 * Class ZSort is used in order to store information of the symbols which are

 * placed in the Z axis (because a level of symbols has been used).

 * @author jaume dominguez faus - jaume.dominguez@iver.es

 */

public class ZSort implements IPersistance{

    private final ISymbol[] symbols;

    private boolean usingSymbolLevels;

//        private Hashtable symbolLevels = new Hashtable();

    private Hashtable table = new Hashtable();

    /**

     * Constructor Method

     * @param legend

     */

    public ZSort(ILegend legend) {

        if (legend instanceof IClassifiedLegend) {

            ISymbol[] ss = ((IClassifiedLegend) legend).getSymbols();

            symbols = new ISymbol[ss.length];

            System.arraycopy(

                    ss, 0,

                    symbols, 0, ss.length);

        } else {

            symbols = new ISymbol[] {legend.getDefaultSymbol()};

        }

    }

    /**

     * Ok if it is being used symbol levels, false on the contrary.

     * @return usingSymbolLevels, boolean;

     */

    public boolean isUsingZSort() {

        return usingSymbolLevels;

    }

    /**

     * Stablishes if the Symbol Levels is going to be used or not.

     * @param b

     */

    public void setUsingZSort(boolean b) {

        usingSymbolLevels = b;

    }

    /**

     * Returns the number of layers that has the symbol which is an instance of

     * IMultiLayerSymbol and has the maximum number of layers.

     * @return

     */

    public int getMaxSymbolLayerCount() {

        int count = 0;

        for (int i = 0; i < symbols.length; i++) {

            int levels = (symbols[i] instanceof IMultiLayerSymbol) ?

                    ((IMultiLayerSymbol) symbols[i]).getLayerCount() : 1;

                    count = Math.max(count, levels);

        }

        return count;

    }

    public ISymbol getSymbolByFeatureAndLevel(IFeature feat, int level) {

        // TODO Implement it

        throw new Error("Not yet implemented!");

    }

    /**

     * Returns an array composed by all the symbols.

     * @return symbols, ISymbol[]

     */

    public ISymbol[] getSymbols() {

        return symbols;

    }

    /**

     * Returns an array composed by all the descriptions of the symbols.

     *

     * @return desc, String[]

     */

    public String[] getDescriptions() {

        String[] desc = new String[symbols.length];

        for (int i = 0; i < desc.length; i++) {

            desc[i] = symbols[i].getDescription();

        }

        return desc;

    }

    /**

     * Obtains the level of a symbol.The method to obtain this value will be different

     * depending on the type of the symbol (if the symbol is multilayer we have

     * to check all the layers).

     *

     * @param layer,ISymbol

     * @return int

     */

    public int getSymbolLevel(ISymbol layer) {

        Iterator it = table.keySet().iterator();

        while (it.hasNext()) {

            ISymbol sym = (ISymbol) it.next();

            int[] levels = (int[]) table.get(sym);

            if (sym instanceof IMultiLayerSymbol) {

                IMultiLayerSymbol mlSym = (IMultiLayerSymbol) sym;

                for (int i = 0; i < mlSym.getLayerCount(); i++) {

                    if (mlSym.getLayer(i).equals(layer))

                        return levels[i];

                }

            } else {

                if (sym.equals(layer)) return levels[0];

            }

        }

        return 0; // symbol does not exist yet in the ZSort

    }

    /**

     * Returns the maximum level of all the symbols contained in the hash table

     * @return int

     */

    public int getLevelCount() {

        int level = 0;

        Iterator it = table.keySet().iterator();

        while (it.hasNext()) {

            ISymbol sym = (ISymbol) it.next();

            int[] levels = (int[]) table.get(sym);

            for (int i = 0; i < levels.length; i++) {

                level = Math.max(level, levels[i]);

            }

        }

        return level;

    }

    /**

     * Sets the levels associated with the symbols. The length of the

     * argument levels must match the number of layers of the symbol in

     * case the symbol is an {@link IMultiLayerSymbol}, or 1 otherwise

     * @param sym

     * @param levels

     */

    public void setLevelsToSymbol(ISymbol sym, int[] levels) {

        table.put(sym, levels);

        System.err.println(this);

//                removeEmptyGaps();

        System.err.println(this);

    }

    /**

     * Ensures that the table does not contain map levels with no symbols by

     * updating the map level index to the next inmediate map level to the

     * previous non-empty one.

     */

    private void removeEmptyGaps() {

        if (table.isEmpty()) return;

        ISymbol[] syms = (ISymbol[]) table.keySet().toArray(new ISymbol[0]);

        int[][] aux = new int[syms.length][];

        Iterator it = table.keySet().iterator();

        int i = 0;

        while (it.hasNext()) {

            aux[i] = (int[]) it.next();

            i++;

        }

        boolean[] isUsedLevel = new boolean[getLevelCount()];

        for (i = 0; i < aux.length; i++) {

            int[] thisLevels = aux[i];

            for (int j = 0; j < thisLevels.length; j++) {

                isUsedLevel[thisLevels[j]] = true;

            }

        }

        for (i = 0; i < isUsedLevel.length; i++) {

            if (!isUsedLevel[i]) {

                for (int j = 0; j < aux.length; j++) {

                    int[] thisLevels = aux[i];

                    for (int k = 0; j < thisLevels.length; k++) {

                        if (thisLevels[j]>i)

                            thisLevels[j]--;

                    }

                }

            }

        }

    }

    public String toString() {

        String out = super.toString();

        Iterator it = table.keySet().iterator();

        while (it.hasNext()) {

            ISymbol sym = (ISymbol) it.next();

            int[] levels = (int[]) table.get(sym);

            out += "\n"+sym.getDescription();

            for (int i = 0; i < levels.length; i++) {

                out += "\t"+levels[i];

            }

        }

        return out;

    }

    public String getClassName() {

        return getClass().getName();

    }

    public XMLEntity getXMLEntity() {

        // TODO Auto-generated method stub

        throw new Error("Not yet implemented!");

    }

    public void setXMLEntity(XMLEntity xml) {

        // TODO Auto-generated method stub

        throw new Error("Not yet implemented!");

    }

}