com.ibm.di.config.base
Class AssemblyLineConfigImpl

java.lang.Object
  com.ibm.di.config.base.BaseConfigurationImpl
      com.ibm.di.config.base.AssemblyLineConfigImpl

All Implemented Interfaces:

AssemblyLineConfig, BaseConfiguration, MetamergeConfigChangeListener, OperationsConfig, Serializable

public class AssemblyLineConfigImpl
extends BaseConfigurationImpl
implements AssemblyLineConfig

This is the implementation class for the AssemblyLine configuration.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.ibm.di.config.base.BaseConfigurationImpl

NAME

Fields inherited from interface com.ibm.di.config.interfaces.AssemblyLineConfig

INPUT_MAP_NAME, OUTPUT_MAP_NAME

Constructor Summary

AssemblyLineConfigImpl()
Constructor for the AssemblyLineConfigImpl object

AssemblyLineConfigImpl(Object config)
Constructor for the AssemblyLineConfigImpl object

Method Summary

ContainerConfig	addComponent(BaseConfiguration config) This method adds a configuration object to the correct component container
boolean	autoMapAllAttributes(Object connectorName) Switches, Flags & Limits
boolean	containsComponent(String name) Returns true if there is component (data flow or entry feed) named name
OperationConfig	createOperation(String name) This method creates a new operation object.
AttributeMapConfig	getAttributeMap(boolean input) Returns the AssemblyLine's attribute map
AttributeMapConfig	getAttributeMap(String name) Gets the attributeMap attribute of the AssemblyLineConfigImpl object
CheckpointConfig	getCheckpointConfig() Returns the CheckpointInfo object
Object	getClone() Return self clone
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) Gets the connector attribute of the AssemblyLineConfigImpl object
ConnectorConfig	getConnectorByName(Object connectorName) Gets the connectorByName attribute of the AssemblyLineConfigImpl object
int	getConnectorCount() Connector methods
ContainerConfig	getDataFlowComponents() Returns the components container
boolean	getDebug() Debug
boolean	getDebug(boolean defval) Gets the debug attribute of the AssemblyLineConfigImpl object
ContainerConfig	getEntryFeedComponents() Returns the components container
HookConfig	getHook(String name) get an AssemblyLine Hook
HooksConfig	getHooks() get all AssemblyLine Hooks
LogConfig	getLogConfig() Returns the LogConfig object
OperationConfig	getOperation(String name) This method returns the config for a given operation
ContainerConfig	getOperations() This method returns a list of supported operations
SchemaConfig	getPublishedInitParams() Returns the Published Initialization Parameter Schema for the AssemblyLine
SandboxConfig	getSandboxConfig() Returns the Sandbox object
SchemaConfig	getSchema(boolean input) Returns the AssemblyLine's schema
SchemaConfig	getSchema(String name) Gets the schema attribute of the AssemblyLineConfigImpl object
BaseConfiguration	getSettings() 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	init() init - Preload all connectors
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 oldName, String newName) Changes the local name of a connector (the name used in script engines etc )
void	setDebug(boolean debug) Sets the debug attribute of the AssemblyLineConfigImpl object
void	setPublishedInitParams(SchemaConfig schema) Sets the Published Initialization Parameter Schema for the AssemblyLine
void	setSettings(BaseConfiguration settings) Sets the settings attribute of the AssemblyLineConfigImpl object
void	setupInheritanceChain() Established the inheritance chain for this object.

Methods inherited from class com.ibm.di.config.base.BaseConfigurationImpl

addListener, configurationChanged, deepClone, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getMetamergeConfig, getModified, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseListeners, getUserComment, hasParameter, isParameterLocal, nameForChild, notifyChange, notifyChange, performNotifyChange, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setUseListeners, setUserComment, size, toEntry, toString, updateInheritsFrom, willExpandProps, willFlatten, willUseInherited

Methods inherited from class java.lang.Object

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

Constructor Detail

AssemblyLineConfigImpl

public AssemblyLineConfigImpl()

Constructor for the AssemblyLineConfigImpl object

AssemblyLineConfigImpl

public AssemblyLineConfigImpl(Object config)

Constructor for the AssemblyLineConfigImpl object

Parameters:

config - the config object

Method Detail

init

public void init()
          throws Exception

init - Preload all connectors

Specified by:

init in interface BaseConfiguration

Overrides:

init in class BaseConfigurationImpl

Throws:

Exception - An exception is thrown if this method fails.

getConnectorCount

public int getConnectorCount()

Connector methods

Specified by:

getConnectorCount in interface AssemblyLineConfig

Returns:

The connectorCount value

getConnector

public ConnectorConfig getConnector(int position)

Gets the connector attribute of the AssemblyLineConfigImpl object

Specified by:

getConnector in interface AssemblyLineConfig

Parameters:

position - the position of the Connector for which to return the Connector configuration object

Returns:

The connector value

getConnectorByName

public ConnectorConfig getConnectorByName(Object connectorName)

Gets the connectorByName attribute of the AssemblyLineConfigImpl object

Specified by:

getConnectorByName in interface AssemblyLineConfig

Parameters:

connectorName - the name of the Connector for which to return the Connector configuration object

Returns:

The connectorByName value

getHook

public HookConfig getHook(String name)

get an AssemblyLine Hook

Specified by:

getHook in interface AssemblyLineConfig

Parameters:

name - The name of the hook

Returns:

The HookConfig with the given name

getHooks

public HooksConfig getHooks()

get all AssemblyLine Hooks

Specified by:

getHooks in interface AssemblyLineConfig

Returns:

The hooks of this AssemblyLine

getSettings

public BaseConfiguration getSettings()

Settings

Specified by:

getSettings in interface AssemblyLineConfig

Returns:

The settings value

setSettings

public void setSettings(BaseConfiguration settings)

Sets the settings attribute of the AssemblyLineConfigImpl object

Specified by:

setSettings in interface AssemblyLineConfig

Parameters:

settings - The new settings value

getTaskInputParameters

public CallConfig getTaskInputParameters()

Deprecated. Use getSchema(true)

Call Parameters

Specified by:

getTaskInputParameters in interface AssemblyLineConfig

Returns:

The taskInputParameters value

getTaskOutputParameters

public CallConfig getTaskOutputParameters()

Deprecated. Use getSchema(false)

Output Parameters

Specified by:

getTaskOutputParameters in interface AssemblyLineConfig

Returns:

The taskOutputParameters value

getCheckpointConfig

public CheckpointConfig getCheckpointConfig()

Returns the CheckpointInfo object

Specified by:

getCheckpointConfig in interface AssemblyLineConfig

Returns:

The checkpointConfig value

getSandboxConfig

public SandboxConfig getSandboxConfig()

Returns the Sandbox object

Specified by:

getSandboxConfig in interface AssemblyLineConfig

Returns:

The sandboxConfig value

getLogConfig

public LogConfig getLogConfig()

Returns the LogConfig object

Specified by:

getLogConfig in interface AssemblyLineConfig

Returns:

The logConfig value

getDebug

public boolean getDebug()

Debug

Specified by:

getDebug in interface AssemblyLineConfig

Specified by:

getDebug in interface BaseConfiguration

Overrides:

getDebug in class BaseConfigurationImpl

Returns:

The debug value

getDebug

public boolean getDebug(boolean defval)

Gets the debug attribute of the AssemblyLineConfigImpl object

Specified by:

getDebug in interface AssemblyLineConfig

Specified by:

getDebug in interface BaseConfiguration

Overrides:

getDebug in class BaseConfigurationImpl

Parameters:

defval - default value for debug

Returns:

The debug value

setDebug

public void setDebug(boolean debug)

Sets the debug attribute of the AssemblyLineConfigImpl object

Specified by:

setDebug in interface AssemblyLineConfig

Specified by:

setDebug in interface BaseConfiguration

Overrides:

setDebug in class BaseConfigurationImpl

Parameters:

debug - The new debug value

autoMapAllAttributes

public boolean autoMapAllAttributes(Object connectorName)
                             throws Exception

Switches, Flags & Limits

Specified by:

autoMapAllAttributes in interface AssemblyLineConfig

Parameters:

connectorName - the name of the Connector

Returns:

whether all attributes will be automatically mapped

Throws:

Exception - An exception is thrown if this method fails.

getClone

public Object getClone()
                throws Exception

Return self clone

Specified by:

getClone in interface BaseConfiguration

Overrides:

getClone in class BaseConfigurationImpl

Returns:

The clone value

Throws:

Exception - An exception is thrown if this method fails.

getThreadOptions

public PropertyConfig getThreadOptions()

Returns the Thread options config in the EventHandlers configuration

Specified by:

getThreadOptions in interface AssemblyLineConfig

Returns:

The threadOptions value

getSchema

public SchemaConfig getSchema(boolean input)

Returns the AssemblyLine's schema

Specified by:

getSchema in interface AssemblyLineConfig

Parameters:

input - if true, returns the input schema

Returns:

The schema object

getSchema

public SchemaConfig getSchema(String name)

Gets the schema attribute of the AssemblyLineConfigImpl object

Specified by:

getSchema in interface AssemblyLineConfig

Parameters:

name - the name of the schema config to retrieve

Returns:

The schema value

getAttributeMap

public AttributeMapConfig getAttributeMap(boolean input)

Returns the AssemblyLine's attribute map

Specified by:

getAttributeMap in interface AssemblyLineConfig

Parameters:

input - if true, returns the input attribute map

Returns:

The attribute map object

getAttributeMap

public AttributeMapConfig getAttributeMap(String name)

Gets the attributeMap attribute of the AssemblyLineConfigImpl object

Specified by:

getAttributeMap in interface AssemblyLineConfig

Parameters:

name - the name of the Attribute map

Returns:

The attributeMap value

getComponents

public ContainerConfig getComponents()

Returns the components container

Specified by:

getComponents in interface AssemblyLineConfig

Returns:

The componentCount value

getComponentCount

public int getComponentCount()

Returns the number of components in the assemblyline

Specified by:

getComponentCount in interface AssemblyLineConfig

Returns:

The componentCount value

getComponentByName

public BaseConfiguration getComponentByName(String name)

Returns the component attribute of the AssemblyLineConfig object

Specified by:

getComponentByName in interface AssemblyLineConfig

Parameters:

name - the name of the component

Returns:

The connector configuration object

getComponent

public BaseConfiguration getComponent(int position)

Returns the component attribute of the AssemblyLineConfig object

Specified by:

getComponent in interface AssemblyLineConfig

Parameters:

position - component position

Returns:

The connector configuration object

removeComponent

public void removeComponent(int position)

Removes a component from the assemblyline

Specified by:

removeComponent in interface AssemblyLineConfig

Parameters:

position - component position

insertComponent

public void insertComponent(BaseConfiguration connector,
                            int position)

Adds a connector configuration object to this assemblyline

Specified by:

insertComponent in interface AssemblyLineConfig

Parameters:

connector - The component configuration object to add

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

moveComponent

public boolean moveComponent(int position,
                             boolean up)

Moves a connector one position up or down

Specified by:

moveComponent in interface AssemblyLineConfig

Parameters:

position - Current connector position

up - Up (true) or down (false)

Returns:

true if the operation succeeded

renameComponent

public void renameComponent(String oldName,
                            String newName)
                     throws Exception

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

Specified by:

renameComponent in interface AssemblyLineConfig

Parameters:

newName - New local name

oldName - the old name of the component

Throws:

Exception - An exception is thrown if this method fails.

getEntryFeedComponents

public ContainerConfig getEntryFeedComponents()

Returns the components container

Specified by:

getEntryFeedComponents in interface AssemblyLineConfig

Returns:

The componentCount value

getDataFlowComponents

public ContainerConfig getDataFlowComponents()

Returns the components container

Specified by:

getDataFlowComponents in interface AssemblyLineConfig

Returns:

The componentCount value

containsComponent

public boolean containsComponent(String name)

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

Specified by:

containsComponent in interface AssemblyLineConfig

Parameters:

name - The name of the config

Returns:

True if it exists

getComponent

public BaseConfiguration getComponent(String name)

Returns the component configuration

Specified by:

getComponent in interface AssemblyLineConfig

Parameters:

name - The name of the config

Returns:

Null if it does not exist else a BaseConfiguration subclass

addComponent

public ContainerConfig addComponent(BaseConfiguration config)

This method adds a configuration object to the correct component container

Specified by:

addComponent in interface AssemblyLineConfig

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.

removeComponent

public void removeComponent(String name)

This method removes a named component configuration object

Specified by:

removeComponent in interface AssemblyLineConfig

Parameters:

name - the name of the component

removeComponent

public void removeComponent(BaseConfiguration component)

Removes a component from the assemblyline

Specified by:

removeComponent in interface AssemblyLineConfig

Parameters:

component - component config

getOperations

public ContainerConfig getOperations()

This method returns a list of supported operations

Specified by:

getOperations in interface OperationsConfig

getOperation

public OperationConfig getOperation(String name)

This method returns the config for a given operation

Specified by:

getOperation in interface OperationsConfig

createOperation

public OperationConfig createOperation(String name)
                                throws Exception

This method creates a new operation object.

Specified by:

createOperation in interface OperationsConfig

Throws:

Exception

getPublishedInitParams

public SchemaConfig getPublishedInitParams()

Description copied from interface: OperationsConfig

Returns the Published Initialization Parameter Schema for the AssemblyLine

Specified by:

getPublishedInitParams in interface OperationsConfig

setPublishedInitParams

public void setPublishedInitParams(SchemaConfig schema)
                            throws Exception

Description copied from interface: OperationsConfig

Sets the Published Initialization Parameter Schema for the AssemblyLine

Specified by:

setPublishedInitParams in interface OperationsConfig

Parameters:

schema - The new schema

Throws:

Exception

setupInheritanceChain

public void setupInheritanceChain()
                           throws Exception

Description copied from class: BaseConfigurationImpl

Established the inheritance chain for this object.

Specified by:

setupInheritanceChain in interface BaseConfiguration

Overrides:

setupInheritanceChain in class BaseConfigurationImpl

Throws:

Exception - if the operation does not succeed