public interface StepOutputItem
This interface represents an output item produced by a step. An output item has a name,
type and value. If the item is of type DataType.STRING
,
it also has an associated length.
IMPORTANT: This interface should never be used outside the context and lifecycle of the plugin step to which they were provided. This means that an instance should not be passed as an argument to any method nor stored in a static location external to the plugin step instance that obtained it.
Modifier and Type | Method and Description |
---|---|
int |
getMaxByteLength()
Returns the maximum length, in bytes, of this item of type
DataType.STRING . |
int |
getMaxCharLength()
Returns the maximum length, in characters, of this item of type
DataType.STRING . |
java.lang.String |
getName()
Returns the name of the item.
|
DataType |
getType()
Returns the data type of the item.
|
java.lang.Object |
getValue()
Get the current value of the item.
|
void |
setMaxByteLength(int length)
Sets the maximum length, in bytes, of this item of type
DataType.STRING . |
void |
setMaxCharLength(int length)
Sets the maximum length, in characters, of this item of type
DataType.STRING . |
void |
setName(java.lang.String name)
Set the name of the item.
|
void |
setType(DataType type)
Set the data type of the item.
|
void |
setValue(java.lang.Object value)
Set the current value of the item.
|
java.lang.String getName()
void setName(java.lang.String name)
name
- The name of the item.java.lang.NullPointerException
- if name is null.DataType getType()
void setType(DataType type)
type
- The type of the item.java.lang.NullPointerException
- if type is null.int getMaxCharLength()
DataType.STRING
.DataType.STRING
.
This value has no meaning for other types.void setMaxCharLength(int length)
DataType.STRING
.length
- The length, in characters, of an item of type DataType.STRING
.
This value has no meaning for other types.int getMaxByteLength()
DataType.STRING
.DataType.STRING
.
This value has no meaning for other types.void setMaxByteLength(int length)
DataType.STRING
.
If not set or set to zero, the maximum byte length will default to four times the specified
maximum character length (see setMaxCharLength(int)
).
length
- The length, in bytes, of an item of type DataType.STRING
.
This value has no meaning for other types.java.lang.Object getValue()
This is only valid during execution (after IStep.preExec()
,
before IStep.postExec()
).
void setValue(java.lang.Object value)
This is only valid during execution (after IStep.preExec()
,
before IStep.postExec()
).
value
- The current value of the item.Copyright © 2012 SAS Institute Inc. All Rights Reserved.