Package io.atlasmap.core

Class BaseAtlasModule

java.lang.Object

io.atlasmap.core.BaseAtlasModule

All Implemented Interfaces:

AtlasModuleMXBean, AtlasModule

Direct Known Subclasses:

CsvModule, JavaModule, JsonModule, PropertyModule, XmlModule

public abstract class BaseAtlasModule
extends Object
implements AtlasModule, AtlasModuleMXBean

Constructor Summary

Constructors

Constructor	Description
BaseAtlasModule()

Method Summary

Modifier and Type	Method	Description
protected Field	applySourceFieldActions(AtlasInternalSession session)
protected Field	applyTargetFieldActions(AtlasInternalSession session)
protected AtlasCollectionHelper	createCollectionHelper(AtlasFieldActionService fieldActionService)
void	destroy()
ClassLoader	getClassLoader()
String	getClassName()
AtlasCollectionHelper	getCollectionHelper()
AtlasConversionService	getConversionService()
String[]	getDataFormats()
DataSourceMetadata	getDataSourceMetadata()
String	getDocId()
String	getDocName()
AtlasFieldActionService	getFieldActionService()
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(Field field)
boolean	isTargetSupported()
List<AtlasModuleMode>	listSupportedModes()
void	populateTargetField(AtlasInternalSession session)	Populate target field value, usually by just copy from source field value.
protected void	processLookupField(AtlasInternalSession session, LookupTable lookupTable, Object sourceValue, Field targetField)
void	processPostValidation(AtlasInternalSession session)
TabularData	readAndResetStatistics()
void	setAutomaticallyProcessOutputFieldActions(boolean automaticallyProcessOutputFieldActions)
void	setClassLoader(ClassLoader classLoader)
void	setConversionService(AtlasConversionService atlasConversionService)
void	setDataSourceMetadata(DataSourceMetadata meta)
void	setDocId(String docId)
void	setDocName(String docName)
void	setFieldActionService(AtlasFieldActionService atlasFieldActionService)
void	setMode(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, createField, processPostSourceExecution, processPostTargetExecution, processPreSourceExecution, processPreTargetExecution, processPreValidation, readSourceValue, writeTargetValue

Constructor Details

BaseAtlasModule

public BaseAtlasModule()

Method Details

init

public void init()
          throws AtlasException

Specified by:

init in interface AtlasModule

Throws:

AtlasException

destroy

public void destroy()
             throws AtlasException

Specified by:

destroy in interface AtlasModule

Throws:

AtlasException

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Specified by:

setClassLoader in interface AtlasModule

getClassLoader

public ClassLoader getClassLoader()

Specified by:

getClassLoader in interface AtlasModule

processPostValidation

public void processPostValidation(AtlasInternalSession session)
                           throws AtlasException

Specified by:

processPostValidation in interface AtlasModule

Throws:

AtlasException

populateTargetField

public void populateTargetField(AtlasInternalSession session)
                         throws AtlasException

Description copied from interface: AtlasModule

Populate target field value, usually by just copy from source field value. Also apply type converters where it's needed.

Specified by:

populateTargetField in interface AtlasModule

Parameters:

session - current session

Throws:

AtlasException - failed to populate target field value

processLookupField

protected void processLookupField(AtlasInternalSession session,
 LookupTable lookupTable,
 Object sourceValue,
 Field targetField)
                           throws AtlasException

Throws:

AtlasException

applyTargetFieldActions

protected Field applyTargetFieldActions(AtlasInternalSession session)
                                 throws AtlasException

Throws:

AtlasException

applySourceFieldActions

protected Field applySourceFieldActions(AtlasInternalSession session)
                                 throws AtlasException

Throws:

AtlasException

getMode

public AtlasModuleMode getMode()

Specified by:

getMode in interface AtlasModule

setMode

public void setMode(AtlasModuleMode atlasModuleMode)

Specified by:

setMode in interface AtlasModule

isStatisticsSupported

public Boolean isStatisticsSupported()

Specified by:

isStatisticsSupported in interface AtlasModule

isStatisticsEnabled

public Boolean isStatisticsEnabled()

Specified by:

isStatisticsEnabled in interface AtlasModule

Specified by:

isStatisticsEnabled in interface AtlasModuleMXBean

listSupportedModes

public List<AtlasModuleMode> listSupportedModes()

Specified by:

listSupportedModes in interface AtlasModule

getConversionService

public AtlasConversionService getConversionService()

Specified by:

getConversionService in interface AtlasModule

getCollectionHelper

public AtlasCollectionHelper getCollectionHelper()

Specified by:

getCollectionHelper in interface AtlasModule

getDocId

public String getDocId()

Specified by:

getDocId in interface AtlasModule

setDocId

public void setDocId(String docId)

Specified by:

setDocId in interface AtlasModule

getUri

public String getUri()

Specified by:

getUri in interface AtlasModule

setUri

public void setUri(String uri)

Specified by:

setUri in interface AtlasModule

getUriDataType

public String getUriDataType()

Specified by:

getUriDataType in interface AtlasModule

getUriParameters

public Map<String,String> getUriParameters()

Specified by:

getUriParameters in interface AtlasModule

setConversionService

public void setConversionService(AtlasConversionService atlasConversionService)

Specified by:

setConversionService in interface AtlasModule

getFieldActionService

public AtlasFieldActionService getFieldActionService()

Specified by:

getFieldActionService in interface AtlasModule

setFieldActionService

public void setFieldActionService(AtlasFieldActionService atlasFieldActionService)

Specified by:

setFieldActionService in interface AtlasModule

createCollectionHelper

protected AtlasCollectionHelper createCollectionHelper(AtlasFieldActionService fieldActionService)

isAutomaticallyProcessOutputFieldActions

public boolean isAutomaticallyProcessOutputFieldActions()

setAutomaticallyProcessOutputFieldActions

public void setAutomaticallyProcessOutputFieldActions(boolean automaticallyProcessOutputFieldActions)

isSupportedField

public Boolean isSupportedField(Field field)

Specified by:

isSupportedField in interface AtlasModule

setDataSourceMetadata

public void setDataSourceMetadata(DataSourceMetadata meta)

Specified by:

setDataSourceMetadata in interface AtlasModule

getDataSourceMetadata

public DataSourceMetadata getDataSourceMetadata()

Specified by:

getDataSourceMetadata in interface AtlasModule

setDocName

public void setDocName(String docName)

Specified by:

setDocName in interface AtlasModule

getDocName

public String getDocName()

Specified by:

getDocName in interface AtlasModule

isSourceSupported

public boolean isSourceSupported()

Specified by:

isSourceSupported in interface AtlasModuleMXBean

isTargetSupported

public boolean isTargetSupported()

Specified by:

isTargetSupported in interface AtlasModuleMXBean

getClassName

public String getClassName()

Specified by:

getClassName in interface AtlasModuleMXBean

getDataFormats

public String[] getDataFormats()

Specified by:

getDataFormats in interface AtlasModuleMXBean

getModeName

public String getModeName()

Specified by:

getModeName in interface AtlasModuleMXBean

getName

public String getName()

Specified by:

getName in interface AtlasModuleMXBean

getPackageNames

public String[] getPackageNames()

Specified by:

getPackageNames in interface AtlasModuleMXBean

getSourceErrorCount

public long getSourceErrorCount()

Specified by:

getSourceErrorCount in interface AtlasModuleMXBean

getSourceCount

public long getSourceCount()

Specified by:

getSourceCount in interface AtlasModuleMXBean

getSourceMaxExecutionTime

public long getSourceMaxExecutionTime()

Specified by:

getSourceMaxExecutionTime in interface AtlasModuleMXBean

getSourceMinExecutionTime

public long getSourceMinExecutionTime()

Specified by:

getSourceMinExecutionTime in interface AtlasModuleMXBean

getSourceSuccessCount

public long getSourceSuccessCount()

Specified by:

getSourceSuccessCount in interface AtlasModuleMXBean

getSourceTotalExecutionTime

public long getSourceTotalExecutionTime()

Specified by:

getSourceTotalExecutionTime in interface AtlasModuleMXBean

getTargetCount

public long getTargetCount()

Specified by:

getTargetCount in interface AtlasModuleMXBean

getTargetErrorCount

public long getTargetErrorCount()

Specified by:

getTargetErrorCount in interface AtlasModuleMXBean

getTargetMaxExecutionTime

public long getTargetMaxExecutionTime()

Specified by:

getTargetMaxExecutionTime in interface AtlasModuleMXBean

getTargetMinExecutionTime

public long getTargetMinExecutionTime()

Specified by:

getTargetMinExecutionTime in interface AtlasModuleMXBean

getTargetSuccessCount

public long getTargetSuccessCount()

Specified by:

getTargetSuccessCount in interface AtlasModuleMXBean

getTargetTotalExecutionTime

public long getTargetTotalExecutionTime()

Specified by:

getTargetTotalExecutionTime in interface AtlasModuleMXBean

getUuid

public String getUuid()

Specified by:

getUuid in interface AtlasModuleMXBean

getVersion

public String getVersion()

Specified by:

getVersion in interface AtlasModuleMXBean

readAndResetStatistics

public TabularData readAndResetStatistics()

Specified by:

readAndResetStatistics in interface AtlasModuleMXBean

setStatisticsEnabled

public void setStatisticsEnabled(boolean enabled)

Specified by:

setStatisticsEnabled in interface AtlasModuleMXBean