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.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 schmitzm.geotools.gui.FeatureCollectionTableModel;
import skrueger.AttributeMetaData;
import skrueger.i8n.I8NUtil;
import skrueger.i8n.Translation;

import com.vividsolutions.jts.geom.Envelope;

/**
 * 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.getSchema().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	/** 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	package skrueger.geotools;
12
13
14	import java.util.Iterator;
15	import java.util.Map;
16	import java.util.Vector;
17
18	import org.apache.log4j.Logger;
19	import org.geotools.data.DefaultQuery;
20	import org.geotools.data.FeatureSource;
21	import org.geotools.data.Query;
22	import org.geotools.data.memory.MemoryDataStore;
23	import org.geotools.feature.FeatureCollection;
24	import org.opengis.filter.Filter;
25
26	import schmitzm.geotools.gui.FeatureCollectionTableModel;
27	import skrueger.AttributeMetaData;
28	import skrueger.i8n.I8NUtil;
29	import skrueger.i8n.Translation;
30
31	import com.vividsolutions.jts.geom.Envelope;
32
33	/**
34	* This class extends the the {@link FeatureCollectionTableModel} with the
35	* functionalities of the {@link AttributeMetaData} of
36	* {@linkplain StyledMapInterface styled objects}.
37	* <ul>
38	* <li>column names are translated according to {@link AttributeMetaData#getTitle()}</li>
39	* <li>columns are hidden according to {@link AttributeMetaData#isVisible()()}</li>
40	* </ul>
41	* @author <a href="mailto:[email protected]">Martin Schmitz</a> (University of Bonn/Germany)
42	*/
43	public class StyledFeatureCollectionTableModel extends FeatureCollectionTableModel {
44	final static private Logger LOGGER = Logger.getLogger(StyledFeatureCollectionTableModel.class);
45	/** Holds the data source as styled map. */
46	protected StyledMapInterface<?> map = null;
47	/** Contains only the visible elements of the {@link AttributeMetaData}-Map */
48	protected Map<Integer, AttributeMetaData> visibleAMD = null;
49	/** Holds the data source for the table as {@code FeatureSource}. */
50	protected FeatureSource featureSource = null;
51	/** Contains the complete {@link AttributeMetaData}-Map of the styled layer. */
52	protected Map<Integer, AttributeMetaData> origAMD = null;
53	/** Holds the current filter on the table */
54	protected Filter filter = null;
55	/ Holds the Bounds for all features. Only set once during the constructor /
56	protected Envelope bounds;
57
58	/**
59	* Creates a new table model for a styled map.
60	* @param map the styled map
61	*/
62	public StyledFeatureCollectionTableModel(StyledFeatureCollectionInterface map) {
63	this(map,Filter.INCLUDE);
64	}
65
66	/**
67	* Creates a new table model for a styled map.
68	* @param map the styled map
69	* @param filter filter applied to the table
70	*/
71	public StyledFeatureCollectionTableModel(StyledFeatureCollectionInterface map, Filter filter) {
72	super();
73	setFeatureCollection(map, filter);
74	}
75
76	/**
77	* Creates a new table model for a styled map.
78	* @param map the styled map
79	*/
80	public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map) {
81	this(map,Filter.INCLUDE);
82	}
83
84	/**
85	* Creates a new table model for a styled map.
86	* @param map the styled map
87	* @param filter filter applied to the table
88	*/
89	public StyledFeatureCollectionTableModel(StyledFeatureSourceInterface map, Filter filter) {
90	super();
91	setFeatureCollection(map, filter);
92	}
93
94	/**
95	* Sets a new data source for the table.
96	* @param fs the feature source
97	* @param amd {@link AttributeMetaData}-Map to define the visible attributes
98	* and translation
99	*/
100	protected void setFeatureSource(FeatureSource fs, Map<Integer, AttributeMetaData> amd, Filter filter) throws Exception {
101	if ( filter == null )
102	filter = Filter.INCLUDE;
103
104	this.featureSource = fs;
105	this.filter = filter;
106	this.origAMD = amd;
107	this.visibleAMD = null;
108
109	FeatureCollection fc = null;
110	if (fs != null) {
111
112	bounds = fs.getBounds();
113
114	Query query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
115	if (amd != null) {
116	// determine the names of the visible Attributes
117	this.visibleAMD = StyledMapUtil.getVisibleAttributeMetaData(amd, true);
118	Vector<String> visibleAttrNames = new Vector<String>();
119	// Add the column with the geometry (usually "the_geom")
120	visibleAttrNames.add(fs.getSchema().getDefaultGeometry().getLocalName());
121	for (int attrIdx : visibleAMD.keySet())
122	visibleAttrNames.add(fs.getSchema().getAttributeType(attrIdx).getLocalName());
123
124	// create a query for the visible attributes
125	String[] properties = visibleAttrNames.toArray(new String[0]);
126
127	LOGGER.debug("Query contains the following attributes: " + visibleAttrNames);
128
129	query = new DefaultQuery(fs.getSchema().getTypeName(), filter, properties);
130	}
131	fc = fs.getFeatures(query);
132
133	// FAILS:!!!, even with query = new DefaultQuery(fs.getSchema().getTypeName(), filter);
134	// java.lang.UnsupportedOperationException: Unknown feature
135	// attribute: PQM_MOD
136	// at
137	// schmitzm.geotools.feature.FeatureOperationTree.evaluate(FeatureOperationTree.java:93)
138	// bounds = fc.getBounds();
139	// SK, 17.4.2009
140	//
141	// System.out.println("Filter = "+filter);
142	// System.out.println("Size of FC = "+fc.size());
143	// System.out.println("anz att= "+fc.getNumberOfAttributes());
144	}
145	setFeatureCollection(fc);
146	}
147
148	/**
149	* Converts the {@code StyledFeatureCollection} to a {@code FeatureSource}
150	* and sets this as the new data source for the table.
151	* @param fs the feature source
152	* @param amd {@link AttributeMetaData}-Map to define the visible attributes
153	* and translation
154	*/
155	public void setFeatureCollection(StyledFeatureCollectionInterface map, Filter filter) {
156	this.map = map;
157	try {
158	if (map == null)
159	setFeatureSource(null, null, null);
160	else {
161	FeatureCollection fc = map.getGeoObject();
162	String fcName = fc.getSchema().getTypeName();
163	FeatureSource fs = new MemoryDataStore(fc).getFeatureSource(fcName);
164	setFeatureSource(fs, map.getAttributeMetaDataMap(), filter);
165	}
166	} catch (Exception err) {
167	throw new RuntimeException(err);
168	}
169	}
170
171	/**
172	* Sets the {@code StyledFeatureCollection} as new data source for the table.
173	* @param fs the feature source
174	* @param amd {@link AttributeMetaData}-Map to define the visible attributes
175	* and translation
176	*/
177	public void setFeatureCollection(StyledFeatureSourceInterface map, Filter filter) {
178	this.map = map;
179	try {
180	if (map == null)
181	setFeatureSource(null, null, null);
182	else
183	setFeatureSource(map.getGeoObject(), map.getAttributeMetaDataMap(), filter);
184	} catch (Exception err) {
185	throw new RuntimeException(err);
186	}
187	}
188
189	/**
190	* Resets the filter for the table.
191	* @param filter a filter
192	*/
193	public void setFilter(Filter filter) {
194	try{
195	setFeatureSource(this.featureSource, this.origAMD, filter);
196	} catch (Exception err) {
197	LOGGER.error("Setting the filter of the table model", err);
198	throw new RuntimeException(err);
199	}
200	}
201
202	/**
203	* @return <code>Filter.INCLUDE</code> or the {@link Filter} applied to the Features
204	*/
205	public Filter getFilter() {
206	return this.filter;
207	}
208
209	/**
210	* After calling {@code super.reorganize(.)} this method replaced the
211	* column descriptions with the titles of the {@code AttributeMetaData}.
212	* @param fireTableStructureChanged indicates whether a table event is
213	* initiated after reorganize
214	*/
215	@Override
216	protected void reorganize(boolean fireTableStructureChanged) {
217	super.reorganize(false);
218	// translate the column names
219	if (visibleAMD != null) {
220	Iterator<Integer> keys = visibleAMD.keySet().iterator();
221	for (int i = 0; i < colNames.length && keys.hasNext(); i++) {
222	Translation title = visibleAMD.get(keys.next()).getTitle();
223	if (!I8NUtil.isEmpty(title)) {
224	// System.out.println("set colname " + i + " to " + title.toString());
225	colNames[i] = title.toString();
226	}
227	}
228	}
229	if ( fireTableStructureChanged )
230	fireTableStructureChanged();
231	}
232
233	/**
234	* @returns Cached bounds for the whole dataset (without applying the
235	* filter) or <code>null</code>
236	*/
237	public Envelope getBounds() {
238	return bounds;
239	}
240	}