Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
pr_methods:tosql [2023/04/04 07:17] – removed - external edit (Unknown date) 127.0.0.1pr_methods:tosql [2023/05/03 04:53] (current) – sean
Line 1: Line 1:
 +{{tag>Index Programmers_Reference Methods IFunctionLibrary_Interface toSQL}}
 +
 +====toSQL (String, Collection, ISQLBuilderHelper)====
 +<code java>public String toSQL (String functionName, Collection parameters, ISQLBuilderHelper helper) 
 +throws Exception</code>
 +
 +This method must return the SQL representation of the function if it supports one. The SQL representation is essential if a function is to be used in queries. If the SQL representation is not provided it will not be possible to use the function in queries. See also an example later in this section.
 +
 +=== Parameters ===
 +|''functionName''|the name of the function in the library that needs to be represented in the SQL form.|
 +|''parameters''|parameters of the function specified as a collection of the IArithmeticNode objects. To get an SQL representation of a parameter use the ''toSQL'' method of the ''IArithmeticNode'' interface.|
 +|''helper''|a call-back interface that contains certain methods that may help define the SQL representation. See the [[docs:3500:0500:0520|ISQLBuilderHelper]] interface.|
 +
 +===Returns===
 +A string representing the SQL expression that calculates the function value. 
 +
 +===Throws===
 +''UnsupportedSQLElementException'' if the SQL representation for the function is not supported.