geotools/labelsearch/SearchResult.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. Krüger - additional utility classes
 ******************************************************************************/
package skrueger.geotools.labelsearch;

import java.util.Map;

import org.geotools.feature.Feature;

public interface SearchResult {

        /**
         * @return a {@link String} that represents the Title/Name of this search
         *          result.
         * 
         */
        String getTitle();

        /**
         * "Open" the result. For a {@link Feature} that mean to zoom to the
         * location. For a {@link Map} if means to open the {@link Map}.
         */
        void open();

        /**
         * @return a {@link String} that represents the Title/Name of "something" that contains the search
         *          result. This may return "" if it makes no sense.
         */
        String getInTitle();

}
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			* Stefan A. Krüger - additional utility classes
29			******************************************************************************/
30	alfonx	139	package skrueger.geotools.labelsearch;
31
32	alfonx	154	import java.util.Map;
33	alfonx	162
34	alfonx	139	import org.geotools.feature.Feature;
35
36			public interface SearchResult {
37
38			/**
39	alfonx	145	* @return a {@link String} that represents the Title/Name of this search
40	alfonx	139	* result.
41			*
42			*/
43			String getTitle();
44
45			/**
46			* "Open" the result. For a {@link Feature} that mean to zoom to the
47			* location. For a {@link Map} if means to open the {@link Map}.
48			*/
49			void open();
50
51			/**
52	alfonx	145	* @return a {@link String} that represents the Title/Name of "something" that contains the search
53	alfonx	139	* result. This may return "" if it makes no sense.
54			*/
55			String getInTitle();
56
57			}
Name	Value
svn:eol-style	native
svn:keywords	Id
svn:mime-type	text/plain