src/core/net/sf/basedb/util/filter/Filter.java

Code
Comments
Other
Rev Date Author Line
4594 21 Oct 08 nicklas 1 /**
4594 21 Oct 08 nicklas 2   $Id$
4594 21 Oct 08 nicklas 3
4594 21 Oct 08 nicklas 4   Copyright (C) 2008 Nicklas Nordborg
4594 21 Oct 08 nicklas 5
4594 21 Oct 08 nicklas 6   This file is part of BASE - BioArray Software Environment.
4594 21 Oct 08 nicklas 7   Available at http://base.thep.lu.se/
4594 21 Oct 08 nicklas 8
4594 21 Oct 08 nicklas 9   BASE is free software; you can redistribute it and/or
4594 21 Oct 08 nicklas 10   modify it under the terms of the GNU General Public License
4594 21 Oct 08 nicklas 11   as published by the Free Software Foundation; either version 3
4594 21 Oct 08 nicklas 12   of the License, or (at your option) any later version.
4594 21 Oct 08 nicklas 13
4594 21 Oct 08 nicklas 14   BASE is distributed in the hope that it will be useful,
4594 21 Oct 08 nicklas 15   but WITHOUT ANY WARRANTY; without even the implied warranty of
4594 21 Oct 08 nicklas 16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
4594 21 Oct 08 nicklas 17   GNU General Public License for more details.
4594 21 Oct 08 nicklas 18
4594 21 Oct 08 nicklas 19   You should have received a copy of the GNU General Public License
4594 21 Oct 08 nicklas 20   along with BASE. If not, see <http://www.gnu.org/licenses/>.
4594 21 Oct 08 nicklas 21 */
4594 21 Oct 08 nicklas 22 package net.sf.basedb.util.filter;
4594 21 Oct 08 nicklas 23
4594 21 Oct 08 nicklas 24 /**
4594 21 Oct 08 nicklas 25   A filter is something that selectes or rejects an object 
4594 21 Oct 08 nicklas 26   due to some property of it. Filters are often used to 
4594 21 Oct 08 nicklas 27   filter a collection of object to create a sub-collection
4594 21 Oct 08 nicklas 28   where all objects share some property.
4594 21 Oct 08 nicklas 29
4594 21 Oct 08 nicklas 30   @author Nicklas
4594 21 Oct 08 nicklas 31   @version 2.9
4594 21 Oct 08 nicklas 32   @see FilterUtil
4594 21 Oct 08 nicklas 33   @base.modified $Date$
4594 21 Oct 08 nicklas 34 */
4594 21 Oct 08 nicklas 35 public interface Filter<T>
4594 21 Oct 08 nicklas 36 {
4594 21 Oct 08 nicklas 37   /**
4594 21 Oct 08 nicklas 38     Evaluate if the given object should pass the filter or not.
4594 21 Oct 08 nicklas 39     @param object The object to evaluate
4594 21 Oct 08 nicklas 40     @return TRUE if the object passes the filter, FALSE otherwise
4594 21 Oct 08 nicklas 41   */
4594 21 Oct 08 nicklas 42   public boolean evaluate(T object);
4594 21 Oct 08 nicklas 43
4594 21 Oct 08 nicklas 44 }

Generated on Sat Oct  7 02:37:19 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)