|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SQLFunction
Define the basic methods that classes that support SQL Functions need to implement for Classes that use them. This is intended to allow code to be written before functions are fully integrated with the DBAdaptors. As well as allowing for functions to expand as needed.
FunctionFactory
Method Summary | |
---|---|
java.lang.String |
getArgument(int i)
Return a string representation of the function parameters at index i. |
java.lang.Object[] |
getArguments()
Return all the parameters as an object array. |
java.lang.String |
getDBName()
Get the name of the Torque Database associated with this function. |
void |
setArguments(java.lang.Object[] args)
Sets the function specific arguments. |
void |
setDBName(java.lang.String dbName)
Sets the Torque DB name this function is being used with. |
java.lang.String |
toSQL()
This should return the SQL string that can be used when constructing the query. |
Method Detail |
---|
java.lang.String toSQL()
java.lang.String getArgument(int i)
i
- The 0 based parameter to get.
java.lang.Object[] getArguments()
void setArguments(java.lang.Object[] args)
args
- The function specific arguments.java.lang.String getDBName() throws java.lang.IllegalStateException
java.lang.IllegalStateException
- If Torque has not been initialized and
the default DB name can not be determined.void setDBName(java.lang.String dbName)
dbName
- The DB name, if null, the getDBName will return default DB
name (if it can be determined).
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |