Functions.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 functions in a capabilities document.
 * <p>
 * <pre>
 *  <xsd:complexType name="FunctionsType">
 *    <xsd:sequence>
 *       <xsd:element name="FunctionNames" type="ogc:FunctionNamesType"/>
 *    </xsd:sequence>
 *  </xsd:complexType>
 * </pre>
 * </p>
 * @author Justin Deoliveira, The Open Planning Project
 *
 * @source $URL: http://svn.osgeo.org/geotools/branches/2.7.x/modules/library/opengis/src/main/java/org/opengis/filter/capability/Functions.java $
 */
public interface Functions {

    /**
     * Provided functions.
     * <p>
     * <pre>
     * <xsd:element name="FunctionNames" type="ogc:FunctionNamesType"/>
     * </pre>
     * </p>
     */
    Collection<FunctionName> getFunctionNames();

    /**
     * Looks up a function by name, returning null if no such function is found.
     *
     * @param name The name of the function.
     *
     * @return A function, or null.
     */
    FunctionName getFunctionName( String name );
}