ComparisonOperators.java

/*
 *    GeoTools - The Open Source Java GIS Toolkit
 *    http://geotools.org
 *
 *    (C) 2011, Open Source Geospatial Foundation (OSGeo)
 *    (C) 2005 Open Geospatial Consortium Inc.
 *    
 *    All Rights Reserved. http://www.opengis.org/legal/
 */
package org.opengis.filter.capability;

import java.util.Collection;

/**
 * Supported comparison operators in a filter capabilities document.
 * <p>
 * <pre>
 * <xsd:complexType name="ComparisonOperatorsType">
 *     <xsd:sequence maxOccurs="unbounded">
 *        <xsd:element name="ComparisonOperator" type="ogc:ComparisonOperatorType"/>
 *     </xsd:sequence>
 *  </xsd:complexType>
 * </pre>
 * </p>
 * @author Justin Deoliveira, The Open Planning Project
 *
 *
 * @source $URL: http://svn.osgeo.org/geotools/trunk/modules/library/opengis/src/main/java/org/opengis/filter/capability/ComparisonOperators.java $
 */
public interface ComparisonOperators {

    /**
     * Provided comparison operators.
     * <p>
     *  <pre>
     *  <xsd:element name="ComparisonOperator" type="ogc:ComparisonOperatorType"/>
     *  </pre>
     * </p>
     */
    Collection<Operator> getOperators();

    /**
     * Looks up an operator by name, returning null if no such operator found.
     *
     * @param name the name of the operator.
     *
     * @return The operator, or null.
     */
    Operator getOperator( String name );
}