| org.netbeans.modules.sql.framework.model.SQLOperatorDefinition
All known Subclasses: org.netbeans.modules.sql.framework.codegen.OperatorInstance,
| SQLOperatorDefinition | | public interface SQLOperatorDefinition extends Cloneable(Code) | | Defines methods for obtaining metadata of an SQL operator.
author:
Jonathan Giron
version:
$Revision$ |
| Method Summary | |
| public Object | clone(List operatorArgs)
| | public List | getArg2Use()
| | public int | getArgCount()
Gets the number of input arguments defined in the script. | | public int | getArgCountType()
Indicates if this operator can take a variable number of input arguments. | | public int | getArgIndex(String arg)
Gets index of argument associated with given name, if any. | | public int | getArgJdbcSQLType(int i)
Gets the argument name, if any, associated with the given index.
Parameters:
i - index of argument. | | public int | getArgJdbcSQLType(String argName)
Gets the JDBC sql type associated with the given argument name. | | public List | getArgList()
Get List of current arguments. | | public String | getArgType(int i)
Gets the SQL type of the argument, if any, associated with the given index. | | public Object | getAttributeValue(String attrName)
| | public String | getDbSpecficName()
| | public String | getGuiName()
| | public SQLOperatorArg | getOperatorArg(int index)
| | public String | getOperatorCategoryType()
| | public String | getOperatorName()
Gets the canonical name of this operator. | | public int | getOutputJdbcSQLType()
| | public String | getRange(String argName)
| | public String | getScript()
Gets the script associated with this operator. | | public String | getVarOperatorArgName()
Gets base name of argument, if any, used in generating arguments for operators that
can accept multiple inputs of the same type ("var" operators, e.g., "varconcat",
"varadd"). | | public void | parseXML(Element element)
Reads this operator's script and configuration information from the given DOM
element. | | public void | setArgList(List<SQLOperatorArg> args)
| | public void | setOutputJdbcSQLType(int jdbcType)
| | public void | setOutputJdbcSQLType(String jdbcType)
|
| ATTR_AGGREGATE_FUNCTION | | final public static String ATTR_AGGREGATE_FUNCTION(Code) | | |
| ATTR_SHOWPARENTHESIS | | final public static String ATTR_SHOWPARENTHESIS(Code) | | |
| clone | | public Object clone(List operatorArgs)(Code) | |
Parameters:
operatorArgs - List of SQLOperatorArg |
| getArg2Use | | public List getArg2Use()(Code) | | get a list of argument to use while calculating precision and scale
|
| getArgCount | | public int getArgCount()(Code) | | Gets the number of input arguments defined in the script. If the operator script
defines an operator with variable number of arguments then we allow a maximum of
100 input arguments.
maximum number of arguments this operator can support. |
| getArgCountType | | public int getArgCountType()(Code) | | Indicates if this operator can take a variable number of input arguments.
flag indicating weather this operator takes variable number of inputarguments. |
| getArgIndex | | public int getArgIndex(String arg)(Code) | | Gets index of argument associated with given name, if any.
Parameters:
arg - Argument name Argument index if successful, -1 if failed. |
| getArgJdbcSQLType | | public int getArgJdbcSQLType(int i)(Code) | | Gets the argument name, if any, associated with the given index.
Parameters:
i - index of argument. JDBC type if successful, JDBCSQL_TYPE_UNDEFINED if failed.
See Also: SQLConstants.JDBCSQL_TYPE_UNDEFINED |
| getArgJdbcSQLType | | public int getArgJdbcSQLType(String argName)(Code) | | Gets the JDBC sql type associated with the given argument name.
Parameters:
argName - name of argument JDBC type if successful, JDBCSQL_TYPE_UNDEFINED if failed.
See Also: SQLConstants.JDBCSQL_TYPE_UNDEFINED |
| getArgList | | public List getArgList()(Code) | | Get List of current arguments.
Argument list. |
| getArgType | | public String getArgType(int i)(Code) | | Gets the SQL type of the argument, if any, associated with the given index.
Parameters:
i - index of argument SQL type of argument indexed by i, null if no argument exists at i. |
| getDbSpecficName | | public String getDbSpecficName()(Code) | | get the database specfic name of the operator
|
| getGuiName | | public String getGuiName()(Code) | | get the gui representation of operator
|
| getOperatorArg | | public SQLOperatorArg getOperatorArg(int index)(Code) | | Gets Operator Arg for the given index
Parameters:
index - for OperatorArg SQLOperatorArg |
| getOperatorCategoryType | | public String getOperatorCategoryType()(Code) | | get the category type of the operator (numeric of string)
operator category type |
| getOperatorName | | public String getOperatorName()(Code) | | Gets the canonical name of this operator.
canonical name of operator |
| getOutputJdbcSQLType | | public int getOutputJdbcSQLType()(Code) | | Gets JDBC SQL type of this operator's output
JDBC type if successful, -65535 if failed. |
| getRange | | public String getRange(String argName)(Code) | | Gets the range based on argname
Parameters:
argName - for which range is returned String for range |
| getScript | | public String getScript()(Code) | | Gets the script associated with this operator.
SQL text representation of this operator, if any. |
| getVarOperatorArgName | | public String getVarOperatorArgName()(Code) | | Gets base name of argument, if any, used in generating arguments for operators that
can accept multiple inputs of the same type ("var" operators, e.g., "varconcat",
"varadd").
name of var argument |
| parseXML | | public void parseXML(Element element) throws BaseException(Code) | | Reads this operator's script and configuration information from the given DOM
element.
Parameters:
element - DOM element containing operator configuration information |
| setOutputJdbcSQLType | | public void setOutputJdbcSQLType(int jdbcType)(Code) | | sets the jdbc type of this operators return type
int jdbcType sql constant for the type |
| setOutputJdbcSQLType | | public void setOutputJdbcSQLType(String jdbcType)(Code) | | This method is another convenience method to compute
the sql constant for the given string and set the jdbc type
sets the jdbc type of this operators return type
Parameters:
String - jdbcType |
|
|