Package io.atlasmap.xml.module

Class XmlModule

java.lang.Object

io.atlasmap.core.BaseAtlasModule

io.atlasmap.xml.module.XmlModule

All Implemented Interfaces:

AtlasModuleMXBean, AtlasModule

Direct Known Subclasses:

DfdlModule

public class XmlModule
extends BaseAtlasModule

Constructor Summary

Constructors

Constructor	Description
XmlModule()

Method Summary

Modifier and Type	Method	Description
Field	cloneField(Field field)
protected String	convertFromXmlDocument(Document xml)	Convert a target XML document into some format.
protected Document	convertToXmlDocument(String source, boolean namespaced)	Convert a source document into XML.
protected AtlasCollectionHelper	createCollectionHelper(AtlasFieldActionService fieldActionService)
XmlField	createField()
protected XmlValidationService	createValidationService()
protected XmlIOHelper	getXmlIOHelper()
void	init()
Boolean	isSupportedField(Field field)
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	processPreSourceExecution(AtlasInternalSession session)
void	processPreTargetExecution(AtlasInternalSession session)
void	processPreValidation(AtlasInternalSession atlasSession)
void	readSourceValue(AtlasInternalSession session)	Read source field value from source document and store into source field object.
void	writeTargetValue(AtlasInternalSession session)	Write target field value into target document.

Methods inherited from class io.atlasmap.core.BaseAtlasModule

applySourceFieldActions, applyTargetFieldActions, destroy, getClassLoader, getClassName, getCollectionHelper, getConversionService, getDataFormats, getDataSourceMetadata, getDocId, getDocName, getFieldActionService, getMode, getModeName, getName, getPackageNames, getSourceCount, getSourceErrorCount, getSourceMaxExecutionTime, getSourceMinExecutionTime, getSourceSuccessCount, getSourceTotalExecutionTime, getTargetCount, getTargetErrorCount, getTargetMaxExecutionTime, getTargetMinExecutionTime, getTargetSuccessCount, getTargetTotalExecutionTime, getUri, getUriDataType, getUriParameters, getUuid, getVersion, isAutomaticallyProcessOutputFieldActions, isSourceSupported, isStatisticsEnabled, isStatisticsSupported, isTargetSupported, listSupportedModes, processLookupField, processPostValidation, readAndResetStatistics, setAutomaticallyProcessOutputFieldActions, setClassLoader, setConversionService, setDataSourceMetadata, setDocId, setDocName, setFieldActionService, setMode, setStatisticsEnabled, setUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

XmlModule

public XmlModule()

Method Details

init

public void init()
          throws AtlasException

Specified by:

init in interface AtlasModule

Overrides:

init in class BaseAtlasModule

Throws:

AtlasException

processPreValidation

public void processPreValidation(AtlasInternalSession atlasSession)
                          throws AtlasException

Throws:

AtlasException

createValidationService

protected XmlValidationService createValidationService()

processPreSourceExecution

public void processPreSourceExecution(AtlasInternalSession session)
                               throws AtlasException

Throws:

AtlasException

convertToXmlDocument

protected Document convertToXmlDocument(String source,
 boolean namespaced)
                                 throws AtlasException

Convert a source document into XML. The modules extending this class can override this to convert some format into XML so that XML field reader can read it.

Parameters:

source - some document which can be converted to XML

Returns:

converted

Throws:

AtlasException

processPreTargetExecution

public void processPreTargetExecution(AtlasInternalSession session)
                               throws AtlasException

Throws:

AtlasException

readSourceValue

public void readSourceValue(AtlasInternalSession session)
                     throws AtlasException

Description copied from interface: AtlasModule

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

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

Overrides:

populateTargetField in class BaseAtlasModule

Parameters:

session - current session

Throws:

AtlasException - failed to populate target field value

createCollectionHelper

protected AtlasCollectionHelper createCollectionHelper(AtlasFieldActionService fieldActionService)

Overrides:

createCollectionHelper in class BaseAtlasModule

writeTargetValue

public void writeTargetValue(AtlasInternalSession session)
                      throws AtlasException

Description copied from interface: AtlasModule

Write target field value into target document.

Parameters:

session - current session

Throws:

AtlasException - faield to write target field value

processPostSourceExecution

public void processPostSourceExecution(AtlasInternalSession session)
                                throws AtlasException

Throws:

AtlasException

processPostTargetExecution

public void processPostTargetExecution(AtlasInternalSession session)
                                throws AtlasException

Throws:

AtlasException

convertFromXmlDocument

protected String convertFromXmlDocument(Document xml)
                                 throws AtlasException

Convert a target XML document into some format. The modules extending this class can override this to convert interim XML document written by XML field writer into final format.

Parameters:

xml - XML document written by XML field writer

Returns:

converted

Throws:

AtlasException

isSupportedField

public Boolean isSupportedField(Field field)

Specified by:

isSupportedField in interface AtlasModule

Overrides:

isSupportedField in class BaseAtlasModule

cloneField

public Field cloneField(Field field)
                 throws AtlasException

Throws:

AtlasException

createField

public XmlField createField()

getXmlIOHelper

protected XmlIOHelper getXmlIOHelper()