Label Field Definition
Defined in package com.scandit.datacapture.label.capture
- LabelFieldDefinition
interface LabelFieldDefinitionAdded in version 6.21.0
- name
@NonNull String getName()
Added in version 6.21.0
The unique identifier for this field within the label definition. This name is used to reference the field when processing captured results and must be unique within the label definition.
- patterns
@NonNull List<@NonNull String> getPatterns()
Added in version 6.21.0
Regular expression patterns used to validate captured content. These patterns allow you to ensure that the captured data matches the expected format for your specific field type.
For example, you can use patterns like [“\d{2}/\d{2}/\d{4}”] for date formats, or [“[A-Z]{2}\d{6}”] for codes that must start with two letters followed by six digits.
- isOptional
booleanisOptional()Added in version 6.21.0
Determines whether this field is required for the label to be considered complete. When set to true, the label can be marked as complete even if this field is not found. When false (mandatory), the label will only be complete when this field is successfully captured.
Optional fields are useful for scenarios where certain information might not always be present on labels, such as promotional codes or secondary identifiers.
- numberOfMandatoryInstances
@Nullable Integer getNumberOfMandatoryInstances()
Added in version 7.6.0
The minimum number of instances of this field that must be captured for the label to be considered complete. This is useful for fields that may appear multiple times on a label, such as multiple serial numbers or repeated information.