Package org.alfresco.service.cmr.view

Interface Exporter

  • All Known Implementing Classes:
    AbstractExporter, ZipDownloadExporter
    public interface Exporter
    Contract for an exporter. An exporter is responsible for actually exporting the content of the Repository to a destination point e.g. file system.
    Author:
    David Caruana

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void content​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName property, java.io.InputStream content, org.alfresco.service.cmr.repository.ContentData contentData, int index)
      Export content stream property value
      void end()
      End export
      void endACL​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      End export of ACL
      void endAspect​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName aspect)
      End export of aspect
      void endAspects​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      End export of aspects
      void endAssoc​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName assoc)
      End export of association
      void endAssocs​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      End export of associations
      void endNamespace​(java.lang.String prefix)
      End export of namespace
      void endNode​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      End export of node
      void endProperties​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      End export of properties
      void endProperty​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName property)
      End export of property
      void endReference​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      End export of node reference
      void endValueCollection​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName property)
      Export end of value collection
      void endValueMLText​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      End export MLText
      void permission​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.cmr.security.AccessPermission permission)
      Export permission
      void start​(ExporterContext context)
      Start of Export
      void startACL​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Start export of ACL
      void startAspect​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName aspect)
      Start export of aspect
      void startAspects​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Start export of aspects
      void startAssoc​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName assoc)
      Start export of association
      void startAssocs​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Start export of associations
      void startNamespace​(java.lang.String prefix, java.lang.String uri)
      Start export of namespace
      void startNode​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Start export of node
      void startProperties​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Start export of properties
      void startProperty​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName property)
      Start export of property
      void startReference​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName childName)
      Start export of node reference
      void startValueCollection​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName property)
      Export start of value collection
      void startValueMLText​(org.alfresco.service.cmr.repository.NodeRef nodeRef, java.util.Locale locale, boolean isNull)
      Start export MLText
      void value​(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName property, java.lang.Object value, int index)
      Export property value
      void warning​(java.lang.String warning)
      Export warning

    • Method Detail

      • startNamespace

        void startNamespace​(java.lang.String prefix,
                    java.lang.String uri)
        Start export of namespace
        Parameters:
        prefix - namespace prefix
        uri - namespace uri

      • endNamespace

        void endNamespace​(java.lang.String prefix)
        End export of namespace
        Parameters:
        prefix - namespace prefix

      • startNode

        void startNode​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Start export of node
        Parameters:
        nodeRef - the node reference

      • endNode

        void endNode​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        End export of node
        Parameters:
        nodeRef - the node reference

      • startReference

        void startReference​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                    org.alfresco.service.namespace.QName childName)
        Start export of node reference
        Parameters:
        nodeRef - the node reference

      • endReference

        void endReference​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        End export of node reference
        Parameters:
        nodeRef - the node reference

      • startAspects

        void startAspects​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Start export of aspects
        Parameters:
        nodeRef - NodeRef

      • startAspect

        void startAspect​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                 org.alfresco.service.namespace.QName aspect)
        Start export of aspect
        Parameters:
        nodeRef - the node reference
        aspect - the aspect

      • endAspect

        void endAspect​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
               org.alfresco.service.namespace.QName aspect)
        End export of aspect
        Parameters:
        nodeRef - the node reference
        aspect - the aspect

      • endAspects

        void endAspects​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        End export of aspects
        Parameters:
        nodeRef - NodeRef

      • startACL

        void startACL​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Start export of ACL
        Parameters:
        nodeRef - for node reference

      • permission

        void permission​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                org.alfresco.service.cmr.security.AccessPermission permission)
        Export permission
        Parameters:
        nodeRef - for node reference
        permission - the permission

      • endACL

        void endACL​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        End export of ACL
        Parameters:
        nodeRef - for node reference

      • startProperties

        void startProperties​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Start export of properties
        Parameters:
        nodeRef - the node reference

      • startProperty

        void startProperty​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                   org.alfresco.service.namespace.QName property)
        Start export of property
        Parameters:
        nodeRef - the node reference
        property - the property name

      • endProperty

        void endProperty​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                 org.alfresco.service.namespace.QName property)
        End export of property
        Parameters:
        nodeRef - the node reference
        property - the property name

      • endProperties

        void endProperties​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        End export of properties
        Parameters:
        nodeRef - the node reference

      • startValueCollection

        void startValueCollection​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                          org.alfresco.service.namespace.QName property)
        Export start of value collection
        Parameters:
        nodeRef - the node reference
        property - the property name

      • startValueMLText

        void startValueMLText​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                      java.util.Locale locale,
                      boolean isNull)
        Start export MLText
        Parameters:
        nodeRef - the node reference
        locale - Locale
        isNull - boolean

      • endValueMLText

        void endValueMLText​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        End export MLText
        Parameters:
        nodeRef - NodeRef

      • value

        void value​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
           org.alfresco.service.namespace.QName property,
           java.lang.Object value,
           int index)
        Export property value
        Parameters:
        nodeRef - the node reference
        property - the property name
        value - the value
        index - value index (or -1, if not part of multi-valued collection)

      • content

        void content​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
             org.alfresco.service.namespace.QName property,
             java.io.InputStream content,
             org.alfresco.service.cmr.repository.ContentData contentData,
             int index)
        Export content stream property value
        Parameters:
        nodeRef - the node reference
        property - the property name
        content - the content stream
        contentData - content descriptor
        index - value index (or -1, if not part of multi-valued collection)

      • endValueCollection

        void endValueCollection​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                        org.alfresco.service.namespace.QName property)
        Export end of value collection
        Parameters:
        nodeRef - the node reference
        property - the property name

      • startAssocs

        void startAssocs​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        Start export of associations
        Parameters:
        nodeRef - NodeRef

      • startAssoc

        void startAssoc​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
                org.alfresco.service.namespace.QName assoc)
        Start export of association
        Parameters:
        nodeRef - the node reference
        assoc - the association name

      • endAssoc

        void endAssoc​(org.alfresco.service.cmr.repository.NodeRef nodeRef,
              org.alfresco.service.namespace.QName assoc)
        End export of association
        Parameters:
        nodeRef - the node reference
        assoc - the association name

      • endAssocs

        void endAssocs​(org.alfresco.service.cmr.repository.NodeRef nodeRef)
        End export of associations
        Parameters:
        nodeRef - NodeRef

      • warning

        void warning​(java.lang.String warning)
        Export warning
        Parameters:
        warning - the warning message

      • end

        void end()
        End export