|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.birt.data.engine.api.querydefn.ParameterDefinition
public class ParameterDefinition
Default implementation of the IParameterDefinition
interface.
Constructor Summary | |
---|---|
ParameterDefinition()
Constructs an empty parameter definition |
|
ParameterDefinition(int position,
int type)
Constructs a position-based parameter definition with specified data type |
|
ParameterDefinition(int position,
int type,
boolean isInput,
boolean isOutput)
Constructs a position-based parameter definition with specified data type, and input/output mode |
|
ParameterDefinition(java.lang.String name,
int type)
Constructs a name-based parameter definition with specified data type |
|
ParameterDefinition(java.lang.String name,
int type,
boolean isInput,
boolean isOutput)
Constructs a name-based parameter definition with specified data type, and input/output mode |
Method Summary | |
---|---|
java.lang.String |
getDefaultInputValue()
Returns the default input value of this parameter. |
java.lang.String |
getName()
Returns the parameter name. |
java.lang.String |
getNativeName()
Returns the native name of the parameter as known to the underlying data source. |
int |
getNativeType()
Returns the parameter's native data type as defined by the underlying data source. |
int |
getPosition()
Returns the parameter position. |
int |
getType()
Returns the parameter data type. |
boolean |
isInputMode()
Returns whether this parameter is an input parameter. |
boolean |
isInputOptional()
Specifies whether this parameter is optional. |
boolean |
isNullable()
Specifies whether null values are allowed for this parameter. |
boolean |
isOutputMode()
Returns whether this parameter is an output parameter. |
void |
setDefaultInputValue(java.lang.String defaultValue)
Sets the parameter's default input value. |
void |
setInputMode(boolean isInput)
Sets the input mode of the parameter. |
void |
setInputOptional(boolean isOptional)
Sets whether the parameter's input value is optional. |
void |
setName(java.lang.String name)
Sets the name of the parameter |
void |
setNativeName(java.lang.String nativeName)
Sets the parameter's native name as known to the underlying ODA driver. |
void |
setNativeType(int typeCode)
Sets the parameter native data type |
void |
setNullable(boolean isNullable)
Sets whether the parameter's value can be null. |
void |
setOutputMode(boolean isOutput)
Sets the output mode of the parameter. |
void |
setPosition(int posn)
Sets the parameter position |
void |
setType(int type)
Sets the parameter data type |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ParameterDefinition()
public ParameterDefinition(java.lang.String name, int type)
public ParameterDefinition(int position, int type)
public ParameterDefinition(java.lang.String name, int type, boolean isInput, boolean isOutput)
public ParameterDefinition(int position, int type, boolean isInput, boolean isOutput)
Method Detail |
---|
public java.lang.String getName()
IParameterDefinition
getName
in interface IParameterDefinition
IParameterDefinition.getName()
public void setName(java.lang.String name)
public java.lang.String getNativeName()
IParameterDefinition
getNativeName
in interface IParameterDefinition
public void setNativeName(java.lang.String nativeName)
public int getPosition()
IParameterDefinition
getPosition
in interface IParameterDefinition
IParameterDefinition.getPosition()
public void setPosition(int posn)
public int getType()
IParameterDefinition
org.eclipse.birt.core.data.DataType
class for return value constants.
getType
in interface IParameterDefinition
IParameterDefinition.getType()
public void setType(int type)
public int getNativeType()
IParameterDefinition
getNativeType
in interface IParameterDefinition
public void setNativeType(int typeCode)
public boolean isInputMode()
IParameterDefinition
isInputMode
in interface IParameterDefinition
IParameterDefinition.isInputMode()
public void setInputMode(boolean isInput)
isInput
- true if the parameter is of input mode,
false otherwise.public boolean isOutputMode()
IParameterDefinition
isOutputMode
in interface IParameterDefinition
IParameterDefinition.isOutputMode()
public void setOutputMode(boolean isOutput)
isOutput
- true if the parameter is of output mode,
false otherwise.public boolean isInputOptional()
IParameterDefinition
isInputOptional
in interface IParameterDefinition
IParameterDefinition.isInputOptional()
public void setInputOptional(boolean isOptional)
isOptional
- true if the parameter input value is optional,
false otherwise.public java.lang.String getDefaultInputValue()
IParameterDefinition
getDefaultInputValue
in interface IParameterDefinition
IParameterDefinition.getDefaultInputValue()
public void setDefaultInputValue(java.lang.String defaultValue)
defaultValue
- Default input value.public boolean isNullable()
IParameterDefinition
isNullable
in interface IParameterDefinition
IParameterDefinition.isNullable()
public void setNullable(boolean isNullable)
isNullable
- true if the parameter value can be null,
false otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |