BaseAtlasModule (Atlas :: Core 2.2.3 API)

java.lang.Object
- io.atlasmap.core.BaseAtlasModule

All Implemented Interfaces:: io.atlasmap.mxbean.AtlasModuleMXBean, io.atlasmap.spi.AtlasModule

Direct Known Subclasses:: PropertyModule

public abstract class BaseAtlasModule
extends Object
implements io.atlasmap.spi.AtlasModule, io.atlasmap.mxbean.AtlasModuleMXBean

Constructor Summary

Constructors
Constructor and Description

BaseAtlasModule()

Constructors
Constructor and Description
`BaseAtlasModule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected io.atlasmap.v2.Field`	`applySourceFieldActions(io.atlasmap.spi.AtlasInternalSession session)`
`protected io.atlasmap.v2.Field`	`applyTargetFieldActions(io.atlasmap.spi.AtlasInternalSession session)`
`protected io.atlasmap.spi.AtlasCollectionHelper`	`createCollectionHelper(io.atlasmap.spi.AtlasFieldActionService fieldActionService)`
`void`	`destroy()`
`ClassLoader`	`getClassLoader()`
`String`	`getClassName()`
`io.atlasmap.spi.AtlasCollectionHelper`	`getCollectionHelper()`
`io.atlasmap.spi.AtlasConversionService`	`getConversionService()`
`String[]`	`getDataFormats()`
`io.atlasmap.v2.DataSourceMetadata`	`getDataSourceMetadata()`
`String`	`getDocId()`
`String`	`getDocName()`
`io.atlasmap.spi.AtlasFieldActionService`	`getFieldActionService()`
`io.atlasmap.spi.AtlasModuleMode`	`getMode()`
`String`	`getModeName()`
`String`	`getName()`
`String[]`	`getPackageNames()`
`long`	`getSourceCount()`
`long`	`getSourceErrorCount()`
`long`	`getSourceMaxExecutionTime()`
`long`	`getSourceMinExecutionTime()`
`long`	`getSourceSuccessCount()`
`long`	`getSourceTotalExecutionTime()`
`long`	`getTargetCount()`
`long`	`getTargetErrorCount()`
`long`	`getTargetMaxExecutionTime()`
`long`	`getTargetMinExecutionTime()`
`long`	`getTargetSuccessCount()`
`long`	`getTargetTotalExecutionTime()`
`String`	`getUri()`
`String`	`getUriDataType()`
`Map<String,String>`	`getUriParameters()`
`String`	`getUuid()`
`String`	`getVersion()`
`void`	`init()`
`boolean`	`isAutomaticallyProcessOutputFieldActions()`
`boolean`	`isSourceSupported()`
`Boolean`	`isStatisticsEnabled()`
`Boolean`	`isStatisticsSupported()`
`Boolean`	`isSupportedField(io.atlasmap.v2.Field field)`
`boolean`	`isTargetSupported()`
`List<io.atlasmap.spi.AtlasModuleMode>`	`listSupportedModes()`
`void`	`populateTargetField(io.atlasmap.spi.AtlasInternalSession session)`
`protected void`	`processLookupField(io.atlasmap.spi.AtlasInternalSession session, io.atlasmap.v2.LookupTable lookupTable, Object sourceValue, io.atlasmap.v2.Field targetField)`
`void`	`processPostValidation(io.atlasmap.spi.AtlasInternalSession session)`
`TabularData`	`readAndResetStatistics()`
`void`	`setAutomaticallyProcessOutputFieldActions(boolean automaticallyProcessOutputFieldActions)`
`void`	`setClassLoader(ClassLoader classLoader)`
`void`	`setConversionService(io.atlasmap.spi.AtlasConversionService atlasConversionService)`
`void`	`setDataSourceMetadata(io.atlasmap.v2.DataSourceMetadata meta)`
`void`	`setDocId(String docId)`
`void`	`setDocName(String docName)`
`void`	`setFieldActionService(io.atlasmap.spi.AtlasFieldActionService atlasFieldActionService)`
`void`	`setMode(io.atlasmap.spi.AtlasModuleMode atlasModuleMode)`
`void`	`setStatisticsEnabled(boolean enabled)`
`void`	`setUri(String uri)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.atlasmap.spi.AtlasModule
cloneField, processPostSourceExecution, processPostTargetExecution, processPreSourceExecution, processPreTargetExecution, processPreValidation, readSourceValue, writeTargetValue

- Constructor Detail
  - BaseAtlasModule
```
public BaseAtlasModule()
```
- Method Detail
  - init
```
public void init()
          throws io.atlasmap.api.AtlasException
```
    Specified by:
    
    init in interface io.atlasmap.spi.AtlasModule
    
    Throws:
    
    io.atlasmap.api.AtlasException
  - destroy
```
public void destroy()
             throws io.atlasmap.api.AtlasException
```
    Specified by:
    
    destroy in interface io.atlasmap.spi.AtlasModule
    
    Throws:
    
    io.atlasmap.api.AtlasException
  - setClassLoader
```
public void setClassLoader(ClassLoader classLoader)
```
    Specified by:
    
    setClassLoader in interface io.atlasmap.spi.AtlasModule
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader in interface io.atlasmap.spi.AtlasModule
  - processPostValidation
```
public void processPostValidation(io.atlasmap.spi.AtlasInternalSession session)
                           throws io.atlasmap.api.AtlasException
```
    Specified by:
    
    processPostValidation in interface io.atlasmap.spi.AtlasModule
    
    Throws:
    
    io.atlasmap.api.AtlasException
  - populateTargetField
```
public void populateTargetField(io.atlasmap.spi.AtlasInternalSession session)
                         throws io.atlasmap.api.AtlasException
```
    Specified by:
    
    populateTargetField in interface io.atlasmap.spi.AtlasModule
    
    Throws:
    
    io.atlasmap.api.AtlasException
  - processLookupField
```
protected void processLookupField(io.atlasmap.spi.AtlasInternalSession session,
                                  io.atlasmap.v2.LookupTable lookupTable,
                                  Object sourceValue,
                                  io.atlasmap.v2.Field targetField)
                           throws io.atlasmap.api.AtlasException
```
    Throws:
    
    io.atlasmap.api.AtlasException
  - applyTargetFieldActions
```
protected io.atlasmap.v2.Field applyTargetFieldActions(io.atlasmap.spi.AtlasInternalSession session)
                                                throws io.atlasmap.api.AtlasException
```
    Throws:
    
    io.atlasmap.api.AtlasException
  - applySourceFieldActions
```
protected io.atlasmap.v2.Field applySourceFieldActions(io.atlasmap.spi.AtlasInternalSession session)
                                                throws io.atlasmap.api.AtlasException
```
    Throws:
    
    io.atlasmap.api.AtlasException
  - getMode
```
public io.atlasmap.spi.AtlasModuleMode getMode()
```
    Specified by:
    
    getMode in interface io.atlasmap.spi.AtlasModule
  - setMode
```
public void setMode(io.atlasmap.spi.AtlasModuleMode atlasModuleMode)
```
    Specified by:
    
    setMode in interface io.atlasmap.spi.AtlasModule
  - isStatisticsSupported
```
public Boolean isStatisticsSupported()
```
    Specified by:
    
    isStatisticsSupported in interface io.atlasmap.spi.AtlasModule
  - isStatisticsEnabled
```
public Boolean isStatisticsEnabled()
```
    Specified by:
    
    isStatisticsEnabled in interface io.atlasmap.mxbean.AtlasModuleMXBean
    
    Specified by:
    
    isStatisticsEnabled in interface io.atlasmap.spi.AtlasModule
  - listSupportedModes
```
public List<io.atlasmap.spi.AtlasModuleMode> listSupportedModes()
```
    Specified by:
    
    listSupportedModes in interface io.atlasmap.spi.AtlasModule
  - getConversionService
```
public io.atlasmap.spi.AtlasConversionService getConversionService()
```
    Specified by:
    
    getConversionService in interface io.atlasmap.spi.AtlasModule
  - getCollectionHelper
```
public io.atlasmap.spi.AtlasCollectionHelper getCollectionHelper()
```
    Specified by:
    
    getCollectionHelper in interface io.atlasmap.spi.AtlasModule
  - getDocId
```
public String getDocId()
```
    Specified by:
    
    getDocId in interface io.atlasmap.spi.AtlasModule
  - setDocId
```
public void setDocId(String docId)
```
    Specified by:
    
    setDocId in interface io.atlasmap.spi.AtlasModule
  - getUri
```
public String getUri()
```
    Specified by:
    
    getUri in interface io.atlasmap.spi.AtlasModule
  - setUri
```
public void setUri(String uri)
```
    Specified by:
    
    setUri in interface io.atlasmap.spi.AtlasModule
  - getUriDataType
```
public String getUriDataType()
```
    Specified by:
    
    getUriDataType in interface io.atlasmap.spi.AtlasModule
  - getUriParameters
```
public Map<String,String> getUriParameters()
```
    Specified by:
    
    getUriParameters in interface io.atlasmap.spi.AtlasModule
  - setConversionService
```
public void setConversionService(io.atlasmap.spi.AtlasConversionService atlasConversionService)
```
    Specified by:
    
    setConversionService in interface io.atlasmap.spi.AtlasModule
  - getFieldActionService
```
public io.atlasmap.spi.AtlasFieldActionService getFieldActionService()
```
    Specified by:
    
    getFieldActionService in interface io.atlasmap.spi.AtlasModule
  - setFieldActionService
```
public void setFieldActionService(io.atlasmap.spi.AtlasFieldActionService atlasFieldActionService)
```
    Specified by:
    
    setFieldActionService in interface io.atlasmap.spi.AtlasModule
  - createCollectionHelper
```
protected io.atlasmap.spi.AtlasCollectionHelper createCollectionHelper(io.atlasmap.spi.AtlasFieldActionService fieldActionService)
```
  - isAutomaticallyProcessOutputFieldActions
```
public boolean isAutomaticallyProcessOutputFieldActions()
```
  - setAutomaticallyProcessOutputFieldActions
```
public void setAutomaticallyProcessOutputFieldActions(boolean automaticallyProcessOutputFieldActions)
```
  - isSupportedField
```
public Boolean isSupportedField(io.atlasmap.v2.Field field)
```
    Specified by:
    
    isSupportedField in interface io.atlasmap.spi.AtlasModule
  - setDataSourceMetadata
```
public void setDataSourceMetadata(io.atlasmap.v2.DataSourceMetadata meta)
```
    Specified by:
    
    setDataSourceMetadata in interface io.atlasmap.spi.AtlasModule
  - getDataSourceMetadata
```
public io.atlasmap.v2.DataSourceMetadata getDataSourceMetadata()
```
    Specified by:
    
    getDataSourceMetadata in interface io.atlasmap.spi.AtlasModule
  - setDocName
```
public void setDocName(String docName)
```
    Specified by:
    
    setDocName in interface io.atlasmap.spi.AtlasModule
  - getDocName
```
public String getDocName()
```
    Specified by:
    
    getDocName in interface io.atlasmap.spi.AtlasModule
  - isSourceSupported
```
public boolean isSourceSupported()
```
    Specified by:
    
    isSourceSupported in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - isTargetSupported
```
public boolean isTargetSupported()
```
    Specified by:
    
    isTargetSupported in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getClassName
```
public String getClassName()
```
    Specified by:
    
    getClassName in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getDataFormats
```
public String[] getDataFormats()
```
    Specified by:
    
    getDataFormats in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getModeName
```
public String getModeName()
```
    Specified by:
    
    getModeName in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getPackageNames
```
public String[] getPackageNames()
```
    Specified by:
    
    getPackageNames in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getSourceErrorCount
```
public long getSourceErrorCount()
```
    Specified by:
    
    getSourceErrorCount in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getSourceCount
```
public long getSourceCount()
```
    Specified by:
    
    getSourceCount in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getSourceMaxExecutionTime
```
public long getSourceMaxExecutionTime()
```
    Specified by:
    
    getSourceMaxExecutionTime in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getSourceMinExecutionTime
```
public long getSourceMinExecutionTime()
```
    Specified by:
    
    getSourceMinExecutionTime in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getSourceSuccessCount
```
public long getSourceSuccessCount()
```
    Specified by:
    
    getSourceSuccessCount in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getSourceTotalExecutionTime
```
public long getSourceTotalExecutionTime()
```
    Specified by:
    
    getSourceTotalExecutionTime in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getTargetCount
```
public long getTargetCount()
```
    Specified by:
    
    getTargetCount in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getTargetErrorCount
```
public long getTargetErrorCount()
```
    Specified by:
    
    getTargetErrorCount in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getTargetMaxExecutionTime
```
public long getTargetMaxExecutionTime()
```
    Specified by:
    
    getTargetMaxExecutionTime in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getTargetMinExecutionTime
```
public long getTargetMinExecutionTime()
```
    Specified by:
    
    getTargetMinExecutionTime in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getTargetSuccessCount
```
public long getTargetSuccessCount()
```
    Specified by:
    
    getTargetSuccessCount in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getTargetTotalExecutionTime
```
public long getTargetTotalExecutionTime()
```
    Specified by:
    
    getTargetTotalExecutionTime in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getUuid
```
public String getUuid()
```
    Specified by:
    
    getUuid in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - getVersion
```
public String getVersion()
```
    Specified by:
    
    getVersion in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - readAndResetStatistics
```
public TabularData readAndResetStatistics()
```
    Specified by:
    
    readAndResetStatistics in interface io.atlasmap.mxbean.AtlasModuleMXBean
  - setStatisticsEnabled
```
public void setStatisticsEnabled(boolean enabled)
```
    Specified by:
    
    setStatisticsEnabled in interface io.atlasmap.mxbean.AtlasModuleMXBean

Class BaseAtlasModule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.atlasmap.spi.AtlasModule

Constructor Detail

BaseAtlasModule

Method Detail

init

destroy

setClassLoader

getClassLoader

processPostValidation

populateTargetField

processLookupField

applyTargetFieldActions

applySourceFieldActions

getMode

setMode

isStatisticsSupported

isStatisticsEnabled

listSupportedModes

getConversionService

getCollectionHelper

getDocId

setDocId

getUri

setUri

getUriDataType

getUriParameters

setConversionService

getFieldActionService

setFieldActionService

createCollectionHelper

isAutomaticallyProcessOutputFieldActions

setAutomaticallyProcessOutputFieldActions

isSupportedField

setDataSourceMetadata

getDataSourceMetadata

setDocName

getDocName

isSourceSupported

isTargetSupported

getClassName

getDataFormats

getModeName

getName

getPackageNames

getSourceErrorCount

getSourceCount

getSourceMaxExecutionTime

getSourceMinExecutionTime

getSourceSuccessCount

getSourceTotalExecutionTime

getTargetCount

getTargetErrorCount

getTargetMaxExecutionTime

getTargetMinExecutionTime

getTargetSuccessCount

getTargetTotalExecutionTime

getUuid

getVersion

readAndResetStatistics

setStatisticsEnabled