FunctionCall (SQL Query Builders 3.0.2 API)

java.lang.Object
- com.healthmarketscience.common.util.AppendeeObject
- - com.healthmarketscience.sqlbuilder.SqlObject
  - - com.healthmarketscience.sqlbuilder.Expression
    - - com.healthmarketscience.sqlbuilder.FunctionCall

All Implemented Interfaces:

Appendee
```
public class FunctionCall
extends Expression
```
Outputs a function call "<name>([<param1>, ... <paramN>]) [OVER (<window>)]".

Author:

James Ahlborn

Field Summary
- Fields inherited from class com.healthmarketscience.sqlbuilder.Expression
  EMPTY
- Fields inherited from class com.healthmarketscience.sqlbuilder.SqlObject
  ALL_SYMBOL, NULL_VALUE, QUESTION_MARK

Constructor Summary

Constructors
Constructor and Description
`FunctionCall(Function function)`
`FunctionCall(Object functionNameStr)` `Object` -> `SqlObject` conversions handled by `Converter.toCustomFunctionSqlObject(Object)`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FunctionCall`	`addColumnParams(Column... columns)` Adds column parameters to the function call as `"<alias>.<column>"`.
`FunctionCall`	`addCustomParams(Object... params)` Adds custom parameters to the function call.
`FunctionCall`	`addNumericValueParam(Object obj)` Adds a numeric value parameter to the function call.
`protected void`	`appendCustomIfNotNull(AppendableExt app, SqlObject obj)` Appends the given custom clause to the given AppendableExt, handling `null` and enclosing parens.
`protected void`	`appendNestedClauses(AppendableExt app, SqlObjectList<? extends com.healthmarketscience.sqlbuilder.NestableClause> nestedClauses)` Appends the given nested clauses to the given AppendableExt, handling empty nested clauses and enclosing parens.
`void`	`appendTo(AppendableExt app)` Appends this object to the given AppendableExt.
`protected static boolean`	`areEmpty(SqlObjectList<? extends com.healthmarketscience.sqlbuilder.NestableClause> nestedClauses)` Determines if any of the given clauses are non-empty.
`static FunctionCall`	`avg()` Convenience method for generating a FunctionCall using the standard AVG function.
`protected void`	`closeParen(AppendableExt app)` Appends a close parenthesis to the given AppendableExt if disableParens is `true`, otherwise does nothing.
`protected void`	`collectSchemaObjects(ValidationContext vContext)` Used during Query.validate() calls to collect the dbschema objects referenced in a query.
`static FunctionCall`	`count()` Convenience method for generating a FunctionCall using the standard COUNT function.
`static FunctionCall`	`countAll()` Convenience method for generating a FunctionCall using the standard COUNT function with the single parameter '*'.
`static FunctionCall`	`denseRank()` Convenience method for generating a FunctionCall using the DENSE_RANK aggregate function.
`boolean`	`hasParens()` Returns `true` iff the output of this instance would include surrounding parentheses, `false` otherwise.
`protected static boolean`	`hasParens(SqlObjectList<? extends com.healthmarketscience.sqlbuilder.NestableClause> nestedClauses)` Determines if any of the given clauses are non-empty.
`boolean`	`isDisableParens()` Returns whether or not wrapping parentheses are disabled for this clause (for clauses which utilize wrapping parentheses).
`boolean`	`isEmpty()` Returns `true` iff the output of this instance would be an empty expression, `false` otherwise.
`static FunctionCall`	`max()` Convenience method for generating a FunctionCall using the standard MAX function.
`static FunctionCall`	`min()` Convenience method for generating a FunctionCall using the standard MIN function.
`protected void`	`openParen(AppendableExt app)` Appends an open parenthesis to the given AppendableExt if disableParens is `true`, otherwise does nothing.
`static FunctionCall`	`rank()` Convenience method for generating a FunctionCall using the RANK aggregate function.
`static FunctionCall`	`rowNumber()` Convenience method for generating a FunctionCall using the ROW_NUMBER aggregate function.
`FunctionCall`	`setIsDistinct(boolean isDistinct)` Iff isDistinct is `true`, adds the DISTINCT keyword to the parameter clause
`FunctionCall`	`setWindow(Object window)` Sets the window clause for this function call, like `"OVER (<windowClause>)"`.
`FunctionCall`	`setWindowByName(String windowName)` Sets the window clause for this function call to a reference to the named window definition, like `"OVER <windowClauseName>"`.
`static FunctionCall`	`sum()` Convenience method for generating a FunctionCall using the standard SUM function.

Methods inherited from class com.healthmarketscience.sqlbuilder.Expression
setDisableParens

Methods inherited from class com.healthmarketscience.sqlbuilder.SqlObject
collectSchemaObjects, doValidate, toString

Methods inherited from class com.healthmarketscience.common.util.AppendeeObject
toString, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FunctionCall
```
public FunctionCall(Function function)
```
  - FunctionCall
```
public FunctionCall(Object functionNameStr)
```
    Object -> SqlObject conversions handled by Converter.toCustomFunctionSqlObject(Object).
- Method Detail
  - hasParens
```
public boolean hasParens()
```
    Returns true iff the output of this instance would include surrounding parentheses, false otherwise.
    Default implementation returns !isEmpty() && !isDisableParens().
  - setIsDistinct
```
public FunctionCall setIsDistinct(boolean isDistinct)
```
    Iff isDistinct is true, adds the DISTINCT keyword to the parameter clause
  - addCustomParams
```
public FunctionCall addCustomParams(Object... params)
```
    Adds custom parameters to the function call.
    Object -> SqlObject conversions handled by Converter.COLUMN_VALUE_TO_OBJ.
  - addColumnParams
```
public FunctionCall addColumnParams(Column... columns)
```
    Adds column parameters to the function call as "<alias>.<column>".
  - addNumericValueParam
```
public FunctionCall addNumericValueParam(Object obj)
```
    Adds a numeric value parameter to the function call.
    Object -> SqlObject conversions handled by Converter.COLUMN_VALUE_TO_OBJ.
  - setWindow
```
public FunctionCall setWindow(Object window)
```
    Sets the window clause for this function call, like "OVER (<windowClause>)".
    
    See Also:
    
    WindowDefinitionClause
  - setWindowByName
```
public FunctionCall setWindowByName(String windowName)
```
    Sets the window clause for this function call to a reference to the named window definition, like "OVER <windowClauseName>".
  - collectSchemaObjects
```
protected void collectSchemaObjects(ValidationContext vContext)
```
    Description copied from class: SqlObject
    
    Used during Query.validate() calls to collect the dbschema objects referenced in a query. Any subclass of this class should add all referenced tables and columns to the appropriate collections.
    
    Specified by:
    
    collectSchemaObjects in class SqlObject
    
    Parameters:
    
    vContext - handle to the current validation context
  - appendTo
```
public void appendTo(AppendableExt app)
              throws IOException
```
    Description copied from interface: Appendee
    
    Appends this object to the given AppendableExt. Called by an AppendableExt when a request is made to append an instance of Appendee.
    
    Specified by:
    
    appendTo in interface Appendee
    
    Overrides:
    
    appendTo in class AppendeeObject
    
    Parameters:
    
    app - the AppendableExt to which this class should append itself
    
    Throws:
    
    IOException - if the append fails
  - avg
```
public static FunctionCall avg()
```
    Convenience method for generating a FunctionCall using the standard AVG function.
  - min
```
public static FunctionCall min()
```
    Convenience method for generating a FunctionCall using the standard MIN function.
  - max
```
public static FunctionCall max()
```
    Convenience method for generating a FunctionCall using the standard MAX function.
  - sum
```
public static FunctionCall sum()
```
    Convenience method for generating a FunctionCall using the standard SUM function.
  - count
```
public static FunctionCall count()
```
    Convenience method for generating a FunctionCall using the standard COUNT function.
  - countAll
```
public static FunctionCall countAll()
```
    Convenience method for generating a FunctionCall using the standard COUNT function with the single parameter '*'.
  - rowNumber
```
public static FunctionCall rowNumber()
```
    Convenience method for generating a FunctionCall using the ROW_NUMBER aggregate function.
    
    See Also:
    
    "SQL 2003"
  - rank
```
public static FunctionCall rank()
```
    Convenience method for generating a FunctionCall using the RANK aggregate function.
    
    See Also:
    
    "SQL 2003"
  - denseRank
```
public static FunctionCall denseRank()
```
    Convenience method for generating a FunctionCall using the DENSE_RANK aggregate function.
    
    See Also:
    
    "SQL 2003"
  - isDisableParens
```
public boolean isDisableParens()
```
    Returns whether or not wrapping parentheses are disabled for this clause (for clauses which utilize wrapping parentheses). Defaults to false.
  - isEmpty
```
public boolean isEmpty()
```
    Returns true iff the output of this instance would be an empty expression, false otherwise.
    Default implementation returns false.
  - areEmpty
```
protected static boolean areEmpty(SqlObjectList<? extends com.healthmarketscience.sqlbuilder.NestableClause> nestedClauses)
```
    Determines if any of the given clauses are non-empty.
    
    Returns:
    
    false if at least one clause is non-empty, true otherwise
  - hasParens
```
protected static boolean hasParens(SqlObjectList<? extends com.healthmarketscience.sqlbuilder.NestableClause> nestedClauses)
```
    Determines if any of the given clauses are non-empty.
    
    Returns:
    
    false if at least one clause is non-empty, true otherwise
  - openParen
```
protected void openParen(AppendableExt app)
                  throws IOException
```
    Appends an open parenthesis to the given AppendableExt if disableParens is true, otherwise does nothing.
    
    Throws:
    
    IOException
  - closeParen
```
protected void closeParen(AppendableExt app)
                   throws IOException
```
    Appends a close parenthesis to the given AppendableExt if disableParens is true, otherwise does nothing.
    
    Throws:
    
    IOException
  - appendCustomIfNotNull
```
protected void appendCustomIfNotNull(AppendableExt app,
                                     SqlObject obj)
                              throws IOException
```
    Appends the given custom clause to the given AppendableExt, handling null and enclosing parens.
    
    Throws:
    
    IOException
  - appendNestedClauses
```
protected void appendNestedClauses(AppendableExt app,
                                   SqlObjectList<? extends com.healthmarketscience.sqlbuilder.NestableClause> nestedClauses)
                            throws IOException
```
    Appends the given nested clauses to the given AppendableExt, handling empty nested clauses and enclosing parens.
    
    Throws:
    
    IOException

Class FunctionCall

Field Summary

Fields inherited from class com.healthmarketscience.sqlbuilder.Expression

Fields inherited from class com.healthmarketscience.sqlbuilder.SqlObject

Constructor Summary

Method Summary

Methods inherited from class com.healthmarketscience.sqlbuilder.Expression

Methods inherited from class com.healthmarketscience.sqlbuilder.SqlObject

Methods inherited from class com.healthmarketscience.common.util.AppendeeObject

Methods inherited from class java.lang.Object

Constructor Detail

FunctionCall

FunctionCall

Method Detail

hasParens

setIsDistinct

addCustomParams

addColumnParams

addNumericValueParam

setWindow

setWindowByName

collectSchemaObjects

appendTo

avg

min

max

sum

count

countAll

rowNumber

rank

denseRank

isDisableParens

isEmpty

areEmpty

hasParens

openParen

closeParen

appendCustomIfNotNull

appendNestedClauses