Package org.apache.tika.pipes.core.extractor

Class UnpackConfig

java.lang.Object
org.apache.tika.pipes.core.extractor.UnpackConfig
All Implemented Interfaces:
Serializable
public class UnpackConfig extends Object implements Serializable
See Also:

  • Field Details

    • DEFAULT_MAX_UNPACK_BYTES

      public static final long DEFAULT_MAX_UNPACK_BYTES
      Default maximum bytes to unpack per file: 10 GB. Use -1 to disable the limit (not recommended).
      See Also:

  • Constructor Details

    • UnpackConfig

      public UnpackConfig()
      Create an UnpackConfig with default settings.

  • Method Details

    • getZeroPadName

      public int getZeroPadName()

    • getSuffixStrategy

      public UnpackConfig.SUFFIX_STRATEGY getSuffixStrategy()

    • getKeyBaseStrategy

      public UnpackConfig.KEY_BASE_STRATEGY getKeyBaseStrategy()

    • getEmbeddedIdPrefix

      public String getEmbeddedIdPrefix()

    • getEmitter

      public String getEmitter()

    • isIncludeOriginal

      public boolean isIncludeOriginal()

    • setZeroPadName

      public void setZeroPadName(int zeroPadName)

    • setSuffixStrategy

      public void setSuffixStrategy(UnpackConfig.SUFFIX_STRATEGY suffixStrategy)

    • setSuffixStrategy

      public void setSuffixStrategy(String suffixStrategy)

    • setKeyBaseStrategy

      public void setKeyBaseStrategy(UnpackConfig.KEY_BASE_STRATEGY keyBaseStrategy)

    • setKeyBaseStrategy

      public void setKeyBaseStrategy(String keyBaseStrategy)

    • setEmbeddedIdPrefix

      public void setEmbeddedIdPrefix(String embeddedIdPrefix)

    • setEmitter

      public void setEmitter(String emitter)

    • setIncludeOriginal

      public void setIncludeOriginal(boolean includeOriginal)

    • setEmitKeyBase

      public void setEmitKeyBase(String emitKeyBase)

    • getEmitKeyBase

      public String getEmitKeyBase()

    • isZipEmbeddedFiles

      public boolean isZipEmbeddedFiles()
      Whether to zip all embedded files into a single archive before emitting. When true, embedded files are collected during parsing and then zipped and emitted as a single archive after parsing completes.

    • setZipEmbeddedFiles

      public void setZipEmbeddedFiles(boolean zipEmbeddedFiles)

    • isIncludeMetadataInZip

      public boolean isIncludeMetadataInZip()
      Whether to include the metadata JSON for each embedded document in the zip file. Only applicable when isZipEmbeddedFiles() is true.

    • setIncludeMetadataInZip

      public void setIncludeMetadataInZip(boolean includeMetadataInZip)

    • getMaxUnpackBytes

      public long getMaxUnpackBytes()
      Maximum total bytes to unpack per file. Default is 10GB. Set to -1 to disable the limit (not recommended).
      Returns:
      max bytes to unpack, or -1 if no limit

    • setMaxUnpackBytes

      public void setMaxUnpackBytes(long maxUnpackBytes)

    • getOutputFormat

      public UnpackConfig.OUTPUT_FORMAT getOutputFormat()
      Get the output format for UNPACK mode. REGULAR is the default (existing behavior). FRICTIONLESS creates a Frictionless Data Package with datapackage.json manifest.

    • setOutputFormat

      public void setOutputFormat(UnpackConfig.OUTPUT_FORMAT outputFormat)

    • setOutputFormat

      public void setOutputFormat(String outputFormat)

    • getOutputMode

      public UnpackConfig.OUTPUT_MODE getOutputMode()
      Get the output mode for how embedded files are delivered. ZIPPED packages all files into a single zip archive. DIRECTORY emits files directly to the configured emitter.

    • setOutputMode

      public void setOutputMode(UnpackConfig.OUTPUT_MODE outputMode)

    • setOutputMode

      public void setOutputMode(String outputMode)

    • isIncludeFullMetadata

      public boolean isIncludeFullMetadata()
      Whether to include full RMETA-style metadata in metadata.json. Only applicable when outputFormat is FRICTIONLESS.

    • setIncludeFullMetadata

      public void setIncludeFullMetadata(boolean includeFullMetadata)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object