FsMetadataChecksummer

Generates a metadata checksum for file system documents based on file attributes.

crawler/fsJavadoc: FsMetadataChecksummer

Notes

Generates a metadata checksum for file system documents using file system attributes such as last-modified date and file size. Optionally stores the generated checksum in a specified metadata field.

Examples

The following will store the generated metadata checksum in a field called "checksum".

YAML

class: FsMetadataChecksummer
keep: true
toField: checksum

JSON

{
  "class": "FsMetadataChecksummer",
  "keep": true,
  "toField": "checksum"
}

XML

<class>FsMetadataChecksummer</class>
<keep>true</keep>
<toField>checksum</toField>

Usage

Full configuration skeleton, with every option and its default

YAML

class: FsMetadataChecksummer
keep: false
onSet: APPEND
toField: string

JSON

{
  "class": "FsMetadataChecksummer",
  "keep": false,
  "onSet": "APPEND",
  "toField": "string"
}

XML

<metadataChecksummer>
  <class>FsMetadataChecksummer</class>
  <keep>false</keep>
  <onSet>APPEND</onSet>
  <toField>string</toField>
</metadataChecksummer>

Properties

Property	Type	Required	Default
keep	boolean	No	false
onSet	enum	No	-
toField	string	No	-

Property Details

keep

When enabled, the generated checksum value is also stored as a metadata field on the document.

onSet

Defines what to do when the target field already has one or more values. When unspecified, new values are appended to existing ones by default.

Allowed Values

• APPEND
• PREPEND
• REPLACE
• OPTIONAL

toField

The target metadata field name where the extracted or computed value will be stored. If a field of the same name already exists, the behavior is controlled by onSet.