Package 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, java.io.Serializable

public class AssemblyLineConfigImpl
extends BaseConfigurationImpl
implements AssemblyLineConfig

The implementation class for the configuration of an AssemblyLine.

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

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

CHILD_PATH_SEPARATOR, DISABLE_EXTPROPS, DISABLE_INHERITANCE, INHERIT_NONE, INHERIT_PARENT, ONE_LEVEL, RECURSIVE, RECURSIVE_ONELEVEL, RECURSIVE_SUBTREE, SEARCH_EXACTCASE, SEARCH_ONELEVEL, SEARCH_PARAMNAME, SEARCH_PARAMNAME_RE, SEARCH_PROPERTY, SEARCH_REGEX, SEARCH_SUBSTRING, SUBTREE

Constructor Summary

Constructors

Constructor	Description
AssemblyLineConfigImpl()	Constructor for the AssemblyLineConfigImpl object.
AssemblyLineConfigImpl(java.lang.Object config)	Constructor providing a TreeMap of attribute/value pairs.

Method Summary

Modifier and Type	Method	Description
ContainerConfig	addComponent(BaseConfiguration config)	This method adds a component configuration object to the correct component container
boolean	autoMapAllAttributes(java.lang.Object connectorName)	Returns the automap flag for the AssemblyLine
boolean	containsComponent(java.lang.String name)	Returns true if there is component (data flow or entry feed) named name
OperationConfig	createOperation(java.lang.String name)	This method creates a new operation object.
AttributeMapConfig	getAttributeMap(boolean input)	Returns the AssemblyLine's attribute map
AttributeMapConfig	getAttributeMap(java.lang.String name)	Returns the AssemblyLine's attribute map by name ("Input"/"Output")
CheckpointConfig	getCheckpointConfig()	Deprecated.
java.lang.Object	getClone()	Return self clone
BaseConfiguration	getComponent(int position)	Deprecated. in TDI 7.0
BaseConfiguration	getComponent(java.lang.String name)	Returns the component configuration
BaseConfiguration	getComponentByName(java.lang.String name)	Deprecated. in TDI 7.0
int	getComponentCount()	Deprecated.
ContainerConfig	getComponents()	Deprecated. in TDI 7.0
ConnectorConfig	getConnector(int position)	Returns the connector attribute of the AssemblyLineConfig object
ConnectorConfig	getConnectorByName(java.lang.Object connectorName)	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 object.
boolean	getDebug(boolean defval)	Returns the debug flag for the object.
ContainerConfig	getEntryFeedComponents()	Returns the entry feed components container
HookConfig	getHook(java.lang.String name)	Returns a specific HookConfig
HooksConfig	getHooks()	Returns the AssemblyLine's HooksConfig
LogConfig	getLogConfig()	Returns the LogConfig object
OperationConfig	getOperation(java.lang.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 config object
SchemaConfig	getSchema(boolean input)	Returns the AssemblyLine's schema
SchemaConfig	getSchema(java.lang.String name)	Returns the AssemblyLine's schema by name ("Input"/"Output")
BaseConfiguration	getSettings()	Returns the AssemblyLine Settings
SimulationConfig	getSimulationConfig()	Retrieves the Simulation Configuration which corresponds to the AssemblyLine.
CallConfig	getTaskInputParameters()	Deprecated. Use getSchema(true)
CallConfig	getTaskOutputParameters()	Deprecated. Use getSchema(false)
PropertyConfig	getThreadOptions()	Returns the Thread options config in the AssemblyLine configuration
void	init()	Preload all connectors
void	initSimulationConfig()	Initializes the Simulation config.
void	insertComponent(BaseConfiguration connector, int position)	Deprecated. in TDI 7.0
boolean	moveComponent(int position, boolean up)	Deprecated. in TDI 7.0
void	removeComponent(int position)	Deprecated. in TDI 7.0
void	removeComponent(BaseConfiguration component)	Removes a component from the assemblyline
void	removeComponent(java.lang.String name)	This method removes a named component configuration object
void	renameComponent(java.lang.String oldName, java.lang.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 object.
void	setPublishedInitParams(SchemaConfig schema)	Sets the Published Initialization Parameter Schema for the AssemblyLine
void	setSettings(BaseConfiguration settings)	Sets the AssemblyLine Settings of the AssemblyLineConfig
void	setupInheritanceChain()	Established the inheritance chain for this object.

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

addListener, configurationChanged, deepClone, detachFromParent, expandPropertyValue, expandPropertyValue, flatten, fromEntry, getBooleanParameter, getChild, getChildForPath, getChildNames, getData, getDataIterator, getDebugBreak, getEnabled, getFlags, getInheritsFrom, getInheritsFromRef, getIntegerParameter, getKeys, getLogEnabled, getLongName, getMetamergeConfig, getModified, getModTS, getName, getNamespace, getNullBehavior, getNullBehaviorValue, getNullDefinition, getNullDefinitionValue, getParameter, getParameter, getParameter, getParameterPropertySource, getParameterPropertySourceFromValue, getParameterRaw, getParent, getParentName, getPath, getReferences, getResHash, getScript, getScriptEngine, getShortName, getStringParameter, getSubstitutionMap, getUseConfigListeners, getUseListeners, getUserComment, hasParameter, isExpression, isParameterLocal, isProtectedParameter, nameForChild, notifyChange, notifyChange, notifyChange, performNotifyChange, reattachToParent, removeListener, removeParameter, search, search, setBooleanParameter, setChild, setData, setDebugBreak, setEnabled, setFlags, setInheritsFrom, setInheritsFromRef, setIntegerParameter, setLogEnabled, setMetamergeConfig, setModified, setModTS, setName, setName, setNullBehavior, setNullBehaviorValue, setNullDefinition, setNullDefinitionValue, setParameter, setParameter, setParameterPropertySource, setParent, setProtectedParameter, setProtectedParameter, setScript, setScriptEngine, setStringParameter, setSubstitutionMap, setUseConfigListeners, 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

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

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

Constructor Detail

AssemblyLineConfigImpl

public AssemblyLineConfigImpl()

Constructor for the AssemblyLineConfigImpl object.

AssemblyLineConfigImpl

public AssemblyLineConfigImpl(java.lang.Object config)

Constructor providing a TreeMap of attribute/value pairs.

Parameters:

config - the config object containing initial data

Method Detail

init

public void init()
          throws java.lang.Exception

Preload all connectors

Specified by:

init in interface BaseConfiguration

Overrides:

init in class BaseConfigurationImpl

Throws:

java.lang.Exception - An exception is thrown if this method fails.

getConnectorCount

public int getConnectorCount()

Returns the number of connectors in the assemblyline

Specified by:

getConnectorCount in interface AssemblyLineConfig

Returns:

The connectorCount value

getConnector

public ConnectorConfig getConnector(int position)

Returns the connector attribute of the AssemblyLineConfig object

Specified by:

getConnector in interface AssemblyLineConfig

Parameters:

position - Connector position

Returns:

The connector configuration object

getConnectorByName

public ConnectorConfig getConnectorByName(java.lang.Object connectorName)

Returns the connector attribute of the AssemblyLineConfig object

Specified by:

getConnectorByName in interface AssemblyLineConfig

Parameters:

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

Returns:

The connector configuration object.

getHook

public HookConfig getHook(java.lang.String name)

Returns a specific HookConfig

Specified by:

getHook in interface AssemblyLineConfig

Parameters:

name - The name of the hook

Returns:

The HookConfig with the given name

getHooks

public HooksConfig getHooks()

Returns the AssemblyLine's HooksConfig

Specified by:

getHooks in interface AssemblyLineConfig

Returns:

The hooks of this AssemblyLine

getSettings

public BaseConfiguration getSettings()

Returns the AssemblyLine Settings

Specified by:

getSettings in interface AssemblyLineConfig

Returns:

The settings value

setSettings

public void setSettings(BaseConfiguration settings)

Sets the AssemblyLine Settings of the AssemblyLineConfig

Specified by:

setSettings in interface AssemblyLineConfig

Parameters:

settings - The new settings value

getTaskInputParameters

@Deprecated
public CallConfig getTaskInputParameters()

Deprecated.

Use getSchema(true)

Call Parameters

Specified by:

getTaskInputParameters in interface AssemblyLineConfig

Returns:

The taskInputParameters value

getTaskOutputParameters

@Deprecated
public CallConfig getTaskOutputParameters()

Deprecated.

Use getSchema(false)

Output Parameters

Specified by:

getTaskOutputParameters in interface AssemblyLineConfig

Returns:

The taskOutputParameters value

getCheckpointConfig

public CheckpointConfig getCheckpointConfig()

Deprecated.

Returns the Checkpoint info object

Specified by:

getCheckpointConfig in interface AssemblyLineConfig

Returns:

The checkpointConfig value

getSandboxConfig

public SandboxConfig getSandboxConfig()

Returns the Sandbox config object

Specified by:

getSandboxConfig in interface AssemblyLineConfig

Returns:

the Sandbox config object

getLogConfig

public LogConfig getLogConfig()

Returns the LogConfig object

Specified by:

getLogConfig in interface AssemblyLineConfig

Returns:

The logConfig value

getDebug

public boolean getDebug()

Returns the debug flag for the object.

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)

Returns the debug flag for the object.

Specified by:

getDebug in interface AssemblyLineConfig

Specified by:

getDebug in interface BaseConfiguration

Overrides:

getDebug in class BaseConfigurationImpl

Parameters:

defval - The value to be returned, if the debug parameter cannot be found

Returns:

The debug value.

setDebug

public void setDebug(boolean debug)

Sets the debug flag for the 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(java.lang.Object connectorName)
                             throws java.lang.Exception

Returns the automap flag for the AssemblyLine

Specified by:

autoMapAllAttributes in interface AssemblyLineConfig

Parameters:

connectorName - The name of an AssemblyLine Component

Returns:

true, if the AssemblyLine Component maps all the attributes

Throws:

java.lang.Exception - if the check does not succeed

getClone

public java.lang.Object getClone()
                          throws java.lang.Exception

Return self clone

Specified by:

getClone in interface BaseConfiguration

Overrides:

getClone in class BaseConfigurationImpl

Returns:

The clone value

Throws:

java.lang.Exception - An exception is thrown if this method fails.

getThreadOptions

public PropertyConfig getThreadOptions()

Returns the Thread options config in the AssemblyLine 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(java.lang.String name)

Returns the AssemblyLine's schema by name ("Input"/"Output")

Specified by:

getSchema in interface AssemblyLineConfig

Parameters:

name - the name of the schema config to retrieve

Returns:

The schema config object

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(java.lang.String name)

Returns the AssemblyLine's attribute map by name ("Input"/"Output")

Specified by:

getAttributeMap in interface AssemblyLineConfig

Parameters:

name - the name of the attribute map config to retrieve

Returns:

The attribute map config object

getComponents

@Deprecated
public ContainerConfig getComponents()

Deprecated.

in TDI 7.0

Description copied from interface: AssemblyLineConfig

Returns the components container

Specified by:

getComponents in interface AssemblyLineConfig

Returns:

null

getComponentCount

@Deprecated
public int getComponentCount()

Deprecated.

Description copied from interface: AssemblyLineConfig

Returns the number of components in the assemblyline

Specified by:

getComponentCount in interface AssemblyLineConfig

Returns:

0

getComponentByName

@Deprecated
public BaseConfiguration getComponentByName(java.lang.String name)

Deprecated.

in TDI 7.0

Description copied from interface: AssemblyLineConfig

Returns the component attribute of the AssemblyLineConfig object

Specified by:

getComponentByName in interface AssemblyLineConfig

Parameters:

name -

Returns:

null

getComponent

@Deprecated
public BaseConfiguration getComponent(int position)

Deprecated.

in TDI 7.0

Description copied from interface: AssemblyLineConfig

Returns the component attribute of the AssemblyLineConfig object

Specified by:

getComponent in interface AssemblyLineConfig

Parameters:

position -

Returns:

null

removeComponent

@Deprecated
public void removeComponent(int position)

Deprecated.

in TDI 7.0

Does nothing.

Specified by:

removeComponent in interface AssemblyLineConfig

Parameters:

position -

insertComponent

@Deprecated
public void insertComponent(BaseConfiguration connector,
                            int position)

Deprecated.

in TDI 7.0

Does nothing.

Specified by:

insertComponent in interface AssemblyLineConfig

Parameters:

connector -

position -

moveComponent

@Deprecated
public boolean moveComponent(int position,
                             boolean up)

Deprecated.

in TDI 7.0

Description copied from interface: AssemblyLineConfig

Moves a connector one position up or down

Specified by:

moveComponent in interface AssemblyLineConfig

Parameters:

position -

up -

Returns:

false

renameComponent

public void renameComponent(java.lang.String oldName,
                            java.lang.String newName)
                     throws java.lang.Exception

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

Specified by:

renameComponent in interface AssemblyLineConfig

Parameters:

oldName - The current name

newName - .New local name

Throws:

java.lang.Exception - if the provided name is invalid or there is already a component with the specified name.

getEntryFeedComponents

public ContainerConfig getEntryFeedComponents()

Returns the entry feed components container

Specified by:

getEntryFeedComponents in interface AssemblyLineConfig

Returns:

The entry feed components value

getDataFlowComponents

public ContainerConfig getDataFlowComponents()

Returns the data flow components container

Specified by:

getDataFlowComponents in interface AssemblyLineConfig

Returns:

The data flow components value

containsComponent

public boolean containsComponent(java.lang.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(java.lang.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 component 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(java.lang.String name)

This method removes a named component configuration object

Specified by:

removeComponent in interface AssemblyLineConfig

Parameters:

name - The name of the component to remove.

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

Returns:

ContainerConfig object

getOperation

public OperationConfig getOperation(java.lang.String name)

This method returns the config for a given operation.

Specified by:

getOperation in interface OperationsConfig

Parameters:

name -

Returns:

OperationConfig object

createOperation

public OperationConfig createOperation(java.lang.String name)
                                throws java.lang.Exception

This method creates a new operation object.

Specified by:

createOperation in interface OperationsConfig

Parameters:

name -

Returns:

OperationConfig object

Throws:

java.lang.Exception

getPublishedInitParams

public SchemaConfig getPublishedInitParams()

Returns the Published Initialization Parameter Schema for the AssemblyLine

Specified by:

getPublishedInitParams in interface OperationsConfig

setPublishedInitParams

public void setPublishedInitParams(SchemaConfig schema)
                            throws java.lang.Exception

Sets the Published Initialization Parameter Schema for the AssemblyLine

Specified by:

setPublishedInitParams in interface OperationsConfig

Parameters:

schema - The new schema

Throws:

java.lang.Exception

setupInheritanceChain

public void setupInheritanceChain()
                           throws java.lang.Exception

Established the inheritance chain for this object.

Specified by:

setupInheritanceChain in interface BaseConfiguration

Overrides:

setupInheritanceChain in class BaseConfigurationImpl

Throws:

java.lang.Exception - if the operation could not be performed

getSimulationConfig

public SimulationConfig getSimulationConfig()
                                     throws java.lang.Exception

Retrieves the Simulation Configuration which corresponds to the AssemblyLine.

Specified by:

getSimulationConfig in interface AssemblyLineConfig

Returns:

SimulationConfig object which represents the Simulation Configuration of the current AssemblyLine.

Throws:

java.lang.Exception - if an error occurs while initializing the simulation config for the first time.

initSimulationConfig

public void initSimulationConfig()
                          throws java.lang.Exception

Initializes the Simulation config.

Throws:

java.lang.Exception - if the initialization fails