Application: gvSIG desktop

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

 *

 * Copyright (C) 2004 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 org.gvsig.fmap.mapcontext.rendering;

import java.awt.Dimension;

import java.awt.Rectangle;

import java.io.IOException;

import java.sql.Types;

import java.util.ArrayList;

import java.util.Hashtable;

import java.util.Iterator;

import java.util.List;

import org.gvsig.data.CloseException;

import org.gvsig.data.DataCollection;

import org.gvsig.data.DataException;

import org.gvsig.data.DataExplorer;

import org.gvsig.data.DataStoreParameters;

import org.gvsig.data.InitializeException;

import org.gvsig.data.OpenException;

import org.gvsig.data.ReadException;

import org.gvsig.data.WriteException;

import org.gvsig.data.commands.CommandsRecord;

import org.gvsig.data.vectorial.Feature;

import org.gvsig.data.vectorial.FeatureAttributeDescriptor;

import org.gvsig.data.vectorial.FeatureID;

import org.gvsig.data.vectorial.FeatureStore;

import org.gvsig.data.vectorial.FeatureType;

import org.gvsig.exceptions.BaseException;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.GeometryFactory;

import org.gvsig.fmap.geom.GeometryManager;

import org.gvsig.fmap.geom.primitive.GeneralPathX;

import org.gvsig.fmap.mapcontext.rendering.legend.AbstractIntervalLegend;

import org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedLegend;

import org.gvsig.fmap.mapcontext.rendering.legend.IClassifiedVectorLegend;

import org.gvsig.fmap.mapcontext.rendering.legend.ILegend;

import org.gvsig.fmap.mapcontext.rendering.symbol.TestISymbol;

import org.gvsig.fmap.mapcontext.rendering.symbols.ISymbol;

import org.gvsig.metadata.IMetadata;

import org.gvsig.util.observer.Observer;

import org.opengis.filter.Filter;

import org.opengis.filter.sort.SortBy;

import junit.framework.TestCase;

/**

 * Integration test to ensure that the legends which implements the

 * IClassifiedLegend interface follow the rules that follow the managing of them

 * by the application.

 *

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

 * @author pepe vidal salvador - jose.vidal.salvador@iver.es

 */

public class TestIClassifiedLegend extends TestCase {

        private static final Integer v0 = new Integer(0);

        private static final Integer v1 = new Integer(1);

        private static final Integer v2 = new Integer(2);

        private static final Integer v3 = new Integer(3);

        private static final String FIELD3 = "field3";

        private static final String FIELD2 = "field2";

        private static final String FIELD1 = "field1";

        private static final String FIELD0 = "field0";

        private static final int FIELDID = 0;

        private static final Integer[] feature0Values = new Integer[] { v0, v1, v2, v3, };

        private static final Integer[] feature1Values = new Integer[] { v3, v0, v1, v2, };

        private static final Integer[] feature2Values = new Integer[] { v2, v3, v0, v1, };

        private static final Integer[] feature3Values = new Integer[] { v1, v2, v3, v0, };

        private static final Integer[][] featureValues = new Integer[][] {

                feature0Values,

                feature1Values,

                feature2Values,

                feature3Values,};

        private static String[] fieldNames = new String[] {FIELD0,FIELD1,FIELD2,FIELD3,};

        // private static final Value v4 = (Value)ValueFactory.createValue(4);

        // private static final Value v5 = (Value)ValueFactory.createValue(5);

        // private static final Value v6 = (Value)ValueFactory.createValue(6);

        // private static final Value v7 = (Value)ValueFactory.createValue(7);

        // private static final Value v8 = (Value)ValueFactory.createValue(8);

        // private static final Value v9 = (Value)ValueFactory.createValue(9);

        private AbstractIntervalLegend[] intervalLegends;

        private MockDataSource mockDataSource = new MockDataSource();

        /**

         * To avoid duplicated validation logic in the test a mock object is created

         * to use a DataSource for this test.

         *

         */

        private class MockDataSource implements FeatureStore {

                public DataCollection getDataCollection(FeatureType type, String filter, String order) throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public DataCollection getDataCollection(String[] fields, String filter, String order) throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void getDataCollection(FeatureType type, String filter, String order, Observer observer) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void getDataCollection(String[] fields, String filter, String order, Observer observer) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void getDataCollection(Observer observer) {

                        // TODO Auto-generated method stub

                }

                public Feature getFeatureByID(FeatureID id) throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public Feature getFeatureByID(FeatureID id, FeatureType featureType) throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public FeatureType getDefaultFeatureType() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public List getFeatureTypes() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public Feature createFeature(FeatureType type, boolean defaultValues) throws InitializeException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public Feature createDefaultFeature(boolean defaultValues) throws InitializeException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void update(Feature feature) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void delete(Feature feature) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void insert(Feature feature) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void update(FeatureAttributeDescriptor attributeDescriptor) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void delete(FeatureAttributeDescriptor attributeDescriptor) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void insert(FeatureAttributeDescriptor attributeDescriptor) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void disableNotifications() {

                        // TODO Auto-generated method stub

                }

                public void enableNotifications() {

                        // TODO Auto-generated method stub

                }

                public boolean isLocked(FeatureID id) {

                        // TODO Auto-generated method stub

                        return false;

                }

                public boolean lock(FeatureID id) {

                        // TODO Auto-generated method stub

                        return false;

                }

                public boolean isWithDefaultLegend() {

                        // TODO Auto-generated method stub

                        return false;

                }

                public Object getDefaultLegend() throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public Object getDefaultLabelingStrategy() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public boolean canAlterFeatureType() {

                        // TODO Auto-generated method stub

                        return false;

                }

                public DataStoreParameters getParameters() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public String getName() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void init(DataStoreParameters parameters) throws InitializeException {

                        // TODO Auto-generated method stub

                }

                public void open() throws OpenException {

                        // TODO Auto-generated method stub

                }

                public void refresh() throws OpenException, InitializeException {

                        // TODO Auto-generated method stub

                }

                public void close() throws CloseException {

                        // TODO Auto-generated method stub

                }

                public void dispose() throws CloseException {

                        // TODO Auto-generated method stub

                }

                public DataCollection getDataCollection() throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public DataCollection getSelection() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void setSelection(DataCollection selection) {

                        // TODO Auto-generated method stub

                }

                public DataCollection createSelection() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public Iterator getChilds() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public boolean isEditable() {

                        // TODO Auto-generated method stub

                        return false;

                }

                public void startEditing() throws ReadException {

                        // TODO Auto-generated method stub

                }

                public void cancelEditing() {

                        // TODO Auto-generated method stub

                }

                public void finishEditing() throws WriteException, ReadException {

                        // TODO Auto-generated method stub

                }

                public boolean isEditing() {

                        // TODO Auto-generated method stub

                        return false;

                }

                public void undo() {

                        // TODO Auto-generated method stub

                }

                public void redo() {

                        // TODO Auto-generated method stub

                }

                public CommandsRecord getCommandsRecord() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void beginComplexNotification() {

                        // TODO Auto-generated method stub

                }

                public void endComplexNotification() {

                        // TODO Auto-generated method stub

                }

                public DataCollection getLocked() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void setLocked(DataCollection locked) {

                        // TODO Auto-generated method stub

                }

                public DataCollection createLocked() {

                        // TODO Auto-generated method stub

                        return null;

                }

                public DataExplorer getExplorer() throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void addObserver(Observer o) {

                        // TODO Auto-generated method stub

                }

                public void deleteObserver(Observer o) {

                        // TODO Auto-generated method stub

                }

                public void deleteObservers() {

                        // TODO Auto-generated method stub

                }

                public IMetadata getMetadata() throws BaseException {

                        // TODO Auto-generated method stub

                        return null;

                }

//                public void start() throws ReadDriverException                                                                 { }

//                public void stop() throws ReadDriverException                                                                 { }

//                public long[] getWhereFilter() throws IOException                                                         {return null;}

//                public DataSourceFactory getDataSourceFactory()                                                         {return null;}

//                public Memento getMemento() throws MementoException                                                 {return null;}

//                public void setDataSourceFactory(DataSourceFactory dsf)                                         { }

//                public void setSourceInfo(SourceInfo sourceInfo)                                                          { }

//                public SourceInfo getSourceInfo()                                                                                         {return null;}

//                public String getAsString() throws ReadDriverException                                                 {return null;}

//                public void remove() throws WriteDriverException                                                         { }

//                public int[] getPrimaryKeys() throws ReadDriverException                                         {return null;}

//                public ValueCollection getPKValue(long rowIndex)throws ReadDriverException         {return null;}

//                public String getPKName(int fieldId) throws ReadDriverException                         {return null;}

//                public String[] getPKNames() throws ReadDriverException                                         {return null;}

//                public int getPKType(int i) throws ReadDriverException                                                 {return 0;}

//                public int getPKCardinality() throws ReadDriverException                                         {return 0;}

//                public Value[] getRow(long rowIndex) throws ReadDriverException                         {return null;}

//                public DataWare getDataWare(int mode) throws ReadDriverException                         {return null;}

//                public boolean isVirtualField(int fieldId) throws ReadDriverException                 {return false;}

//                public Driver getDriver()                                                                                                         {return null;}

//                public void reload() throws ReloadDriverException                                                         { }

//                public void addDataSourceListener(IDataSourceListener listener)                         { }

//                public void removeDataSourceListener(IDataSourceListener listener)                         { }

//                public Value getFieldValue(long rowIndex, int fieldId)throws ReadDriverException {return null;}

//                public int getFieldCount() throws ReadDriverException                                                 {return 0;}

//                public long getRowCount() throws ReadDriverException                                                 {return 0;}

//                public int getFieldWidth(int i) throws ReadDriverException                                         {return 0;}

//

//                public String getFieldName(int fieldId) throws ReadDriverException {

//                        return fieldNames[fieldId];

//                }

//

//                public String getName(){

//                        return "Mock datasource used for testing only";

//                }

//

//                public String[] getFieldNames() throws ReadDriverException {

//                        return fieldNames;

//                }

//

//                public int getFieldIndexByName(String fieldName)throws ReadDriverException {

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

//                                if (fieldNames[i].equals(fieldName))

//                                        return i;

//                        }

//                        return -1;

//                }

//

//                public int getFieldType(int i) throws ReadDriverException {

//                        return Types.INTEGER;

//                }

                public DataCollection getDataCollection(FeatureType type,

                                Filter filter, SortBy order) throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public DataCollection getDataCollection(String[] fields, Filter filter,

                                SortBy order) throws ReadException {

                        // TODO Auto-generated method stub

                        return null;

                }

                public void getDataCollection(FeatureType type, Filter filter,

                                SortBy order, Observer observer) throws DataException {

                        // TODO Auto-generated method stub

                }

                public void getDataCollection(String[] fields, Filter filter,

                                SortBy order, Observer observer) throws DataException {

                        // TODO Auto-generated method stub

                }

        }

        //private static final FInterval interval0=new FInterval(0,2);

        //private static final FInterval interval1=new FInterval(3,5);

        //private static final FInterval interval2=new FInterval(6,2);

        //private static final FInterval interval3=new FInterval(9,2);

        // private static final Value interval4;

        // private static final Value interval5;

        // private static final Value interval6;

        // private static final Value interval7;

        // private static final Value interval8;

        // private static final Value interval9;

        Hashtable symTable;

        private IClassifiedVectorLegend[] classifiedLegends;

        private ISymbol[] symbols;

        private Object[] sampleValues = new Object[] { v0, v1, v2, v3, };

        private Feature[] features;

        // private FInterval[] intervals = new FInterval[] {

        // interval0,

        // interval1,

        // interval2,

        // interval3,

        // interval4,

        // interval5,

        // interval6,

        // interval7,

        // interval8,

        // interval9,

        // };

        protected void setUp() throws Exception {

                super.setUp();

                features = new Feature[4];

                // initialize test values

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

                        GeometryFactory geomFactory=GeometryManager.getInstance().getGeometryFactory();

                        // create the geometry associated to the feature

                        int size = 200;

                        Dimension d = new Dimension(size, size);

                        Rectangle aShape = new Rectangle(i * size, i * size, d.width,

                                        d.height);

                        Geometry geom = geomFactory.createPolyline2D(new GeneralPathX(

                                        aShape));

                        /*

                         * create a full-featured Feature with randomed values at its fields

                         * to avoid testing over the same values each time

                         */

//                        features[i] = new DefaultFeature(geom, featureValues[i], "[" + i

//                                        + "]");

                }

                // initialize the symbol subset for this test

                symbols = TestISymbol.getNewSymbolInstances();

                // initialize the legends for this test

                ILegend[] allLegends = TestILegend.getNewLegendInstances();

                ArrayList clegends = new ArrayList();

                ArrayList intervalLegends = new ArrayList();

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

                        if (allLegends[i] instanceof AbstractIntervalLegend) // <- Tested

                                intervalLegends.add(allLegends[i]);

                        else if (allLegends[i] instanceof IClassifiedLegend) {

                                clegends.add(allLegends[i]);

                        }

                        if (allLegends[i] instanceof IClassifiedVectorLegend) {

                                IClassifiedVectorLegend cvl = (IClassifiedVectorLegend) allLegends[i];

                                cvl.setClassifyingFieldNames(new String[] { fieldNames[FIELDID] });

                                cvl.setFeatureStore(mockDataSource);

                        }

                }

                this.classifiedLegends = (IClassifiedVectorLegend[]) clegends

                                .toArray(new IClassifiedVectorLegend[clegends.size()]);

                this.intervalLegends = (AbstractIntervalLegend[]) intervalLegends

                                .toArray(new AbstractIntervalLegend[intervalLegends.size()]);

        }

        /**

         * This method is used to add symbols to a legend.That is, it takes an array

         * of IClassifiedVectorialLegend which is empty andm, using a second array

         * of objects (values), the first one is filled.Also, a hash table is filled

         * too using the array of objects (it will be useful in some tests to check

         * that a symbol can be taken using a feature) .

         *

         * @param legend

         * @return

         */

        private void fillClassifiedLegend(IClassifiedVectorLegend legend,

                        Object[] values) {

                // initialize the hash table

                symTable = new Hashtable();

                // to add symbols to the legend and the hash table

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

                        ISymbol sym = symbols[j % symbols.length];

                        legend.addSymbol(values[j], sym);

                        symTable.put(values[j], sym);

                }

        }

        /**

         * This test ensures that when a legend is filled, the number of symbols

         * added is correct. To do it, is checked that the number of symbols of a

         * legend is the same as the length of the array of example values that we

         * have.

         *

         * @throws ReadDriverException

         */

        public void testICLAdittion() throws ReadException {

                // Fills the legend

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

                        fillClassifiedLegend(classifiedLegends[i], sampleValues);

                }

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

                        assertEquals(classifiedLegends[i].getClassName()

                                        + " fails with the comparation of the number of symbols",

                                        classifiedLegends[i].getSymbols().length,

                                        sampleValues.length);

        }

        /**

         * This test ensures that the symbols that we have previously added to a

         * legend are accessible using its features.To do it, this test compares the

         * symbol taken from the legend with the symbol taken from the hashTable

         * (using the same feature).

         *

         * @throws ReadDriverException

         */

        public void testICLCheckValueSymbols() throws ReadException {

                // fills the legends

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

                        fillClassifiedLegend(classifiedLegends[i], sampleValues);

                }

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

                        // For each feature

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

                                Feature myFeature = features[i];

                                // takes the value of the field that identifies the feature

                                Object val = myFeature.get(FIELDID);

                                // the last value is used to access to the hash table to obtain

                                // a symbol

                                ISymbol tableSym = (ISymbol) symTable.get(val);

                                IClassifiedVectorLegend leg = (IClassifiedVectorLegend) classifiedLegends[i];

                                // takes the symbol from a legend using the feature

                                ISymbol legendSym = leg.getSymbolByFeature(myFeature);

                                // compares that both symbols are the same

                                assertEquals(legendSym.getClassName()

                                                + " fails with the comparation of the class symbols",

                                                legendSym, tableSym);

                        }

                }

        }

}