Class StringInputOutlet
java.lang.Object
org.apache.torque.generator.outlet.OutletImpl
org.apache.torque.generator.outlet.java.OutletWithoutMergepoints
org.apache.torque.generator.outlet.java.StringInputOutlet
- All Implemented Interfaces:
Outlet
- Direct Known Subclasses:
CamelbackOutlet,ConstantNameOutlet,PackageToPathOutlet
A base class for a outlet which takes a String as input
(not a Source Element as a normal outlet would).
-
Constructor Summary
ConstructorsConstructorDescriptionStringInputOutlet(QualifiedName qualifiedName) Constructs a singleInputOutlet. -
Method Summary
Modifier and TypeMethodDescriptionprotected StringgetInput(ControllerState controllerState) Retrieves the input from the different possibilities nputValue, inputOption, inputVariable, or inputSourceElement.voidsetInputOption(String inputOption) Sets the name of the option which should be used as input.voidsetInputSourceElement(String inputSourceElement) Sets the name of the source element which contains the attribute which should be used as input.voidsetInputValue(String inputValue) Sets the input value directly.voidsetInputVariable(String inputVariable) Sets the name of the variable which should be used as input.voidsetSourceElementAttribute(String sourceElementAttribute) Sets the name of the source element attribute from which the input should be read.Methods inherited from class org.apache.torque.generator.outlet.java.OutletWithoutMergepoints
addMergepointMapping, getMergepointMappingMethods inherited from class org.apache.torque.generator.outlet.OutletImpl
afterExecute, beforeExecute, execute, getInputClass, getInputElementName, getMergepointMappings, getName, getVariable, mergepoint, setInputClass, setInputElementName, setMergepointMapping, setVariable, setVariable, toString
-
Constructor Details
-
StringInputOutlet
Constructs a singleInputOutlet.- Parameters:
qualifiedName- the name of the outlet.
-
-
Method Details
-
setInputValue
Sets the input value directly.- Parameters:
inputValue- the input value, or null if the direct input value should not be used.
-
setInputOption
Sets the name of the option which should be used as input.- Parameters:
inputOption- the name of the option which contains the input, or null if no option should be used as input.
-
setInputVariable
Sets the name of the variable which should be used as input.- Parameters:
inputVariable- the name of the variable which should be used as input, or null if no variable should be used as input.
-
setInputSourceElement
Sets the name of the source element which contains the attribute which should be used as input.- Parameters:
inputSourceElement- the name of the source element, or null if no source element should be used as input.
-
setSourceElementAttribute
Sets the name of the source element attribute from which the input should be read. Only used if inputsourceElement is not null.- Parameters:
sourceElementAttribute- the attribute from which the input is read.
-
getInput
Retrieves the input from the different possibilities nputValue, inputOption, inputVariable, or inputSourceElement.- Parameters:
controllerState- the current controller state.- Returns:
- the retrieved value, not null.
- Throws:
GeneratorException- if no possibility or more than one possibility is chosen, or if the desired input is not set(except when a variable is not set or set to null, this results in "" being returned)
-