geotools/labelsearch/LabelSearch.java

/*******************************************************************************
 * Copyright (c) 2009 Martin O. J. Schmitz.
 * 
 * This file is part of the SCHMITZM library - a collection of utility 
 * classes based on Java 1.6, focusing (not only) on Java Swing 
 * and the Geotools library.
 * 
 * The SCHMITZM project is hosted at:
 * http://wald.intevation.org/projects/schmitzm/
 * 
 * This program 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 3
 * 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 Lesser General Public License (license.txt)
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 * or try this link: http://www.gnu.org/licenses/lgpl.html
 * 
 * Contributors:
 *     Martin O. J. Schmitz - initial API and implementation
 *     Stefan A. Tzeggai - additional utility classes
 ******************************************************************************/
package skrueger.geotools.labelsearch;

import java.io.IOException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;

import org.apache.log4j.Logger;
import org.geotools.data.DefaultQuery;
import org.geotools.data.FeatureSource;
import org.geotools.feature.FeatureCollection;
import org.geotools.filter.text.cql2.CQL;
import org.geotools.filter.text.cql2.CQLException;
import org.geotools.map.MapLayer;
import org.geotools.styling.Style;
import org.geotools.styling.TextSymbolizer;
import org.opengis.feature.simple.SimpleFeature;
import org.opengis.feature.simple.SimpleFeatureType;
import org.opengis.filter.Filter;
import org.opengis.filter.expression.PropertyName;

import schmitzm.geotools.feature.FeatureUtil;
import schmitzm.geotools.gui.GeotoolsGUIUtil;
import schmitzm.geotools.styling.StylingUtil;
import schmitzm.lang.LangUtil;

/**
 * This class allows to search for a {@link String} in a map. The algorithm will
 * analyze the {@link Style} of every visible(?) layer and determine the label
 * attribute. This field is then searched for every feature.
 * 
 * @author Stefan A. Tzeggai
 * 
 */
public class LabelSearch {
        final static private Logger LOGGER = Logger.getLogger(LabelSearch.class);

        public static String R(String key, Object... values) {
                return GeotoolsGUIUtil.R(key, values);
        }

        protected final schmitzm.geotools.gui.SelectableXMapPane mapPane;

        public LabelSearch(final schmitzm.geotools.gui.SelectableXMapPane mapPane) {
                this.mapPane = mapPane;
        }

        public List<SearchResult> search(final String string) {

                final String searchMe = string.toUpperCase();

                final ArrayList<SearchResult> hits = new ArrayList<SearchResult>();

                for (final MapLayer ml : mapPane.getMapContext().getLayers()) {
                        try {

                                // System.out.println("layer = "+ml.getTitle());

                                if (!ml.isVisible())
                                        continue;

                                final List<TextSymbolizer> allTS = StylingUtil
                                                .getVisibleTextSymbolizers(ml.getStyle());
                                if (allTS.size() == 0) {
                                        // A layer without any TextSymbolizer doesn't have to be
                                        // searched any more.
                                        continue;
                                }

                                // We only deal with one TextSymbolizer so far:
                                TextSymbolizer ts = allTS.get(0);

                                final FeatureSource<SimpleFeatureType, SimpleFeature> featureSource = (FeatureSource<SimpleFeatureType, SimpleFeature>) ml
                                                .getFeatureSource();

                                SimpleFeatureType schema = featureSource.getSchema();

                                final String typeName = schema.getName().getLocalPart();

                                PropertyName prop1 = StylingUtil.getFirstPropertyName(schema,
                                                ts);
                                PropertyName prop2 = StylingUtil.getSecondPropertyName(schema,
                                                ts);

                                if (StylingUtil.getFirstPropertyName(schema, ts) == null) {
                                        // At least one property field we need
                                        continue;
                                }

                                Filter searchFilter;
                                String[] properties = new String[] { schema.getGeometryDescriptor().getLocalName(), prop1.getPropertyName() };
                                // Only one property used...

                                searchFilter = CQL.toFilter("strToUpperCase "
                                                + prop1.getPropertyName() + " LIKE '%" + searchMe
                                                + "%'");

                                if (prop2 != null) {
                                        Filter searchFilter2 = CQL.toFilter("strToUpperCase "
                                                        + prop2.getPropertyName() + " LIKE '%" + searchMe
                                                        + "%'");

                                        searchFilter = FeatureUtil.FILTER_FACTORY2.or(searchFilter,
                                                        searchFilter2);

                                        properties = LangUtil.extendArray(properties, prop2
                                                        .getPropertyName());
                                }

                                // Add the layer's filter if it exists
                                Filter layerFilter = ml.getQuery().getFilter();
                                if (layerFilter != null && layerFilter != Filter.INCLUDE) {
                                        searchFilter = FeatureUtil.FILTER_FACTORY2.and(layerFilter,
                                                        searchFilter);
                                }
                                
//                              LOGGER.info("Searching for "+searchFilter.toString());

                                FeatureCollection<SimpleFeatureType, SimpleFeature> features = (FeatureCollection<SimpleFeatureType, SimpleFeature>) ml
                                                .getFeatureSource().getFeatures(
                                                                new DefaultQuery(typeName, searchFilter,
                                                                                properties));

                                final Iterator<SimpleFeature> fi = features.iterator();
                                try {
                                        while (fi.hasNext()) {
                                                final SimpleFeature f = fi.next();

                                                String valueString = "";
                                                valueString = f.getAttribute(prop1.getPropertyName())
                                                                .toString();

                                                if (prop2 != null) {
                                                        String valueString2 = f.getAttribute(
                                                                        prop2.getPropertyName()).toString();

                                                        if (valueString2 != null && !valueString2.isEmpty())
                                                                valueString += ", " + valueString2;
                                                }

                                                hits.add(createSearchResult(f, valueString, ml
                                                                .getTitle(), ml));
                                        }
                                } finally {
                                        features.close(fi);
                                }
                        } catch (final IOException e) {
                                // Searching this layer failed
                                LOGGER.error("",e);
                        } catch (CQLException e) {
                                LOGGER.error("",e);
                        }
                } // next layer

                // Hits from the top-most layer should appear first.
                Collections.reverse(hits);

                return hits;
        }

        protected SearchResult createSearchResult(final SimpleFeature f,
                        final String title, final String inTitle, MapLayer ml) {
                return new SearchResultFeature(f, title, inTitle, mapPane, ml);
        }

}
1	alfonx	244	/*******************************************************************************
2			* Copyright (c) 2009 Martin O. J. Schmitz.
3			*
4			* This file is part of the SCHMITZM library - a collection of utility
5	alfonx	256	* classes based on Java 1.6, focusing (not only) on Java Swing
6	alfonx	244	* and the Geotools library.
7			*
8			* The SCHMITZM project is hosted at:
9			* http://wald.intevation.org/projects/schmitzm/
10			*
11			* This program is free software; you can redistribute it and/or
12			* modify it under the terms of the GNU Lesser General Public License
13			* as published by the Free Software Foundation; either version 3
14			* of the License, or (at your option) any later version.
15			*
16			* This program is distributed in the hope that it will be useful,
17			* but WITHOUT ANY WARRANTY; without even the implied warranty of
18			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			* GNU General Public License for more details.
20			*
21			* You should have received a copy of the GNU Lesser General Public License (license.txt)
22			* along with this program; if not, write to the Free Software
23			* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24			* or try this link: http://www.gnu.org/licenses/lgpl.html
25			*
26			* Contributors:
27			* Martin O. J. Schmitz - initial API and implementation
28	alfonx	862	* Stefan A. Tzeggai - additional utility classes
29	alfonx	244	******************************************************************************/
30	alfonx	139	package skrueger.geotools.labelsearch;
31
32			import java.io.IOException;
33			import java.util.ArrayList;
34			import java.util.Collections;
35			import java.util.Iterator;
36			import java.util.List;
37
38			import org.apache.log4j.Logger;
39			import org.geotools.data.DefaultQuery;
40	alfonx	335	import org.geotools.data.FeatureSource;
41	alfonx	139	import org.geotools.feature.FeatureCollection;
42	alfonx	607	import org.geotools.filter.text.cql2.CQL;
43			import org.geotools.filter.text.cql2.CQLException;
44	alfonx	139	import org.geotools.map.MapLayer;
45			import org.geotools.styling.Style;
46			import org.geotools.styling.TextSymbolizer;
47	mojays	325	import org.opengis.feature.simple.SimpleFeature;
48			import org.opengis.feature.simple.SimpleFeatureType;
49	alfonx	139	import org.opengis.filter.Filter;
50			import org.opengis.filter.expression.PropertyName;
51
52	alfonx	607	import schmitzm.geotools.feature.FeatureUtil;
53	alfonx	886	import schmitzm.geotools.gui.GeotoolsGUIUtil;
54	alfonx	139	import schmitzm.geotools.styling.StylingUtil;
55			import schmitzm.lang.LangUtil;
56
57			/**
58			* This class allows to search for a {@link String} in a map. The algorithm will
59			* analyze the {@link Style} of every visible(?) layer and determine the label
60			* attribute. This field is then searched for every feature.
61			*
62	alfonx	862	* @author Stefan A. Tzeggai
63	alfonx	139	*
64			*/
65			public class LabelSearch {
66			final static private Logger LOGGER = Logger.getLogger(LabelSearch.class);
67	alfonx	456
68	alfonx	139	public static String R(String key, Object... values) {
69	alfonx	886	return GeotoolsGUIUtil.R(key, values);
70	alfonx	139	}
71
72	alfonx	509	protected final schmitzm.geotools.gui.SelectableXMapPane mapPane;
73	alfonx	139
74	alfonx	509	public LabelSearch(final schmitzm.geotools.gui.SelectableXMapPane mapPane) {
75	alfonx	139	this.mapPane = mapPane;
76			}
77
78			public List<SearchResult> search(final String string) {
79
80	alfonx	607	final String searchMe = string.toUpperCase();
81	alfonx	139
82			final ArrayList<SearchResult> hits = new ArrayList<SearchResult>();
83
84	alfonx	551	for (final MapLayer ml : mapPane.getMapContext().getLayers()) {
85	alfonx	139	try {
86
87			// System.out.println("layer = "+ml.getTitle());
88
89			if (!ml.isVisible())
90			continue;
91
92	alfonx	456	final List<TextSymbolizer> allTS = StylingUtil
93			.getVisibleTextSymbolizers(ml.getStyle());
94	alfonx	139	if (allTS.size() == 0) {
95			// A layer without any TextSymbolizer doesn't have to be
96			// searched any more.
97			continue;
98			}
99
100	alfonx	607	// We only deal with one TextSymbolizer so far:
101			TextSymbolizer ts = allTS.get(0);
102
103	alfonx	456	final FeatureSource<SimpleFeatureType, SimpleFeature> featureSource = (FeatureSource<SimpleFeatureType, SimpleFeature>) ml
104			.getFeatureSource();
105
106	alfonx	607	SimpleFeatureType schema = featureSource.getSchema();
107	alfonx	456
108	alfonx	607	final String typeName = schema.getName().getLocalPart();
109	alfonx	139
110	alfonx	607	PropertyName prop1 = StylingUtil.getFirstPropertyName(schema,
111			ts);
112			PropertyName prop2 = StylingUtil.getSecondPropertyName(schema,
113			ts);
114	alfonx	139
115	alfonx	607	if (StylingUtil.getFirstPropertyName(schema, ts) == null) {
116			// At least one property field we need
117			continue;
118			}
119	alfonx	139
120	alfonx	607	Filter searchFilter;
121			String[] properties = new String[] { schema.getGeometryDescriptor().getLocalName(), prop1.getPropertyName() };
122			// Only one property used...
123	alfonx	139
124	alfonx	607	searchFilter = CQL.toFilter("strToUpperCase "
125			+ prop1.getPropertyName() + " LIKE '%" + searchMe
126			+ "%'");
127	alfonx	139
128	alfonx	607	if (prop2 != null) {
129			Filter searchFilter2 = CQL.toFilter("strToUpperCase "
130			+ prop2.getPropertyName() + " LIKE '%" + searchMe
131			+ "%'");
132	alfonx	139
133	alfonx	607	searchFilter = FeatureUtil.FILTER_FACTORY2.or(searchFilter,
134			searchFilter2);
135	alfonx	139
136	alfonx	607	properties = LangUtil.extendArray(properties, prop2
137			.getPropertyName());
138			}
139	alfonx	139
140	alfonx	607	// Add the layer's filter if it exists
141			Filter layerFilter = ml.getQuery().getFilter();
142			if (layerFilter != null && layerFilter != Filter.INCLUDE) {
143			searchFilter = FeatureUtil.FILTER_FACTORY2.and(layerFilter,
144			searchFilter);
145			}
146
147			// LOGGER.info("Searching for "+searchFilter.toString());
148	alfonx	139
149	alfonx	607	FeatureCollection<SimpleFeatureType, SimpleFeature> features = (FeatureCollection<SimpleFeatureType, SimpleFeature>) ml
150			.getFeatureSource().getFeatures(
151			new DefaultQuery(typeName, searchFilter,
152			properties));
153	alfonx	139
154	alfonx	607	final Iterator<SimpleFeature> fi = features.iterator();
155			try {
156			while (fi.hasNext()) {
157			final SimpleFeature f = fi.next();
158	alfonx	139
159	alfonx	607	String valueString = "";
160			valueString = f.getAttribute(prop1.getPropertyName())
161			.toString();
162	alfonx	456
163	alfonx	607	if (prop2 != null) {
164			String valueString2 = f.getAttribute(
165			prop2.getPropertyName()).toString();
166
167			if (valueString2 != null && !valueString2.isEmpty())
168			valueString += ", " + valueString2;
169	alfonx	139	}
170	alfonx	456
171	alfonx	607	hits.add(createSearchResult(f, valueString, ml
172			.getTitle(), ml));
173	alfonx	139	}
174	alfonx	456	} finally {
175			features.close(fi);
176	alfonx	139	}
177			} catch (final IOException e) {
178			// Searching this layer failed
179	alfonx	607	LOGGER.error("",e);
180			} catch (CQLException e) {
181			LOGGER.error("",e);
182	alfonx	139	}
183			} // next layer
184
185			// Hits from the top-most layer should appear first.
186			Collections.reverse(hits);
187
188			return hits;
189			}
190
191	alfonx	456	protected SearchResult createSearchResult(final SimpleFeature f,
192			final String title, final String inTitle, MapLayer ml) {
193	alfonx	153	return new SearchResultFeature(f, title, inTitle, mapPane, ml);
194	alfonx	139	}
195
196			}
Name	Value
svn:eol-style	native
svn:keywords	Id
svn:mime-type	text/plain