001 //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.3_testing/src/org/deegree/model/filterencoding/Filter.java $
002 /*----------------------------------------------------------------------------
003 This file is part of deegree, http://deegree.org/
004 Copyright (C) 2001-2009 by:
005 Department of Geography, University of Bonn
006 and
007 lat/lon GmbH
008
009 This library is free software; you can redistribute it and/or modify it under
010 the terms of the GNU Lesser General Public License as published by the Free
011 Software Foundation; either version 2.1 of the License, or (at your option)
012 any later version.
013 This library is distributed in the hope that it will be useful, but WITHOUT
014 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
015 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
016 details.
017 You should have received a copy of the GNU Lesser General Public License
018 along with this library; if not, write to the Free Software Foundation, Inc.,
019 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
020
021 Contact information:
022
023 lat/lon GmbH
024 Aennchenstr. 19, 53177 Bonn
025 Germany
026 http://lat-lon.de/
027
028 Department of Geography, University of Bonn
029 Prof. Dr. Klaus Greve
030 Postfach 1147, 53001 Bonn
031 Germany
032 http://www.geographie.uni-bonn.de/deegree/
033
034 e-mail: info@deegree.org
035 ----------------------------------------------------------------------------*/
036
037 package org.deegree.model.filterencoding;
038
039 import org.deegree.model.feature.Feature;
040
041 /**
042 * Marker interface for filters from the Filter Encoding Specification.
043 *
044 * @author <a href="mailto:schneider@lat-lon.de">Markus Schneider</a>
045 * @author last edited by: $Author: mschneider $
046 *
047 * @version $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18. Jun 2009) $
048 */
049 public interface Filter {
050
051 /**
052 * Calculates the <code>Filter</code>'s logical value based on the certain property values of the given feature.
053 *
054 * @param feature
055 * determines the values of <code>PropertyNames</code> in the expression
056 * @return true, if the <code>Filter</code> evaluates to true, else false
057 * @throws FilterEvaluationException
058 * if the evaluation fails
059 */
060 boolean evaluate( Feature feature )
061 throws FilterEvaluationException;
062
063 /**
064 * Produces an XML representation of this object.
065 *
066 * @deprecated use {@link #to100XML()} or {link {@link #to110XML()} instead
067 * @return an XML representation of this object
068 */
069 public StringBuffer toXML();
070
071 /**
072 * Produces an XML representation of this object that complies to Filter Encoding specification 1.0.0.
073 *
074 * @return an XML representation of this object
075 */
076 public StringBuffer to100XML();
077
078 /**
079 * Produces an XML representation of this object that complies to Filter Encoding specification 1.1.0.
080 *
081 * @return an XML representation of this object
082 */
083 public StringBuffer to110XML();
084 }