public class ConfigProperties
extends java.lang.Object
This class models the configuration of a dataload component in the dataload configuration and business object configurations files.
You can traverse from the current dataload component to its parents component and up to the root configuration.
Each node contains a property map and a map of its children node config properties and a pointer to its parent.
Constructor and Description |
---|
ConfigProperties(ConfigProperties aParentConfigProperties)
This constructor will initializes instance variables and save the parent nodes configuration properties.
|
Modifier and Type | Method and Description |
---|---|
java.util.Map |
getAttributeMap()
The method returns the set of properties read in from the configuration files.
|
java.lang.String |
getBusinessContextProperty(java.lang.String propertyName)
It returns a business context value for a given property name.
|
java.util.Map |
getChildConfigPropertiesMap()
The method returns the set of properties read in from the configuration files.
|
java.util.Map |
getDataExtensionPropertyMap()
This method will return the extension loader properties read in from the data load
configuration stored in a
Map . |
java.lang.String |
getDataLoadComponentType()
The method returns the data load component type this configuration is associated with.
|
java.util.Map |
getDataSourcePropertyMap()
This method will return the datasource properties read in from the data load
configuration stored in a
Map . |
java.util.Map |
getDataWriterPropertyMap()
This method will return the data writer properties read in from the data load
configuration stored in a
Map . |
java.util.Map |
getIDResolverPropertyMap()
This method will return the id resolver properties read in from the data load
configuration stored in a
Map . |
java.lang.String |
getLocalProperty(java.lang.String propertyName)
This method returns the value of a property read in from the data load configuration files.
|
java.util.Map |
getMergedPropertiesMap()
Gets the merged properties Map.
|
ConfigProperties |
getParentConfigProperties()
The method returns the configuration properties of the parent XML node.
|
java.lang.String |
getParentDataLoaderUniqueName()
This method returns the unique name of the parent data loader of the data load component
this configuration is association with.
|
java.util.Map |
getPropertiesMap()
The method returns the set of properties read in from the configuration files.
|
java.lang.String |
getProperty(java.lang.String propertyName)
This method returns the value of a property read in from the data load configuration files.
|
java.util.Map |
getPropertyMapByGroupName(java.lang.String name)
This method returns a group of properties stored in a
map . |
ConfigProperties |
getRootConfigProperties()
This method returns a the root configuration properties of the data load configuration.
|
java.util.Map |
getTargetDatabasePropertyMap()
This method will return the target database properties read in from the data load
configuration stored in a
Map . |
void |
setDataLoadComponentType(java.lang.String aDataLoadComponentType)
The method sets the data load component type this configuration is associated with.
|
java.lang.String |
toString()
This method returns a
String representation of the
dataload configuration. |
public ConfigProperties(ConfigProperties aParentConfigProperties)
This constructor will initializes instance variables and save the parent nodes configuration properties.
If null
is passed in as the parent configuration, this configuration will be treated
as the root configuration.
aParentConfigProperties
- The configuration properties of the parent XML node.public java.lang.String getParentDataLoaderUniqueName()
This method returns the unique name of the parent data loader of the data load component this configuration is association with.
public java.util.Map getPropertiesMap()
The method returns the set of properties read in from the configuration files.
These properties include:Map
that contains name-value pairs.Map
.public java.util.Map getAttributeMap()
The method returns the set of properties read in from the configuration files.
These properties include:Map
.public java.util.Map getChildConfigPropertiesMap()
The method returns the set of properties read in from the configuration files.
These properties include:Map
that contains name-value pairs.Map
.public ConfigProperties getParentConfigProperties()
The method returns the configuration properties of the parent XML node.
public java.lang.String getDataLoadComponentType()
The method returns the data load component type this configuration is associated with.
It can be either:
DataLoadConstants.DL_DATA_LOADER
DataLoadConstants.DL_DATA_READER
DataLoadConstants.DL_BUSINESS_OBJECT_BUILDER
DataLoadConstants.DL_BUSINESS_OBJECT_MEDIATOR
DataLoadConstants.DL_DATA_WRITER
public void setDataLoadComponentType(java.lang.String aDataLoadComponentType)
The method sets the data load component type this configuration is associated with.
It can be either:
DataLoadConstants.DL_DATA_LOADER
DataLoadConstants.DL_DATA_READER
DataLoadConstants.DL_BUSINESS_OBJECT_BUILDER
DataLoadConstants.DL_BUSINESS_OBJECT_MEDIATOR
DataLoadConstants.DL_DATA_WRITER
aDataLoadComponentType
- The data load component type this configuration is associated with.public java.lang.String getLocalProperty(java.lang.String propertyName)
This method returns the value of a property read in from the data load configuration files.
This method does not traverse up the parent configuration properties to look for the property.
propertyName
- The property name of the property you would like to retrieve the value for.public java.lang.String getProperty(java.lang.String propertyName)
This method returns the value of a property read in from the data load configuration files.
This method will traverse up the parent configuration properties up to the root to look for the property and will stop traversal if it finds the value in one of the parent configurations.
propertyName
- The property name of the property you would like to retrieve the value for.public java.util.Map getPropertyMapByGroupName(java.lang.String name)
This method returns a group of properties stored in a map
.
name
- The group name of the group of properties.Map
containing name-value pairs.public ConfigProperties getRootConfigProperties()
This method returns a the root configuration properties of the data load configuration.
public java.util.Map getTargetDatabasePropertyMap()
This method will return the target database properties read in from the data load
configuration stored in a Map
.
Map
.public java.util.Map getDataSourcePropertyMap()
This method will return the datasource properties read in from the data load
configuration stored in a Map
.
Map
.public java.util.Map getDataExtensionPropertyMap()
This method will return the extension loader properties read in from the data load
configuration stored in a Map
.
Map
.public java.util.Map getIDResolverPropertyMap()
This method will return the id resolver properties read in from the data load
configuration stored in a Map
.
Map
.public java.util.Map getDataWriterPropertyMap()
This method will return the data writer properties read in from the data load
configuration stored in a Map
.
Map
.public java.lang.String getBusinessContextProperty(java.lang.String propertyName)
It returns a business context value for a given property name.
If it cannot find the business context in the current node, it will traverse to its parents up to the root.
propertyName
- The name of the property for which the value is to be retrieved from the business context.public java.lang.String toString()
This method returns a String
representation of the
dataload configuration.
toString
in class java.lang.Object
String
representation of the dataload configuration.public java.util.Map getMergedPropertiesMap()