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

    • copy

      public UnpackConfig copy()
      The worker mutates its instance; hand out copies.

    • 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)

    • getIncludeMetadata

      public Boolean getIncludeMetadata()
      Null when the format decides; see writesMetadata().

    • setIncludeMetadata

      public void setIncludeMetadata(Boolean includeMetadata)

    • writesMetadata

      public boolean writesMetadata()
      Metadata for every extracted file: metadata.json under FRICTIONLESS, a sidecar per file under REGULAR zip output, nothing under REGULAR loose output. Unset means on for FRICTIONLESS, off for REGULAR. Not a bean getter: the class is introspected.

    • isIncludeMetadataInZip

      @Deprecated public boolean isIncludeMetadataInZip()
      Deprecated.
      since 4.1, removal planned for 5.0; see writesMetadata()

    • setIncludeMetadataInZip

      @Deprecated public void setIncludeMetadataInZip(boolean includeMetadataInZip)
      Deprecated.
      since 4.1, removal planned for 5.0; use setIncludeMetadata(Boolean)

    • getMaxUnpackBytes

      public long getMaxUnpackBytes()
      Maximum total bytes to unpack per file. Default is 10GB. Set to -1 to disable the limit (not recommended). 0 is not "unlimited" -- it means zero bytes, so the very first embedded file's extraction is immediately capped.
      Returns:
      max bytes to unpack, or -1 if no limit

    • setMaxUnpackBytes

      public void setMaxUnpackBytes(long maxUnpackBytes)

    • maxUnpackBytesOrUnlimited

      public long maxUnpackBytesOrUnlimited()
      Maximum total bytes to unpack per file, with -1 (no limit) normalized to Long.MAX_VALUE so callers can bound reads without a special case.

      Deliberately not named getMaxUnpackBytesOrUnlimited -- this class is JSON (de)serialized via bean introspection, and a "get"-prefixed method here would be picked up as a phantom property with no matching setter.

      Returns:
      max bytes to unpack, or Long.MAX_VALUE if unlimited

    • 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

      @Deprecated public boolean isIncludeFullMetadata()
      Deprecated.
      since 4.1, removal planned for 5.0; see writesMetadata()

    • setIncludeFullMetadata

      @Deprecated public void setIncludeFullMetadata(boolean includeFullMetadata)
      Deprecated.
      since 4.1, removal planned for 5.0; use setIncludeMetadata(Boolean)

    • 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