com.ibm.is.cc.javastage.api
Class Capabilities

java.lang.Object
  com.ibm.is.cc.javastage.api.Capabilities

public class Capabilities
extends Object

This Capabilities class defines the capabilities of the user's Java code by encapsulating a list of attributes and parameters. During the initialization of the job, Java Integration stage will get its associated Capabilities object to learn whether the user's Java code can be run in the current job design.

The default capabilities are:

• Minimum number of input links is "0"
• Maximum number of input links is "no upper limits(-1)"
• Minimum number of output stream links is "0"
• Maximum number of output stream links is "no upper limits(-1)"
• Minimum number of reject links is "0"
• Maximum number of reject links is "no upper limits(-1)"
• Is Wave Generator : true
• Column transfer behavior is all enabled.

The users can specify the custom capabilities and pass to the Java Integration stage by overriding Processor.getCapabilities(). The following example shows how to customize the capabilities.

 
 public Capabilities getCapabilities()
 {
    Capabilities capabilities = new Capabilities();
    capabilities.setMaximumInputLinkCount(1);
    capabilities.setMaximumOutputStreamLinkCount(2);
    capabilities.setMaximumRejectLinkCount(0);
    capabilities.setIsWaveGenerator(false);
    return capabilities;
 }
 

If the current job design is not fit to the capabilities of user's code, the job will be aborted.

Version:

1.0

See Also:

Processor.getCapabilities()

Constructor Summary

Capabilities()
Constructs a Capabilities object with default settings.

Method Summary

int	getColumnTransferBehavior() Retrieves the column transfer behavior.
int	getMaximumInputLinkCount() Retrieves the maxmum number of input links as capability of this stage.
int	getMaximumOutputStreamLinkCount() Retrieves the maximum number of output stream links as capability of this stage.
int	getMaximumRejectLinkCount() Retrieves the maximum number of reject links as capability of this stage.
int	getMinimumInputLinkCount() Retrieves the minimum number of input links as capability of this stage.
int	getMinimumOutputStreamLinkCount() Retrieves the minimum number of output stream links as capability of this stage.
int	getMinimumRejectLinkCount() Retrieves the minimum number of reject links as capability of this stage.
boolean	isWaveGenerator() Retrives true if emits wave markers.
void	setColumnTransferBehavior(int behavior) Sets the column transfer behavior set which the user code wants to use.
void	setIsWaveGenerator(boolean isEnabled) Sets true if emits wave markers.
void	setMaximumInputLinkCount(int count) Sets the maximum number of input links as capability of this stage.
void	setMaximumOutputStreamLinkCount(int count) Sets the maximum number of output stream links as capability of this stage.
void	setMaximumRejectLinkCount(int count) Sets the maximum number of reject links as capability of this stage.
void	setMinimumInputLinkCount(int count) Sets the minimum number of input links as capability of this stage.
void	setMinimumOutputStreamLinkCount(int count) Sets the minimum number of output stream links as capability of this stage.
void	setMinimumRejectLinkCount(int count) Sets the minimum number of reject links as capability of this stage.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Capabilities

public Capabilities()

Constructs a Capabilities object with default settings.

Since:

1.0

Method Detail

getMinimumInputLinkCount

public int getMinimumInputLinkCount()

Retrieves the minimum number of input links as capability of this stage.

Returns:

The minimum number of input links can be accepted by this stage.

setMinimumInputLinkCount

public void setMinimumInputLinkCount(int count)

Sets the minimum number of input links as capability of this stage. If a negative value is specified, this value will be ignored and then set to 0.

Parameters:

count - The minimum number of input links can be accepted by this stage.

getMaximumInputLinkCount

public int getMaximumInputLinkCount()

Retrieves the maxmum number of input links as capability of this stage.

Returns:

The maximum number of input links can be accepted by this stage.

setMaximumInputLinkCount

public void setMaximumInputLinkCount(int count)

Sets the maximum number of input links as capability of this stage.

Parameters:

count - The maximum number of input links can be accepted by this stage. -1 indicates no upper limits.

getMinimumOutputStreamLinkCount

public int getMinimumOutputStreamLinkCount()

Retrieves the minimum number of output stream links as capability of this stage.

Returns:

The minimum number of output stream links can be accepted by this stage.

setMinimumOutputStreamLinkCount

public void setMinimumOutputStreamLinkCount(int count)

Sets the minimum number of output stream links as capability of this stage. If a negative value is specified, this value will be ignored and then set to 0.

Parameters:

count - The minimum number of output stream links can be accepted by this stage.

getMaximumOutputStreamLinkCount

public int getMaximumOutputStreamLinkCount()

Retrieves the maximum number of output stream links as capability of this stage.

Returns:

The maximum number of output stream links can be accepted by this stage.

setMaximumOutputStreamLinkCount

public void setMaximumOutputStreamLinkCount(int count)

Sets the maximum number of output stream links as capability of this stage.

Parameters:

count - The maximum number of output stream links can be accepted by this stage. -1 indicates no upper limits.

getMinimumRejectLinkCount

public int getMinimumRejectLinkCount()

Retrieves the minimum number of reject links as capability of this stage.

Returns:

The minimum number of reject links can be accepted by this stage.

setMinimumRejectLinkCount

public void setMinimumRejectLinkCount(int count)

Sets the minimum number of reject links as capability of this stage. If a negative value is specified, this value will be ignored and then set to 0.

Parameters:

count - The minimum number of reject links can be accepted by this stage.

getMaximumRejectLinkCount

public int getMaximumRejectLinkCount()

Retrieves the maximum number of reject links as capability of this stage.

Returns:

The maximum number of reject links can be accepted by this stage.

setMaximumRejectLinkCount

public void setMaximumRejectLinkCount(int count)

Sets the maximum number of reject links as capability of this stage.

Parameters:

count - The maximum number of reject links can be accepted by this stage. -1 indicates no upper limits.

isWaveGenerator

public boolean isWaveGenerator()

Retrives true if emits wave markers. If user's implementation will send a wave marker to the output link by using OutputLink.writeWaveMarker(), true should be returned. When running on Server canvas, a warning message will be output saying that wave generation is unsupported if implementation returns true.

Returns:

true if this stage emits wave marker. Otherwise, false.

setIsWaveGenerator

public void setIsWaveGenerator(boolean isEnabled)

Sets true if emits wave markers.

Parameters:

isEnabled - true if this stage emits wave marker. Otherwise, sets false

See Also:

OutputLink.writeWaveMarker()

setColumnTransferBehavior

public void setColumnTransferBehavior(int behavior)

Sets the column transfer behavior set which the user code wants to use.

Parameters:

behavior - behavior set which user code wants to use.

See Also:

ColumnTransferBehavior

getColumnTransferBehavior

public int getColumnTransferBehavior()

Retrieves the column transfer behavior.

Returns:

behavior set

See Also:

ColumnTransferBehavior