| 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

 */

/* CVS MESSAGES:

*

* $Id: GeneralLabelingStrategy.java 13749 2007-09-17 14:16:11Z jaume $

* $Log$

* Revision 1.2  2007-09-17 14:16:11  jaume

* multilayer symbols sizing bug fixed

*

* Revision 1.1  2007/05/22 12:17:41  jaume

* *** empty log message ***

*

* Revision 1.1  2007/05/22 10:05:31  jaume

* *** empty log message ***

*

* Revision 1.10  2007/05/17 09:32:06  jaume

* *** empty log message ***

*

* Revision 1.9  2007/05/09 11:04:58  jaume

* refactored legend hierarchy

*

* Revision 1.8  2007/04/13 11:59:30  jaume

* *** empty log message ***

*

* Revision 1.7  2007/04/12 14:28:43  jaume

* basic labeling support for lines

*

* Revision 1.6  2007/04/11 16:01:08  jaume

* maybe a label placer refactor

*

* Revision 1.5  2007/04/10 16:34:01  jaume

* towards a styled labeling

*

* Revision 1.4  2007/04/02 16:34:56  jaume

* Styled labeling (start commiting)

*

* Revision 1.3  2007/03/28 16:48:01  jaume

* *** empty log message ***

*

* Revision 1.2  2007/03/26 14:40:38  jaume

* added print method (BUT UNIMPLEMENTED)

*

* Revision 1.1  2007/03/20 16:16:20  jaume

* refactored to use ISymbol instead of FSymbol

*

* Revision 1.2  2007/03/09 11:20:57  jaume

* Advanced symbology (start committing)

*

* Revision 1.1  2007/03/09 08:33:43  jaume

* *** empty log message ***

*

* Revision 1.1.2.5  2007/02/21 07:34:08  jaume

* labeling starts working

*

* Revision 1.1.2.4  2007/02/15 16:23:44  jaume

* *** empty log message ***

*

* Revision 1.1.2.3  2007/02/09 07:47:05  jaume

* Isymbol moved

*

* Revision 1.1.2.2  2007/02/02 16:21:24  jaume

* start commiting labeling stuff

*

* Revision 1.1.2.1  2007/02/01 17:46:49  jaume

* *** empty log message ***

*

*

*/

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

import java.awt.Graphics2D;

import java.awt.geom.Rectangle2D;

import java.awt.image.BufferedImage;

import java.util.ArrayList;

import java.util.Hashtable;

import java.util.logging.Level;

import java.util.logging.Logger;

import javax.print.attribute.PrintRequestAttributeSet;

import com.hardcode.gdbms.driver.exceptions.ReadDriverException;

import com.hardcode.gdbms.engine.values.Value;

import com.iver.cit.gvsig.exceptions.expansionfile.ExpansionFileReadException;

import com.iver.cit.gvsig.exceptions.visitors.VisitorException;

import com.iver.cit.gvsig.fmap.ViewPort;

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

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

import com.iver.cit.gvsig.fmap.drivers.IFeatureIterator;

import com.iver.cit.gvsig.fmap.layers.FBitSet;

import com.iver.cit.gvsig.fmap.layers.FLayer;

import com.iver.cit.gvsig.fmap.layers.FLyrVect;

import com.iver.cit.gvsig.fmap.layers.ReadableVectorial;

import com.iver.cit.gvsig.fmap.layers.SelectableDataSource;

import com.iver.utiles.XMLEntity;

import com.iver.utiles.swing.threads.Cancellable;

/**

 * This is the default and simplest (therefore fastest) labeling strategy.

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

 */

public class GeneralLabelingStrategy implements ILabelingStrategy {

        private static Logger logger = Logger.getAnonymousLogger();

        private ILabelingMethod method;

        private IPlacementConstraints placementConstraints;

        private FLyrVect layer;

        private IZoomConstraints zoomConstraints;

        private Hashtable texts = new Hashtable();

//        public GeneralLabelingStrategy() {}

//        protected GeneralLabelingStrategy(FLayer layer) throws ReadDriverException {

//                setLayer(layer);

//        }

        public void setLayer(FLayer layer) throws ReadDriverException, Error {

                FLyrVect l = (FLyrVect) layer;

                this.layer = l;

                if (layer instanceof FLyrVect) {

                        FLyrVect lyrVect = (FLyrVect) layer;

                        placementConstraints = LabelingFactory.createPlacementConstraints(lyrVect);

                } else {

                        throw new Error("Layer type not yet supported");

                }

        }

        public ILabelingMethod getLabelingMethod() {

                return method;

        }

        public void setLabelingMethod(ILabelingMethod method) {

                this.method = method;

        }

        public void draw(BufferedImage image, Graphics2D g, ViewPort viewPort,

                        Cancellable cancel)

        throws ReadDriverException {

                if (method == null) {

                        Logger.getAnonymousLogger().warning("Layer '"+layer.getName()+"'. No labeling method was set, labels will not be drawn");

                        return;

                }

                if (zoomConstraints != null) {

                        double scale = viewPort.getScale();

                        if (scale < zoomConstraints.getMinScale() ||

                                        scale > zoomConstraints.getMaxScale())

                                return;

                }

                IFeatureIterator it = layer.getSource().getFeatureIterator(

                                viewPort.getAdjustedExtent(),

                                getUsedFields(),

                                viewPort.getProjection(),

                                true);

                try {

                        while (!cancel.isCanceled() && it.hasNext()) {

                                IFeature feat =  it.next();

                                IGeometry geom = feat.getGeometry();

                                LabelClass lc = method.getDefaultLabelClass();

                                Value[] vv = feat.getAttributes();

                                String[] texts = new String[vv.length];

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

                                        texts[i] = vv[i].toString(); 

                                }

                                lc.setTexts(texts);

                                // refactor "if label shape is big enough"

                                placementConstraints.placeLabel(g, geom, lc, null, viewPort.getAffineTransform());

                        }

                } catch (ExpansionFileReadException e) {

                        throw new ReadDriverException(

                                        layer.getSource().getDriver().getName(), e);

                }

        }

        public void _draw(BufferedImage image, Graphics2D g, ViewPort viewPort,

                                         Cancellable cancel)

        throws ReadDriverException {

                 Rectangle2D theExtent = viewPort.getAdjustedExtent();

                 if (method == null) {

                         Logger.getAnonymousLogger().warning("Layer '"+layer.getName()+"'. No labeling method was set, labels will not be drawn");

                         return;

                 }

                 if (zoomConstraints != null) {

                         double scale = viewPort.getScale();

                         if (scale < zoomConstraints.getMinScale() ||

                             scale > zoomConstraints.getMaxScale())

                                 return;

                 }

                 FBitSet bs;

                 int i = -1;

                 try {

                         bs = layer.queryByRect(theExtent);

                         LabelClass lc = method.getDefaultLabelClass();

                         ReadableVectorial rv = layer.getSource();

                         SelectableDataSource sds = rv.getRecordset();

                         for(i=bs.nextSetBit(0); i>=0 && !cancel.isCanceled(); i=bs.nextSetBit(i+1)) {

                                 IGeometry geom;

                                 Integer index = new Integer(i);

                                 geom = rv.getShape(i);

                                 lc.setTexts(getText(index, sds));

                                 // refactor

//                                  if (labelShape is big enough)

                                 {

//                                         String[] texts = getText(index, sds);

                                         placementConstraints.placeLabel(g, geom, lc, null, viewPort.getAffineTransform());

                                 }

//                                        este ?s el cas quan gaste placementConstraints.getLocationsFor(...)

//                                  if (labelShape != null) {

//                                         FShape[] places = placementConstraints.getLocationsFor(

//                                                         geom, labelShape,

//                                                         null);

//

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

////                                                 places[j].transform(viewPort.getAffineTransform());

//                                                 lc.drawInsideRectangle(g, places[j].getBounds());

//

//                                         }

//                                 }

                         }

                 } catch (ExpansionFileReadException e) {

                         logger.log(Level.SEVERE, e.getMessage());

                 } catch (ReadDriverException e) {

                         logger.log(Level.SEVERE, "Getting label text for "+i+"th shape of "+layer.getName());

                 } catch (VisitorException e) {

                         logger.log(Level.SEVERE, "Getting label text for "+i+"th shape of "+layer.getName());

                 }

        }

        private String[] getText(Integer index, SelectableDataSource sds) throws ReadDriverException {

                String text = (String) texts.get(index);

                if (text == null) {

                        String expr = method.getDefaultLabelClass().getLabelExpression();

                        // TODO el analizador sint?ctico de momento s?lo pilla un valor del combo por

                        // defecto

                        String fieldName = expr.replaceAll("\\[", "").replaceAll("\\]", "").trim();

                        text = sds.getFieldValue(index.longValue(), sds.getFieldIndexByName(fieldName)).toString();

                        texts.put(index, text);

                }

                return new String[] { text };

        }

        public String getClassName() {

                return getClass().getName();

        }

        public XMLEntity getXMLEntity() {

                // TODO Implement it

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

                return new XMLEntity();

        }

        public void setXMLEntity(XMLEntity xml) {

                // TODO Implement it

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

        }

        public IPlacementConstraints getPlacementConstraints() {

                return placementConstraints;

        }

        public void setPlacementConstraints(IPlacementConstraints constraints) {

                this.placementConstraints = constraints;

        }

        public IZoomConstraints getZoomConstraints() {

                return zoomConstraints;

        }

        public void setZoomConstraints(IZoomConstraints constraints) {

                this.zoomConstraints = constraints;

        }

        public void print(Graphics2D g, ViewPort viewPort, Cancellable cancel, PrintRequestAttributeSet properties) throws ReadDriverException {

//                double originalScaleFactor = unitFactor;

//                PrintQuality pq = (PrintQuality) properties.get(PrintQuality.class);

//                if (pq.equals(PrintQuality.NORMAL)){

//                        unitFactor *= (double) 300/72;

//                }else if (pq.equals(PrintQuality.HIGH)){

//                        unitFactor *= (double) 600/72;

//                }else if (pq.equals(PrintQuality.DRAFT)){

//                        //        unitFactor *= 72; (which is the same than doing nothing)

//                }

//                draw(null, g, viewPort, cancel);

//                unitFactor = originalScaleFactor;

        }

        public String[] getUsedFields() {

                LabelClass[] lcs = method.getLabelClasses();

                ArrayList<String> fieldNames = new ArrayList<String>(); 

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

                        String expr = lcs[i].getLabelExpression();

                        /*

                         * TODO

                         * implement the expression parser, and extract the names of the

                         * fields involved 

                         */

                        // this is just a provisional

                        fieldNames.add( expr.replaceAll(" *", "").replaceAll("\\[|\\]", "") );

                }

                return fieldNames.toArray(new String[fieldNames.size()]);

        }

}