Package org.alfresco.repo.importer

Interface Importer

  • public interface Importer
    The Importer interface encapusulates the strategy for importing a node into the Repository.
    Author:
    David Caruana

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void childrenImported​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Signal completion of node import
      void end()
      Signal end of import
      void error​(java.lang.Throwable e)
      Signal import error
      Location getLocation()  
      org.alfresco.service.namespace.QName getRootAssocType()  
      org.alfresco.service.cmr.repository.NodeRef getRootRef()  
      void importMetaData​(java.util.Map<org.alfresco.service.namespace.QName,​java.lang.String> properties)
      Import meta-data
      org.alfresco.service.cmr.repository.NodeRef importNode​(ImportNode node)
      Import a node
      boolean isExcludedClass​(org.alfresco.service.namespace.QName className)
      Is excluded Content Model Class?
      org.alfresco.service.cmr.repository.NodeRef resolvePath​(java.lang.String path)
      Resolve path within context of root reference
      void start()
      Signal start of import

    • Method Detail

      • getRootRef

        org.alfresco.service.cmr.repository.NodeRef getRootRef()
        Returns:
        the root node to import into

      • getRootAssocType

        org.alfresco.service.namespace.QName getRootAssocType()
        Returns:
        the root child association type to import under

      • getLocation

        Location getLocation()
        Returns:
        the location to import under

      • start

        void start()
        Signal start of import

      • end

        void end()
        Signal end of import

      • error

        void error​(java.lang.Throwable e)
        Signal import error

      • importMetaData

        void importMetaData​(java.util.Map<org.alfresco.service.namespace.QName,​java.lang.String> properties)
        Import meta-data

      • importNode

        org.alfresco.service.cmr.repository.NodeRef importNode​(ImportNode node)
        Import a node
        Parameters:
        node - the node description
        Returns:
        the node ref of the imported node

      • resolvePath

        org.alfresco.service.cmr.repository.NodeRef resolvePath​(java.lang.String path)
        Resolve path within context of root reference
        Parameters:
        path - the path to resolve
        Returns:
        node reference

      • isExcludedClass

        boolean isExcludedClass​(org.alfresco.service.namespace.QName className)
        Is excluded Content Model Class?
        Parameters:
        className - the class name to test
        Returns:
        true => the provided class is excluded from import

      • childrenImported

        void childrenImported​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Signal completion of node import
        Parameters:
        nodeRef - the node ref of the imported node