Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

oracle.javatools.db.sql
Class FunctionDefinition

java.lang.Object
  extended by oracle.javatools.db.sql.FunctionDefinition
All Implemented Interfaces:
java.lang.Comparable

public class FunctionDefinition
extends java.lang.Object
implements java.lang.Comparable

Class used for defining built in functinos for the database. This then allows the SQLQueryBuilder to recognise function calls in SQL, and also allows the UI to offer functions in the pallete.

Since:
10.1.3

Constructor Summary
FunctionDefinition(java.lang.String name, int minargs, int maxargs, java.lang.String desc)
           
FunctionDefinition(java.lang.String name, int minargs, int maxargs, java.lang.String desc, boolean isGrouping)
           
FunctionDefinition(java.lang.String name, int minargs, int maxargs, java.lang.String desc, boolean isGrouping, java.lang.String returnType)
           
FunctionDefinition(java.lang.String name, int minargs, int maxargs, java.lang.String desc, java.lang.String returnType)
           
FunctionDefinition(java.lang.String name, int args, java.lang.String desc)
           
FunctionDefinition(java.lang.String name, int args, java.lang.String desc, boolean isGrouping)
           
FunctionDefinition(java.lang.String name, int args, java.lang.String desc, boolean isGrouping, java.lang.String returnType)
           
FunctionDefinition(java.lang.String name, int args, java.lang.String desc, java.lang.String returnType)
           
 
Method Summary
 int compareTo(java.lang.Object o)
           
 java.lang.String getDescription()
          Returns a description for the function.
 int getMaxArgs()
          Returns the number of arguments the function takes.
 int getMinArgs()
          Returns the number of arguments the function takes.
 java.lang.String getName()
          Returns the name of the function.
 java.lang.String getReturnType()
           
 java.lang.String getSQLText()
          Returns the SQL for the function (without arguments)
 boolean isGrouping()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int args,
                          java.lang.String desc)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int args,
                          java.lang.String desc,
                          boolean isGrouping)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int minargs,
                          int maxargs,
                          java.lang.String desc)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int minargs,
                          int maxargs,
                          java.lang.String desc,
                          boolean isGrouping)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int args,
                          java.lang.String desc,
                          java.lang.String returnType)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int args,
                          java.lang.String desc,
                          boolean isGrouping,
                          java.lang.String returnType)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int minargs,
                          int maxargs,
                          java.lang.String desc,
                          java.lang.String returnType)

FunctionDefinition

public FunctionDefinition(java.lang.String name,
                          int minargs,
                          int maxargs,
                          java.lang.String desc,
                          boolean isGrouping,
                          java.lang.String returnType)
Method Detail

getName

public java.lang.String getName()
Returns the name of the function.


getMaxArgs

public int getMaxArgs()
Returns the number of arguments the function takes.


getMinArgs

public int getMinArgs()
Returns the number of arguments the function takes.


getDescription

public java.lang.String getDescription()
Returns a description for the function.


isGrouping

public boolean isGrouping()

getSQLText

public java.lang.String getSQLText()
Returns the SQL for the function (without arguments)


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

compareTo

public int compareTo(java.lang.Object o)
Specified by:
compareTo in interface java.lang.Comparable

getReturnType

public java.lang.String getReturnType()

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK Reference
11g Release 1 (11.1.1.4.0)

E13403-05

Copyright © 1997, 2011, Oracle. All rights reserved.