Skip to content

parsed-result-item.md

Latest commit

 

History

History
148 lines (89 loc) · 3.67 KB

parsed-result-item.md

File metadata and controls

148 lines (89 loc) · 3.67 KB
layout default-layout
title ParsedResultItem Class - Dynamsoft Code Parser Module Python Edition API Reference
description Definition of the ParsedResultItem class in Dynamsoft Code Parser Module Python Edition.
keywords ParsedResultItem, api reference, python
needAutoGenerateSidebar true

ParsedResultItem Class

The ParsedResultItem class represents a parsed result item generated by code parser engine.

Definition

Module: dcp

Inheritance: [CapturedResultItem]({{ site.dcvb_python_api }}core/basic-classes/captured-result-item.html) -> ParsedResultItem

class ParsedResultItem(dynamsoft_core.CapturedResultItem)

Methods

Method Description
get_code_type Gets the code type of the parsed result.
get_field_value Gets the value of a specified field from the parsed result.
get_field_mapping_status Gets the mapping status of a specified field from the parsed result.
get_field_validation_status Gets the validation status of a specified field from the parsed result.
get_json_string Gets the parsed result as a JSON formatted string.
get_field_raw_value Gets the raw string of a specified field from the parsed result.
get_all_field_names Gets the names of all parsed fields.

get_code_type

Gets the code type of the parsed result.

def get_code_type(self) -> str:

Return Value

Returns a string value representing the code type.

get_field_value

Gets the value of a specified field from the parsed result.

def get_field_value(self, field_name: str) -> str:

Parameters

field_name The name of the field.

Return Value

Returns a string representing the specified field value.

get_field_mapping_status

Gets the mapping status of a specified field from the parsed result.

def get_field_mapping_status(self, field_name: str) -> int:

Parameters

field_name The name of the field.

Return Value

Returns an EnumMappingStatus value representing the mapping status of a specified field.

See Also

[EnumMappingStatus]({{ site.dcp_python_api }}enum-mapping-status.html)

get_field_validation_status

Gets the validation status of a specified field from the parsed result.

def get_field_validation_status(self, field_name: str) -> int:

Parameters

field_name The name of the field.

Return Value

Returns an EnumValidationStatus value representing the validation status of a specified field.

See Also

[EnumValidationStatus]({{ site.dcp_python_api }}enum-validation-status.html)

get_json_string

Gets the parsed result as a JSON formatted string.

def get_json_string(self) -> str:

Return Value

Returns a JSON formatted string representing the full parsed result.

get_field_raw_value

Gets the raw string of a specified field from the parsed result.

def get_field_raw_value(self, field_name: str) -> str:

Parameters

field_name The name of the field.

Return Value

Returns a string representing the specified field raw string.

Return Value

Returns an integer representing the count of parsed fields.

get_all_field_names

Gets the names of all parsed fields.

def get_all_field_names(self)->List[str]:

Return Value

Returns a list of all field names.

If the field is nested, the name includes all parent fields, separated by a dot (.). The format follows this pattern: <root_field>[.<child_field1>[.<child_field2>...]]