DocImageHandler

Defines how document images are saved and referenced during crawling.

crawler/webJavadoc: DocImageHandler

Notes

Controls how document images are handled during crawling, including the output format, target directory, directory structure, and where image references are stored in document metadata.

Usage

YAML

imageFormat: string
targetDir: string
targetDirField: string
targetDirStructure: URL2PATH
targetMetaField: string
targets:
  - METADATA

JSON

{
  "imageFormat": "string",
  "targetDir": "string",
  "targetDirField": "string",
  "targetDirStructure": "URL2PATH",
  "targetMetaField": "string",
  "targets": [
    "METADATA"
  ]
}

XML

<docImageHandler>
  <imageFormat>string</imageFormat>
  <targetDir>string</targetDir>
  <targetDirField>string</targetDirField>
  <targetDirStructure>URL2PATH</targetDirStructure>
  <targetMetaField>string</targetMetaField>
  <targets>
    <target>METADATA</target>
  </targets>
</docImageHandler>

Properties

Property	Type	Required	Default
imageFormat	string	No	png
targetDir	string	No	-
targetDirField	string	No	-
targetDirStructure	enum	No	DATETIME
targetMetaField	string	No	-
targets	enum[]	No	[DIRECTORY]

Property Details

imageFormat

The image format used when saving images to disk (e.g., png, jpeg, gif). Defaults to png.

targetDir

Directory path where captured images are saved when DIRECTORY is one of the configured targets.

targetDirField

Name of the metadata field where the path to the saved image file is stored. Only populated when DIRECTORY is one of the configured targets.

targetDirStructure

Directory structure used when saving images to disk. One of:

• URL2PATH — Creates subdirectories derived from the document URL segments.
• DATE — Creates subdirectories organized by date (e.g., 2000/12/31/).
• DATETIME — Creates subdirectories organized by date and time down to seconds (e.g., 2000/12/31/13/34/12/). This is the default.

Allowed Values

• URL2PATH
• DATE
• DATETIME

targetMetaField

Name of the metadata field where the image itself is stored as a Base64-encoded string. Only populated when METADATA is one of the configured targets.

targets

One or more storage destinations for captured images. Supported values:

• DIRECTORY — Saves the image to a local directory (default).
• METADATA — Stores the image as a Base64-encoded value in a metadata field.