skrueger/geotools/StyledFeatureCollectionTableModel.java

/** SCHMITZM - This file is part of the java library of Martin O.J. Schmitz (SCHMITZM)

    This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
    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., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA

    Diese Bibliothek ist freie Software; Sie dürfen sie unter den Bedingungen der GNU Lesser General Public License, wie von der Free Software Foundation veröffentlicht, weiterverteilen und/oder modifizieren; entweder gemäß Version 2.1 der Lizenz oder (nach Ihrer Option) jeder späteren Version.
    Diese Bibliothek wird in der Hoffnung weiterverbreitet, daß sie nützlich sein wird, jedoch OHNE IRGENDEINE GARANTIE, auch ohne die implizierte Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Mehr Details finden Sie in der GNU Lesser General Public License.
    Sie sollten eine Kopie der GNU Lesser General Public License zusammen mit dieser Bibliothek erhalten haben; falls nicht, schreiben Sie an die Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA.
 **/
package skrueger.geotools;


import java.util.Iterator;
import java.util.Map;
import java.util.TreeMap;
import java.util.Vector;

import org.apache.log4j.Logger;
import org.geotools.data.DefaultQuery;
import org.geotools.data.FeatureSource;
import org.geotools.data.Query;
import org.geotools.data.memory.MemoryDataStore;
import org.geotools.feature.FeatureCollection;
import org.opengis.filter.Filter;

import com.vividsolutions.jts.geom.Envelope;

import schmitzm.geotools.gui.FeatureCollectionTableModel;
import skrueger.AttributeMetaData;
import skrueger.i8n.I8NUtil;
import skrueger.i8n.Translation;

/**
 * This class extends the the {@link FeatureCollectionTableModel} with the
 * functionalities of the {@link AttributeMetaData} of
 * {@linkplain StyledMapInterface styled objects}.
 * <ul>
 *   <li>column names are translated according to {@link AttributeMetaData#getTitle()}</li>
 *   <li>columns are hidden according to {@link AttributeMetaData#isVisible()()}</li>
 * </ul>
 * @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
 */
public class StyledFeatureCollectionTableModel extends FeatureCollectionTableModel {
  final static private Logger LOGGER = Logger.getLogger(StyledFeatureCollectionTableModel.class);
  /** Holds the data source as styled map. */ 
  protected StyledMapInterface<?> map = null;
  /** Contains only the visible elements of the {@link AttributeMetaData}-Map */
  protected Map<Integer, AttributeMetaData> visibleAMD = null;
  /** Holds the data source for the table as {@code FeatureSource}. */
  protected FeatureSource featureSource = null;
  /** Contains the complete {@link AttributeMetaData}-Map of the styled layer. */
  protected Map<Integer, AttributeMetaData> origAMD = null;
  /** Holds the current filter on the table */
  protected Filter filter = null;
  /** Holds the Bounds for all features. Only set once during the constructor **/
  protected Envelope bounds;

  /**
   * Creates a new table model for a styled map.
   * @param map the styled map
   */
  public StyledFeatureCollectionTableModel(StyledFeatureCollectionInterface map) {
    this(map,Filter.INCLUDE);
  }

  /**
   * Creates a new table model for a styled map.
   * @param map the styled map
   * @param filter filter applied to the table
   */
  public StyledFeatureCollectionTableModel(StyledFeatureCollectionInterface map, Filter filter) {
    super();
    setFeatureCollection(map, filter);
  }

  /**
   * Creates a new table model for a styled map.
   * @param map the styled map
   */
  public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map) {
    this(map,Filter.INCLUDE);
  }

  /**
   * Creates a new table model for a styled map.
   * @param map the styled map
   * @param filter filter applied to the table
   */
  public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map, Filter filter) {
    super();
    setFeatureCollection(map, filter);
  }

  /**
   * Sets a new data source for the table.
   * @param fs     the feature source
   * @param amd    {@link AttributeMetaData}-Map to define the visible attributes
   *               and translation
   */
  protected void setFeatureSource(FeatureSource fs, Map<Integer, AttributeMetaData> amd, Filter filter) throws Exception {
    if ( filter == null )
      filter = Filter.INCLUDE;
    
    this.featureSource = fs;
    this.filter        = filter;
    this.origAMD       = amd;
    this.visibleAMD    = null;
    
    FeatureCollection fc = null;
    if (fs != null) {
        
       bounds = fs.getBounds(); 
        
      Query query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
      if (amd != null) {
        // determine the names of the visible Attributes
        this.visibleAMD = StyledMapUtil.getVisibleAttributeMetaData(amd, true);
        Vector<String> visibleAttrNames = new Vector<String>();
        // Add the column with the geometry (usually "the_geom")
        visibleAttrNames.add(fs.getSchema().getDefaultGeometry().getLocalName());
        for (int attrIdx : visibleAMD.keySet())
          visibleAttrNames.add(fs.getSchema().getAttributeType(attrIdx).getLocalName());

        // create a query for the visible attributes
        String[] properties = visibleAttrNames.toArray(new String[0]);
        
        LOGGER.debug("Query contains the following attributes: " + visibleAttrNames);
        
        query = new DefaultQuery(fs.getSchema().getTypeName(), filter, properties);
      }
      fc = fs.getFeatures(query);

// FAILS:!!!, even with  query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
                        // java.lang.UnsupportedOperationException: Unknown feature
                        // attribute: PQM_MOD
                        // at
                        // schmitzm.geotools.feature.FeatureOperationTree.evaluate(FeatureOperationTree.java:93)
                        // bounds = fc.getBounds();
                        // SK, 17.4.2009
                        //      
                        // System.out.println("Filter = "+filter);
                        // System.out.println("Size of FC = "+fc.size());
                        // System.out.println("anz att= "+fc.getNumberOfAttributes());
    }
    setFeatureCollection(fc);
  }

  /**
   * Converts the {@code StyledFeatureCollection} to a {@code FeatureSource}
   * and sets this as the new data source for the table.
   * @param fs     the feature source
   * @param amd    {@link AttributeMetaData}-Map to define the visible attributes
   *               and translation
   */
  public void setFeatureCollection(StyledFeatureCollectionInterface map, Filter filter) {
    this.map = map;
    try {
      if (map == null)
        setFeatureSource(null, null, null);
      else {
        FeatureCollection fc = map.getGeoObject();
        String fcName = fc.getFeatureType().getTypeName();
        FeatureSource fs = new MemoryDataStore(fc).getFeatureSource(fcName);
        setFeatureSource(fs, map.getAttributeMetaDataMap(), filter);
      }
    } catch (Exception err) {
      throw new RuntimeException(err);
    }
  }

  /**
   * Sets the {@code StyledFeatureCollection} as new data source for the table.
   * @param fs     the feature source
   * @param amd    {@link AttributeMetaData}-Map to define the visible attributes
   *               and translation
   */
  public void setFeatureCollection(StyledFeatureSourceInterface map, Filter filter) {
    this.map = map;
    try {
      if (map == null)
        setFeatureSource(null, null, null);
      else
        setFeatureSource(map.getGeoObject(), map.getAttributeMetaDataMap(), filter);
    } catch (Exception err) {
      throw new RuntimeException(err);
    }
  }
  
  /**
   * Resets the filter for the table. 
   * @param filter a filter
   */
  public void setFilter(Filter filter) {
    try{
      setFeatureSource(this.featureSource, this.origAMD, filter);
    } catch (Exception err) {
        LOGGER.error("Setting the filter of the table model", err);
      throw new RuntimeException(err);
    }
  }
  
  /**
   * @return <code>Filter.INCLUDE</code> or the {@link Filter} applied to the Features
   */
  public Filter getFilter() {
          return this.filter;
  }

  /**
   * After calling {@code super.reorganize(.)} this method replaced the
   * column descriptions with the titles of the {@code AttributeMetaData}.
   * @param fireTableStructureChanged indicates whether a table event is
   *        initiated after reorganize
   */
  @Override
  protected void reorganize(boolean fireTableStructureChanged) {
    super.reorganize(false);
    // translate the column names
    if (visibleAMD != null) {
      Iterator<Integer> keys = visibleAMD.keySet().iterator();
      for (int i = 0; i < colNames.length && keys.hasNext(); i++) {
        Translation title = visibleAMD.get(keys.next()).getTitle();
        if (!I8NUtil.isEmpty(title)) {
//          System.out.println("set colname " + i + " to " + title.toString());
          colNames[i] = title.toString();
        }
      }
    }
    if ( fireTableStructureChanged )
      fireTableStructureChanged();
  }

  /**
         * @returns Cached bounds for the whole dataset (without applying the
         *          filter) or <code>null</code>
         */
        public Envelope getBounds() {
                return bounds;
        }
}
1	mojays	47	/** SCHMITZM - This file is part of the java library of Martin O.J. Schmitz (SCHMITZM)
2
3			This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
4			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.
5			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., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
6
7			Diese Bibliothek ist freie Software; Sie dürfen sie unter den Bedingungen der GNU Lesser General Public License, wie von der Free Software Foundation veröffentlicht, weiterverteilen und/oder modifizieren; entweder gemäß Version 2.1 der Lizenz oder (nach Ihrer Option) jeder späteren Version.
8			Diese Bibliothek wird in der Hoffnung weiterverbreitet, daß sie nützlich sein wird, jedoch OHNE IRGENDEINE GARANTIE, auch ohne die implizierte Garantie der MARKTREIFE oder der VERWENDBARKEIT FÜR EINEN BESTIMMTEN ZWECK. Mehr Details finden Sie in der GNU Lesser General Public License.
9			Sie sollten eine Kopie der GNU Lesser General Public License zusammen mit dieser Bibliothek erhalten haben; falls nicht, schreiben Sie an die Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA.
10			**/
11	mojays	46	package skrueger.geotools;
12
13	alfonx	111
14	mojays	52	import java.util.Iterator;
15			import java.util.Map;
16			import java.util.TreeMap;
17			import java.util.Vector;
18
19	alfonx	111	import org.apache.log4j.Logger;
20	mojays	52	import org.geotools.data.DefaultQuery;
21			import org.geotools.data.FeatureSource;
22			import org.geotools.data.Query;
23			import org.geotools.data.memory.MemoryDataStore;
24			import org.geotools.feature.FeatureCollection;
25			import org.opengis.filter.Filter;
26
27	alfonx	62	import com.vividsolutions.jts.geom.Envelope;
28
29	mojays	46	import schmitzm.geotools.gui.FeatureCollectionTableModel;
30	mojays	52	import skrueger.AttributeMetaData;
31	mojays	55	import skrueger.i8n.I8NUtil;
32			import skrueger.i8n.Translation;
33	mojays	46
34	mojays	52	/**
35	mojays	53	* This class extends the the {@link FeatureCollectionTableModel} with the
36	alfonx	56	* functionalities of the {@link AttributeMetaData} of
37			* {@linkplain StyledMapInterface styled objects}.
38	mojays	53	* <ul>
39	mojays	58	* <li>column names are translated according to {@link AttributeMetaData#getTitle()}</li>
40			* <li>columns are hidden according to {@link AttributeMetaData#isVisible()()}</li>
41	alfonx	56	* </ul>
42	mojays	58	* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
43	mojays	52	*/
44	mojays	58	public class StyledFeatureCollectionTableModel extends FeatureCollectionTableModel {
45	alfonx	111	final static private Logger LOGGER = Logger.getLogger(StyledFeatureCollectionTableModel.class);
46	mojays	58	/** Holds the data source as styled map. */
47	alfonx	111	protected StyledMapInterface<?> map = null;
48	mojays	58	/** Contains only the visible elements of the {@link AttributeMetaData}-Map */
49	mojays	57	protected Map<Integer, AttributeMetaData> visibleAMD = null;
50	mojays	58	/** Holds the data source for the table as {@code FeatureSource}. */
51			protected FeatureSource featureSource = null;
52	mojays	59	/** Contains the complete {@link AttributeMetaData}-Map of the styled layer. */
53			protected Map<Integer, AttributeMetaData> origAMD = null;
54	mojays	58	/** Holds the current filter on the table */
55			protected Filter filter = null;
56	alfonx	62	/ Holds the Bounds for all features. Only set once during the constructor /
57			protected Envelope bounds;
58	alfonx	56
59	mojays	58	/**
60			* Creates a new table model for a styled map.
61			* @param map the styled map
62			*/
63	mojays	57	public StyledFeatureCollectionTableModel(StyledFeatureCollectionInterface map) {
64			this(map,Filter.INCLUDE);
65			}
66	alfonx	56
67	mojays	58	/**
68			* Creates a new table model for a styled map.
69			* @param map the styled map
70			* @param filter filter applied to the table
71			*/
72	mojays	57	public StyledFeatureCollectionTableModel(StyledFeatureCollectionInterface map, Filter filter) {
73			super();
74			setFeatureCollection(map, filter);
75			}
76	alfonx	56
77	mojays	58	/**
78			* Creates a new table model for a styled map.
79			* @param map the styled map
80			*/
81	mojays	57	public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map) {
82			this(map,Filter.INCLUDE);
83			}
84	alfonx	56
85	mojays	58	/**
86			* Creates a new table model for a styled map.
87			* @param map the styled map
88			* @param filter filter applied to the table
89			*/
90	mojays	57	public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map, Filter filter) {
91			super();
92			setFeatureCollection(map, filter);
93			}
94	alfonx	56
95	mojays	58	/**
96			* Sets a new data source for the table.
97			* @param fs the feature source
98			* @param amd {@link AttributeMetaData}-Map to define the visible attributes
99			* and translation
100			*/
101	mojays	57	protected void setFeatureSource(FeatureSource fs, Map<Integer, AttributeMetaData> amd, Filter filter) throws Exception {
102			if ( filter == null )
103			filter = Filter.INCLUDE;
104	alfonx	62
105	mojays	58	this.featureSource = fs;
106			this.filter = filter;
107	mojays	59	this.origAMD = amd;
108	mojays	58	this.visibleAMD = null;
109	mojays	57
110			FeatureCollection fc = null;
111			if (fs != null) {
112	alfonx	62
113			bounds = fs.getBounds();
114
115			Query query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
116	mojays	57	if (amd != null) {
117			// determine the names of the visible Attributes
118			this.visibleAMD = StyledMapUtil.getVisibleAttributeMetaData(amd, true);
119			Vector<String> visibleAttrNames = new Vector<String>();
120			// Add the column with the geometry (usually "the_geom")
121			visibleAttrNames.add(fs.getSchema().getDefaultGeometry().getLocalName());
122			for (int attrIdx : visibleAMD.keySet())
123			visibleAttrNames.add(fs.getSchema().getAttributeType(attrIdx).getLocalName());
124	alfonx	56
125	mojays	57	// create a query for the visible attributes
126			String[] properties = visibleAttrNames.toArray(new String[0]);
127	alfonx	62
128	alfonx	111	LOGGER.debug("Query contains the following attributes: " + visibleAttrNames);
129
130	mojays	57	query = new DefaultQuery(fs.getSchema().getTypeName(), filter, properties);
131			}
132			fc = fs.getFeatures(query);
133	alfonx	62
134			// FAILS:!!!, even with query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
135			// java.lang.UnsupportedOperationException: Unknown feature
136			// attribute: PQM_MOD
137			// at
138			// schmitzm.geotools.feature.FeatureOperationTree.evaluate(FeatureOperationTree.java:93)
139			// bounds = fc.getBounds();
140			// SK, 17.4.2009
141			//
142			// System.out.println("Filter = "+filter);
143			// System.out.println("Size of FC = "+fc.size());
144			// System.out.println("anz att= "+fc.getNumberOfAttributes());
145	mojays	57	}
146			setFeatureCollection(fc);
147			}
148	alfonx	56
149	mojays	58	/**
150			* Converts the {@code StyledFeatureCollection} to a {@code FeatureSource}
151			* and sets this as the new data source for the table.
152			* @param fs the feature source
153			* @param amd {@link AttributeMetaData}-Map to define the visible attributes
154			* and translation
155			*/
156	mojays	57	public void setFeatureCollection(StyledFeatureCollectionInterface map, Filter filter) {
157	mojays	58	this.map = map;
158	mojays	57	try {
159			if (map == null)
160			setFeatureSource(null, null, null);
161			else {
162			FeatureCollection fc = map.getGeoObject();
163			String fcName = fc.getFeatureType().getTypeName();
164			FeatureSource fs = new MemoryDataStore(fc).getFeatureSource(fcName);
165			setFeatureSource(fs, map.getAttributeMetaDataMap(), filter);
166			}
167			} catch (Exception err) {
168			throw new RuntimeException(err);
169			}
170			}
171	alfonx	56
172	mojays	58	/**
173			* Sets the {@code StyledFeatureCollection} as new data source for the table.
174			* @param fs the feature source
175			* @param amd {@link AttributeMetaData}-Map to define the visible attributes
176			* and translation
177			*/
178	mojays	57	public void setFeatureCollection(StyledFeatureSourceInterface map, Filter filter) {
179	mojays	58	this.map = map;
180	mojays	57	try {
181			if (map == null)
182			setFeatureSource(null, null, null);
183			else
184			setFeatureSource(map.getGeoObject(), map.getAttributeMetaDataMap(), filter);
185			} catch (Exception err) {
186			throw new RuntimeException(err);
187			}
188			}
189	mojays	58
190			/**
191			* Resets the filter for the table.
192			* @param filter a filter
193			*/
194			public void setFilter(Filter filter) {
195			try{
196	mojays	59	setFeatureSource(this.featureSource, this.origAMD, filter);
197	mojays	58	} catch (Exception err) {
198	alfonx	111	LOGGER.error("Setting the filter of the table model", err);
199	mojays	58	throw new RuntimeException(err);
200			}
201			}
202	alfonx	62
203			/**
204			* @return <code>Filter.INCLUDE</code> or the {@link Filter} applied to the Features
205			*/
206			public Filter getFilter() {
207			return this.filter;
208			}
209	alfonx	56
210	mojays	58	/**
211			* After calling {@code super.reorganize(.)} this method replaced the
212			* column descriptions with the titles of the {@code AttributeMetaData}.
213			* @param fireTableStructureChanged indicates whether a table event is
214			* initiated after reorganize
215			*/
216	mojays	57	@Override
217	mojays	58	protected void reorganize(boolean fireTableStructureChanged) {
218			super.reorganize(false);
219	mojays	57	// translate the column names
220			if (visibleAMD != null) {
221			Iterator<Integer> keys = visibleAMD.keySet().iterator();
222			for (int i = 0; i < colNames.length && keys.hasNext(); i++) {
223			Translation title = visibleAMD.get(keys.next()).getTitle();
224			if (!I8NUtil.isEmpty(title)) {
225	alfonx	62	// System.out.println("set colname " + i + " to " + title.toString());
226	mojays	57	colNames[i] = title.toString();
227			}
228			}
229			}
230	mojays	58	if ( fireTableStructureChanged )
231			fireTableStructureChanged();
232	mojays	57	}
233	alfonx	62
234			/**
235			* @returns Cached bounds for the whole dataset (without applying the
236			* filter) or <code>null</code>
237			*/
238			public Envelope getBounds() {
239			return bounds;
240			}
241	mojays	46	}