FilterFactory functionName should support argument description
--------------------------------------------------------------

                 Key: GEOT-3519
                 URL: http://jira.codehaus.org/browse/GEOT-3519
             Project: GeoTools
          Issue Type: Wish
          Components: core filter
    Affects Versions: 8-M0
            Reporter: Jody Garnett
            Priority: Trivial


FunctionName is defined as:
{code}
public interface FunctionName extends Operator {
    /**
     * Number of arguments the function accepts.
     * <p>
     * <ul>
     * <li>Use a postivie number to indicate the number of arguments.
     *     Example: add( number1, number2 ) = 2</li>
     * <li>Use a negative number to indicate a minimum number:
     *    Example: concat( str1, str2,... ) has -2</li>
     * </ul> 
     *
     * <pre>
     * &lt;xsd:attribute name="nArgs" type="xsd:string" use="required"/>
     * </pre>
     * </p>
     */
    @UML(identifier="argumentCount", specification=UNSPECIFIED)
    int getArgumentCount();
    
    /**
     * Argument names for documentation purposes if known.
     * 
     * @return Argument names (for documentation purposes) if known
     */
    List<String> getArgumentNames();
}
{code}

However FilterFactory only provides the following method for creation:
{code}
    /** function name */
    FunctionName functionName(String name, int nargs);
{code}

I would like to add the following to complete this relationship:
{code}
    /**
     * FunctionName used to describe an available function.
     * 
     * @param name
     *            name of function
     * @param nargs
     *            number of arguments, use a negative number to indicate a 
minimum if the function
     *            supports an open ended number of arguments
     * @param argNames
     *            Optional list of argument names
     */
    FunctionName functionName(String name, int nargs, List<String> argNames);
{code}

I will add this this to FilterFactory2 (as it does represent us going beyond 
the standard).


-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: 
http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

------------------------------------------------------------------------------
Benefiting from Server Virtualization: Beyond Initial Workload 
Consolidation -- Increasing the use of server virtualization is a top
priority.Virtualization can reduce costs, simplify management, and improve 
application availability and disaster protection. Learn more about boosting 
the value of server virtualization. http://p.sf.net/sfu/vmware-sfdev2dev
_______________________________________________
Geotools-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/geotools-devel

Reply via email to