Package io.atlasmap.xml.module

Class XmlModule

  • All Implemented Interfaces:
    io.atlasmap.mxbean.AtlasModuleMXBean, io.atlasmap.spi.AtlasModule
    public class XmlModule
extends io.atlasmap.core.BaseAtlasModule

    • Constructor Summary

      Constructors 
      Constructor Description
      XmlModule()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      io.atlasmap.v2.Field cloneField​(io.atlasmap.v2.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 io.atlasmap.spi.AtlasCollectionHelper createCollectionHelper​(io.atlasmap.spi.AtlasFieldActionService fieldActionService)  
      io.atlasmap.xml.v2.XmlField createField()  
      protected XmlValidationService createValidationService()  
      protected io.atlasmap.xml.core.XmlIOHelper getXmlIOHelper()  
      void init()  
      Boolean isSupportedField​(io.atlasmap.v2.Field field)  
      void populateTargetField​(io.atlasmap.spi.AtlasInternalSession session)  
      void processPostSourceExecution​(io.atlasmap.spi.AtlasInternalSession session)  
      void processPostTargetExecution​(io.atlasmap.spi.AtlasInternalSession session)  
      void processPreSourceExecution​(io.atlasmap.spi.AtlasInternalSession session)  
      void processPreTargetExecution​(io.atlasmap.spi.AtlasInternalSession session)  
      void processPreValidation​(io.atlasmap.spi.AtlasInternalSession atlasSession)  
      void readSourceValue​(io.atlasmap.spi.AtlasInternalSession session)  
      void writeTargetValue​(io.atlasmap.spi.AtlasInternalSession session)  

      • 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

    • Constructor Detail

      • XmlModule

        public XmlModule()

    • Method Detail

      • init

        public void init()
          throws io.atlasmap.api.AtlasException
        Specified by:
        init in interface io.atlasmap.spi.AtlasModule
        Overrides:
        init in class io.atlasmap.core.BaseAtlasModule
        Throws:
        io.atlasmap.api.AtlasException

      • processPreValidation

        public void processPreValidation​(io.atlasmap.spi.AtlasInternalSession atlasSession)
                          throws io.atlasmap.api.AtlasException
        Throws:
        io.atlasmap.api.AtlasException

      • processPreSourceExecution

        public void processPreSourceExecution​(io.atlasmap.spi.AtlasInternalSession session)
                               throws io.atlasmap.api.AtlasException
        Throws:
        io.atlasmap.api.AtlasException

      • convertToXmlDocument

        protected Document convertToXmlDocument​(String source,
                                        boolean namespaced)
                                 throws io.atlasmap.api.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:
        io.atlasmap.api.AtlasException

      • processPreTargetExecution

        public void processPreTargetExecution​(io.atlasmap.spi.AtlasInternalSession session)
                               throws io.atlasmap.api.AtlasException
        Throws:
        io.atlasmap.api.AtlasException

      • readSourceValue

        public void readSourceValue​(io.atlasmap.spi.AtlasInternalSession session)
                     throws io.atlasmap.api.AtlasException
        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
        Overrides:
        populateTargetField in class io.atlasmap.core.BaseAtlasModule
        Throws:
        io.atlasmap.api.AtlasException

      • createCollectionHelper

        protected io.atlasmap.spi.AtlasCollectionHelper createCollectionHelper​(io.atlasmap.spi.AtlasFieldActionService fieldActionService)
        Overrides:
        createCollectionHelper in class io.atlasmap.core.BaseAtlasModule

      • writeTargetValue

        public void writeTargetValue​(io.atlasmap.spi.AtlasInternalSession session)
                      throws io.atlasmap.api.AtlasException
        Throws:
        io.atlasmap.api.AtlasException

      • processPostSourceExecution

        public void processPostSourceExecution​(io.atlasmap.spi.AtlasInternalSession session)
                                throws io.atlasmap.api.AtlasException
        Throws:
        io.atlasmap.api.AtlasException

      • processPostTargetExecution

        public void processPostTargetExecution​(io.atlasmap.spi.AtlasInternalSession session)
                                throws io.atlasmap.api.AtlasException
        Throws:
        io.atlasmap.api.AtlasException

      • convertFromXmlDocument

        protected String convertFromXmlDocument​(Document xml)
                                 throws io.atlasmap.api.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:
        io.atlasmap.api.AtlasException

      • isSupportedField

        public Boolean isSupportedField​(io.atlasmap.v2.Field field)
        Specified by:
        isSupportedField in interface io.atlasmap.spi.AtlasModule
        Overrides:
        isSupportedField in class io.atlasmap.core.BaseAtlasModule

      • cloneField

        public io.atlasmap.v2.Field cloneField​(io.atlasmap.v2.Field field)
                                throws io.atlasmap.api.AtlasException
        Throws:
        io.atlasmap.api.AtlasException

      • createField

        public io.atlasmap.xml.v2.XmlField createField()

      • getXmlIOHelper

        protected io.atlasmap.xml.core.XmlIOHelper getXmlIOHelper()