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 Details

    • start

      void start(ExporterContext context)
      Start of Export

    • startNamespace

      void startNamespace(String prefix, String uri)
      Start export of namespace
      Parameters:
      prefix - namespace prefix
      uri - namespace uri

    • endNamespace

      void endNamespace(String prefix)
      End export of namespace
      Parameters:
      prefix - namespace prefix

    • startNode

      void startNode(NodeRef nodeRef)
      Start export of node
      Parameters:
      nodeRef - the node reference

    • endNode

      void endNode(NodeRef nodeRef)
      End export of node
      Parameters:
      nodeRef - the node reference

    • startReference

      void startReference(NodeRef nodeRef, QName childName)
      Start export of node reference
      Parameters:
      nodeRef - the node reference

    • endReference

      void endReference(NodeRef nodeRef)
      End export of node reference
      Parameters:
      nodeRef - the node reference

    • startAspects

      void startAspects(NodeRef nodeRef)
      Start export of aspects
      Parameters:
      nodeRef - NodeRef

    • startAspect

      void startAspect(NodeRef nodeRef, QName aspect)
      Start export of aspect
      Parameters:
      nodeRef - the node reference
      aspect - the aspect

    • endAspect

      void endAspect(NodeRef nodeRef, QName aspect)
      End export of aspect
      Parameters:
      nodeRef - the node reference
      aspect - the aspect

    • endAspects

      void endAspects(NodeRef nodeRef)
      End export of aspects
      Parameters:
      nodeRef - NodeRef

    • startACL

      void startACL(NodeRef nodeRef)
      Start export of ACL
      Parameters:
      nodeRef - for node reference

    • permission

      void permission(NodeRef nodeRef, AccessPermission permission)
      Export permission
      Parameters:
      nodeRef - for node reference
      permission - the permission

    • endACL

      void endACL(NodeRef nodeRef)
      End export of ACL
      Parameters:
      nodeRef - for node reference

    • startProperties

      void startProperties(NodeRef nodeRef)
      Start export of properties
      Parameters:
      nodeRef - the node reference

    • startProperty

      void startProperty(NodeRef nodeRef, QName property)
      Start export of property
      Parameters:
      nodeRef - the node reference
      property - the property name

    • endProperty

      void endProperty(NodeRef nodeRef, QName property)
      End export of property
      Parameters:
      nodeRef - the node reference
      property - the property name

    • endProperties

      void endProperties(NodeRef nodeRef)
      End export of properties
      Parameters:
      nodeRef - the node reference

    • startValueCollection

      void startValueCollection(NodeRef nodeRef, QName property)
      Export start of value collection
      Parameters:
      nodeRef - the node reference
      property - the property name

    • startValueMLText

      void startValueMLText(NodeRef nodeRef, Locale locale, boolean isNull)
      Start export MLText
      Parameters:
      nodeRef - the node reference
      locale - Locale
      isNull - boolean

    • endValueMLText

      void endValueMLText(NodeRef nodeRef)
      End export MLText
      Parameters:
      nodeRef - NodeRef

    • value

      void value(NodeRef nodeRef, QName property, 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(NodeRef nodeRef, QName property, InputStream content, 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(NodeRef nodeRef, QName property)
      Export end of value collection
      Parameters:
      nodeRef - the node reference
      property - the property name

    • startAssocs

      void startAssocs(NodeRef nodeRef)
      Start export of associations
      Parameters:
      nodeRef - NodeRef

    • startAssoc

      void startAssoc(NodeRef nodeRef, QName assoc)
      Start export of association
      Parameters:
      nodeRef - the node reference
      assoc - the association name

    • endAssoc

      void endAssoc(NodeRef nodeRef, QName assoc)
      End export of association
      Parameters:
      nodeRef - the node reference
      assoc - the association name

    • endAssocs

      void endAssocs(NodeRef nodeRef)
      End export of associations
      Parameters:
      nodeRef - NodeRef

    • warning

      void warning(String warning)
      Export warning
      Parameters:
      warning - the warning message

    • end

      void end()
      End export