Package io.atlasmap.spi

Interface AtlasModule

All Known Implementing Classes:

BaseAtlasModule, ConstantModule, CsvModule, DfdlModule, JavaModule, JsonModule, PropertyModule, XmlModule

public interface AtlasModule

A SPI contract between AtlasMap core and modules. AtlasMap core engine invokes those methods while processing mappings.

Method Summary

Modifier and Type	Method	Description
Field	cloneField(Field field)
Field	createField()
void	destroy()
ClassLoader	getClassLoader()
AtlasCollectionHelper	getCollectionHelper()
AtlasConversionService	getConversionService()
DataSourceMetadata	getDataSourceMetadata()
String	getDocId()
String	getDocName()
AtlasFieldActionService	getFieldActionService()
AtlasModuleMode	getMode()
String	getUri()
String	getUriDataType()
Map<String,String>	getUriParameters()
void	init()
Boolean	isStatisticsEnabled()
Boolean	isStatisticsSupported()
Boolean	isSupportedField(Field field)
List<AtlasModuleMode>	listSupportedModes()
void	populateTargetField(AtlasInternalSession session)	Populate target field value, usually by just copy from source field value.
void	processPostSourceExecution(AtlasInternalSession session)
void	processPostTargetExecution(AtlasInternalSession session)
void	processPostValidation(AtlasInternalSession session)
void	processPreSourceExecution(AtlasInternalSession session)
void	processPreTargetExecution(AtlasInternalSession session)
void	processPreValidation(AtlasInternalSession session)
void	readSourceValue(AtlasInternalSession session)	Read source field value from source document and store into source field object.
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	setUri(String uri)
void	writeTargetValue(AtlasInternalSession session)	Write target field value into target document.

Method Details

init

void init()
   throws AtlasException

Throws:

AtlasException

destroy

void destroy()
      throws AtlasException

Throws:

AtlasException

setClassLoader

void setClassLoader(ClassLoader classLoader)

getClassLoader

ClassLoader getClassLoader()

processPreValidation

void processPreValidation(AtlasInternalSession session)
                   throws AtlasException

Throws:

AtlasException

processPreSourceExecution

void processPreSourceExecution(AtlasInternalSession session)
                        throws AtlasException

Throws:

AtlasException

processPreTargetExecution

void processPreTargetExecution(AtlasInternalSession session)
                        throws AtlasException

Throws:

AtlasException

readSourceValue

void readSourceValue(AtlasInternalSession session)
              throws AtlasException

Read source field value from source document and store into source field object.

Parameters:

session - current session

Throws:

AtlasException - failed to read source value

populateTargetField

void populateTargetField(AtlasInternalSession session)
                  throws AtlasException

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

Parameters:

session - current session

Throws:

AtlasException - failed to populate target field value

writeTargetValue

void writeTargetValue(AtlasInternalSession session)
               throws AtlasException

Write target field value into target document.

Parameters:

session - current session

Throws:

AtlasException - faield to write target field value

processPostSourceExecution

void processPostSourceExecution(AtlasInternalSession session)
                         throws AtlasException

Throws:

AtlasException

processPostTargetExecution

void processPostTargetExecution(AtlasInternalSession session)
                         throws AtlasException

Throws:

AtlasException

processPostValidation

void processPostValidation(AtlasInternalSession session)
                    throws AtlasException

Throws:

AtlasException

getMode

AtlasModuleMode getMode()

setMode

void setMode(AtlasModuleMode atlasModuleMode)

getConversionService

AtlasConversionService getConversionService()

setConversionService

void setConversionService(AtlasConversionService atlasConversionService)

getFieldActionService

AtlasFieldActionService getFieldActionService()

setFieldActionService

void setFieldActionService(AtlasFieldActionService atlasFieldActionService)

getCollectionHelper

AtlasCollectionHelper getCollectionHelper()

listSupportedModes

List<AtlasModuleMode> listSupportedModes()

getDocId

String getDocId()

setDocId

void setDocId(String docId)

getDocName

String getDocName()

setDocName

void setDocName(String docName)

getUri

String getUri()

setUri

void setUri(String uri)

getUriDataType

String getUriDataType()

getUriParameters

Map<String,String> getUriParameters()

isStatisticsSupported

Boolean isStatisticsSupported()

isStatisticsEnabled

Boolean isStatisticsEnabled()

isSupportedField

Boolean isSupportedField(Field field)

cloneField

Field cloneField(Field field)
          throws AtlasException

Throws:

AtlasException

setDataSourceMetadata

void setDataSourceMetadata(DataSourceMetadata meta)

getDataSourceMetadata

DataSourceMetadata getDataSourceMetadata()

createField

Field createField()