| org.netbeans.modules.sql.framework.model.SQLConnectableObject
All known Subclasses: org.netbeans.modules.sql.framework.model.impl.SQLConnectableObjectImpl,
SQLConnectableObject | public interface SQLConnectableObject extends SQLObject,SQLVisitedObject(Code) | | Interface for all objects in the UI Object Model which accept inputs in the form of
SQLObject implementation instances.
author: Jonathan Giron version: $Revision$ |
Method Summary | |
public void | addInput(String argName, SQLObject newInput) Adds the given SQLInputObject as an input. | public SQLInputObject | getInput(String argName) Gets SQLInputObject instance, if any, associated as an input with the given
argument name. | public Map | getInputObjectMap() Gets a Map of argument names to corresponding SQLInputObject instances. | public SQLObject | getSQLObject(String argName) Gets SQLObject instance, if any, referenced as an input with the given argument
name. | public Map | getSQLObjectMap() Gets Map of argument names to SQLObject instances, if any, referenced as inputs. | public List | getSourceColumnsUsed() Returns List of Source table columns used in the expression. | public List | getTargetColumnsUsed() Returns List of Target table columns used in the expression. | public boolean | hasSourceColumn() | public boolean | hasTargetColumn() | public int | isInputCompatible(String argName, SQLObject input) Indicates whether the given object is compatible as an input for this instance. | public boolean | isInputStatic(String argName) Indicates whether the given object is a static input for this instance. | public boolean | isInputValid(String argName, SQLObject input) Indicates whether the given object is a valid input for this instance. | public SQLObject | removeInputByArgName(String argName, SQLObject sqlObj) Removes the SQLObject, if any, associated with the given argument name. |
addInput | public void addInput(String argName, SQLObject newInput) throws BaseException(Code) | | Adds the given SQLInputObject as an input.
Parameters: argName - name of argument whose associated SQLObject input is requested Parameters: newInput - SQLInputObject serving as input throws: BaseException - if newInput cannot be added to this instance |
getInput | public SQLInputObject getInput(String argName)(Code) | | Gets SQLInputObject instance, if any, associated as an input with the given
argument name.
Parameters: argName - name of argument whose associated SQLInputObject input is requested SQLInputObject associated with argName, or null if no such instance exists |
getInputObjectMap | public Map getInputObjectMap()(Code) | | Gets a Map of argument names to corresponding SQLInputObject instances.
Map of arguments to SQLInputObject inputs. |
getSQLObject | public SQLObject getSQLObject(String argName)(Code) | | Gets SQLObject instance, if any, referenced as an input with the given argument
name.
Parameters: argName - name of argument whose associated SQLInputObject input is requested SQLObject associated with argName, or null if no such instance exists |
getSQLObjectMap | public Map getSQLObjectMap()(Code) | | Gets Map of argument names to SQLObject instances, if any, referenced as inputs.
List of SQLObject instances referenced as inputs for this instance; emptyif no SQLObjects are currently referenced. |
getSourceColumnsUsed | public List getSourceColumnsUsed()(Code) | | Returns List of Source table columns used in the expression.
List of Source table columns used in the expression. |
getTargetColumnsUsed | public List getTargetColumnsUsed()(Code) | | Returns List of Target table columns used in the expression.
List of Target table columns used in the expression. |
hasSourceColumn | public boolean hasSourceColumn()(Code) | | true if expression contains source column. |
hasTargetColumn | public boolean hasTargetColumn()(Code) | | true if expression contains target column. |
isInputCompatible | public int isInputCompatible(String argName, SQLObject input)(Code) | | Indicates whether the given object is compatible as an input for this instance.
Parameters: argName - name of argument field whose type will be checked against input forcompatibility Parameters: input - SQLObject to test for compatibility SQLConstants.TYPE_CHECK_SAME if input and argument field are of identicaltype, SQLConstants.TYPE_CHECK_COMPATIBLE if input can be can be cast totype that is compatible with the argument field,SQLConstants.TYPE_CHECK_INCOMPATIBLE if input and argument field areincompatible |
isInputStatic | public boolean isInputStatic(String argName)(Code) | | Indicates whether the given object is a static input for this instance.
Parameters: argName - name of argument whose type will be checked against input forvalidity true if input is static, false otherwise |
isInputValid | public boolean isInputValid(String argName, SQLObject input)(Code) | | Indicates whether the given object is a valid input for this instance.
Parameters: argName - name of argument whose type will be checked against input forvalidity Parameters: input - SQLObject to test for validity true if input is valid, false otherwise |
removeInputByArgName | public SQLObject removeInputByArgName(String argName, SQLObject sqlObj) throws BaseException(Code) | | Removes the SQLObject, if any, associated with the given argument name.
Parameters: argName - name of argument whose associated SQLObject input, if any, should beremoved SQLObject formerly associated with argName, or null if no SQLObject wasassociated with argName. throws: BaseException - if error occurs during removal |
|
|