Package org.nuxeo.ecm.platform.filemanager.service.extension

Class FileImporterDescriptor

java.lang.Object
org.nuxeo.ecm.platform.filemanager.service.extension.FileImporterDescriptor
All Implemented Interfaces:
Descriptor
public class FileImporterDescriptor extends Object implements Descriptor
Author:
akalogeropoulos

  • Field Details

  • Constructor Details

    • FileImporterDescriptor

      public FileImporterDescriptor()

  • Method Details

    • getName

      public String getName()

    • setName

      public void setName(String name)

    • getClassName

      @Deprecated(since="11.1") public String getClassName()
      Deprecated.
      since 11.1. Use klass.

    • setClassName

      @Deprecated(since="11.1") public void setClassName(String className)
      Deprecated.
      since 11.1. Use klass.

    • getDocType

      public String getDocType()
      Returns the configured document type to be created when using the importer
      Since:
      5.5

    • getFilter

      public String getFilter()

    • setFilter

      public void setFilter(String filter)

    • getFilters

      public List<String> getFilters()

    • setFilters

      public void setFilters(List<String> filters)

    • isEnabled

      public boolean isEnabled()

    • getOrder

      public Integer getOrder()

    • isMerge

      public boolean isMerge()
      Returns true if this FileImporterDescriptor should be merged with an existing one, false otherwise.
      Since:
      5.5

    • newInstance

      public FileImporter newInstance()
      Since:
      11.1

    • getId

      public String getId()
      Description copied from interface: Descriptor
      The descriptor id, descriptors with same id are merged.

      To forbid multiple descriptors use UNIQUE_DESCRIPTOR_ID.

      To forbid merge use a unique value, non-overriden toString() for exemple.

      Specified by:
      getId in interface Descriptor

    • merge

      public Descriptor merge(Descriptor o)
      Description copied from interface: Descriptor
      Returns a descriptor representing other merged into this

      Default implementation returns other.

      Specified by:
      merge in interface Descriptor
      Returns:
      the merged descriptor

    • defaultValue

      protected <T> T defaultValue(T value, T defaultValue)

    • doesRemove

      public boolean doesRemove()
      Description copied from interface: Descriptor
      During merge if a descriptor whose doesRemove() returns true is encountered, the merge chain is reset and started again on next descriptor.

      If the last descriptor of same id doesRemove() return true, the descriptor for this id will be null.

      Specified by:
      doesRemove in interface Descriptor