com.ibm.di.config.interfaces
Interface AssemblyLineConfig

All Superinterfaces:

BaseConfiguration, OperationsConfig, Serializable

All Known Implementing Classes:

AssemblyLineConfigImpl

public interface AssemblyLineConfig
extends BaseConfiguration, OperationsConfig

AssemblyLineConfig

Field Summary

static String	INPUT_MAP_NAME The name of the input map
static String	OUTPUT_MAP_NAME The name of the output map

Method Summary

ContainerConfig	addComponent(BaseConfiguration config) This method adds a component configuration object to the correct component container
boolean	autoMapAllAttributes(Object connectorName) Returns the automap flag for the AssemblyLine
boolean	containsComponent(String name) Returns true if there is component (data flow or entry feed) named name
AttributeMapConfig	getAttributeMap(boolean input) Returns the AssemblyLine's attribute map
AttributeMapConfig	getAttributeMap(String name)
CheckpointConfig	getCheckpointConfig() Returns the Checkpoint info object
BaseConfiguration	getComponent(int position) Returns the component attribute of the AssemblyLineConfig object
BaseConfiguration	getComponent(String name) Returns the component configuration
BaseConfiguration	getComponentByName(String name) Returns the component attribute of the AssemblyLineConfig object
int	getComponentCount() Returns the number of components in the assemblyline
ContainerConfig	getComponents() Returns the components container
ConnectorConfig	getConnector(int position) Returns the connector attribute of the AssemblyLineConfig object
ConnectorConfig	getConnectorByName(Object name) Returns the connector attribute of the AssemblyLineConfig object
int	getConnectorCount() Returns the number of connectors in the assemblyline
ContainerConfig	getDataFlowComponents() Returns the data flow components container
boolean	getDebug() Returns the debug flag for the AssemblyLine (default false)
boolean	getDebug(boolean defval) Returns the debug flag for the AssemblyLine
ContainerConfig	getEntryFeedComponents() Returns the entry feed components container
HookConfig	getHook(String name) Returns a specific HookConfig
HooksConfig	getHooks() Returns the AssemblyLine's HooksConfig
LogConfig	getLogConfig() Returns the LogConfig object.
SandboxConfig	getSandboxConfig() Returns the Sandbox object
SchemaConfig	getSchema(boolean input) Returns the AssemblyLine's schema
SchemaConfig	getSchema(String name)
BaseConfiguration	getSettings() Returns the AssemblyLine Settings
CallConfig	getTaskInputParameters() Deprecated. Use getSchema(true)
CallConfig	getTaskOutputParameters() Deprecated. Use getSchema(false)
PropertyConfig	getThreadOptions() Returns the Thread options config in the EventHandlers configuration
void	insertComponent(BaseConfiguration connector, int position) Adds a connector configuration object to this assemblyline
boolean	moveComponent(int position, boolean up) Moves a connector one position up or down
void	removeComponent(BaseConfiguration component) Removes a component from the assemblyline
void	removeComponent(int position) Removes a component from the assemblyline
void	removeComponent(String name) This method removes a named component configuration object
void	renameComponent(String name, String newName) Changes the local name of a connector (the name used in script engines etc )
void	setDebug(boolean debug) Sets the debug flag for the AssemblyLine
void	setSettings(BaseConfiguration settings) Sets the AssemblyLine Settings of the AssemblyLineConfig

Methods inherited from interface com.ibm.di.config.interfaces.OperationsConfig

createOperation, getOperation, getOperations, getPublishedInitParams, setPublishedInitParams

Field Detail

INPUT_MAP_NAME

static final String INPUT_MAP_NAME

The name of the input map

See Also:

Constant Field Values

OUTPUT_MAP_NAME

static final String OUTPUT_MAP_NAME

The name of the output map

See Also:

Constant Field Values

Method Detail

getConnectorCount

int getConnectorCount()

Returns the number of connectors in the assemblyline

Returns:

The connectorCount value

getConnectorByName

ConnectorConfig getConnectorByName(Object name)
                                   throws Exception

Returns the connector attribute of the AssemblyLineConfig object

Parameters:

name - The name of the Connector to retrieve.

Returns:

The connector configuration object.

Throws:

Exception

getConnector

ConnectorConfig getConnector(int position)
                             throws Exception

Returns the connector attribute of the AssemblyLineConfig object

Parameters:

position - Connector position

Returns:

The connector configuration object

Throws:

Exception

getComponentCount

int getComponentCount()

Returns the number of components in the assemblyline

Returns:

The componentCount value

getComponents

ContainerConfig getComponents()

Returns the components container

Returns:

The componentCount value

getComponentByName

BaseConfiguration getComponentByName(String name)
                                     throws Exception

Returns the component attribute of the AssemblyLineConfig object

Parameters:

name - The name of the component get get.

Returns:

The connector configuration object

Throws:

Exception

getComponent

BaseConfiguration getComponent(int position)
                               throws Exception

Returns the component attribute of the AssemblyLineConfig object

Parameters:

position - component position

Returns:

The connector configuration object

Throws:

Exception

removeComponent

void removeComponent(int position)
                     throws Exception

Removes a component from the assemblyline

Parameters:

position - component position

Throws:

Exception

removeComponent

void removeComponent(BaseConfiguration component)
                     throws Exception

Removes a component from the assemblyline

Parameters:

component - component config

Throws:

Exception

insertComponent

void insertComponent(BaseConfiguration connector,
                     int position)
                     throws Exception

Adds a connector configuration object to this assemblyline

Parameters:

connector - The component configuration object to add

position - The position of the connector or -1 to add the connector to the end

Throws:

Exception

moveComponent

boolean moveComponent(int position,
                      boolean up)

Moves a connector one position up or down

Parameters:

position - Current connector position

up - Up (true) or down (false)

Returns:

true if the operation succeeded

renameComponent

void renameComponent(String name,
                     String newName)
                     throws Exception

Changes the local name of a connector (the name used in script engines etc )

Parameters:

name - The current name

newName - .New local name

Throws:

Exception

getHooks

HooksConfig getHooks()

Returns the AssemblyLine's HooksConfig

Returns:

The hooks of this AssemblyLine

getHook

HookConfig getHook(String name)

Returns a specific HookConfig

Parameters:

name - The name of the hook

Returns:

The HookConfig with the given name

getSettings

BaseConfiguration getSettings()

Returns the AssemblyLine Settings

Returns:

The settings value

setSettings

void setSettings(BaseConfiguration settings)

Sets the AssemblyLine Settings of the AssemblyLineConfig

Parameters:

settings - The new settings value

getTaskInputParameters

CallConfig getTaskInputParameters()

Deprecated. Use getSchema(true)

Returns the AssemblyLine's input parameters (ref Task Call Block)

Returns:

The taskInputParameters value

getTaskOutputParameters

CallConfig getTaskOutputParameters()

Deprecated. Use getSchema(false)

Returns the AssemblyLine's output parameters (ref Task Call Block)

Returns:

The taskOutputParameters value

getSchema

SchemaConfig getSchema(boolean input)

Returns the AssemblyLine's schema

Parameters:

input - if true, returns the input schema

Returns:

The schema object

getSchema

SchemaConfig getSchema(String name)

getAttributeMap

AttributeMapConfig getAttributeMap(boolean input)

Returns the AssemblyLine's attribute map

Parameters:

input - if true, returns the input attribute map

Returns:

The attribute map object

getAttributeMap

AttributeMapConfig getAttributeMap(String name)

getDebug

boolean getDebug()

Returns the debug flag for the AssemblyLine (default false)

Specified by:

getDebug in interface BaseConfiguration

Returns:

The debug value

getDebug

boolean getDebug(boolean defval)

Returns the debug flag for the AssemblyLine

Specified by:

getDebug in interface BaseConfiguration

Parameters:

defval - The default value

Returns:

The debug value

setDebug

void setDebug(boolean debug)

Sets the debug flag for the AssemblyLine

Specified by:

setDebug in interface BaseConfiguration

Parameters:

debug - The new debug value

autoMapAllAttributes

boolean autoMapAllAttributes(Object connectorName)
                             throws Exception

Returns the automap flag for the AssemblyLine

Parameters:

connectorName - The name of an AssemblyLine Component

Returns:

true, if the AssemblyLine Component maps all the attributes

Throws:

Exception - if the check does not succeed

getCheckpointConfig

CheckpointConfig getCheckpointConfig()

Returns the Checkpoint info object

getSandboxConfig

SandboxConfig getSandboxConfig()

Returns the Sandbox object

getLogConfig

LogConfig getLogConfig()

Returns the LogConfig object.

getThreadOptions

PropertyConfig getThreadOptions()
                                throws Exception

Returns the Thread options config in the EventHandlers configuration

Throws:

Exception

getEntryFeedComponents

ContainerConfig getEntryFeedComponents()

Returns the entry feed components container

Returns:

The entry feed components value

getDataFlowComponents

ContainerConfig getDataFlowComponents()

Returns the data flow components container

Returns:

The data flow components value

containsComponent

boolean containsComponent(String name)

Returns true if there is component (data flow or entry feed) named name

Parameters:

name - The name of the config

Returns:

True if it exists

getComponent

BaseConfiguration getComponent(String name)

Returns the component configuration

Parameters:

name - The name of the config

Returns:

Null if it does not exist else a BaseConfiguration subclass

addComponent

ContainerConfig addComponent(BaseConfiguration config)

This method adds a component configuration object to the correct component container

Parameters:

config - The configuration object

Returns:

The container to which it was added (either DataFlow or EntryFeed container) or NULL if the config object was invalid.

Throws:

Exception - if the operation does not succeed

removeComponent

void removeComponent(String name)

This method removes a named component configuration object

Parameters:

name - The name of the component to remove.

Throws:

Exception