Profiler Object:Table-Based Statistics

From Melissa Data Wiki
Revision as of 16:36, 15 May 2015 by Admin (talk | contribs) (→‎GetTableEmbeddedRowDelimiterCount)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

← Profiler Object Reference

Profiler Object Interface Navigation
Initialization
Object Information
Enumeration Listing and Parsing
Column Specification
Initiate Profiling
Data Input
Profiling
Table-Based Statistics
Column-Based Statistics
Column-Based String Statistics
Column-Based Numeric Statistics
Column-Based Date/Time Statistics
Column-Based Name Statistics
Column-Based State/Province Statistics
Column-Based Zip/Postal Code Statistics
Column-Based Country Statistics
Column-Based Email Statistics
Column-Based Phone Statistics
Frequency Iterators
Column-Based Value Frequency Table Iteration
Column-Based Value Length Frequency Table Iteration
Column-Based Value Pattern Table Iteration
Column-Based Value Date/Time Table Iteration
Column-Based Value SoundEx Table Iteration
Column-Based Word Table Iteration
Column-Based Word Length Table Iteration
Result Codes
Profiler Object Result Codes
Result Codes


The table-based statistics should only be retrieved after ProfileData is called.

GetTableRecordCount

This function returns the number of records processed.

Syntax profiler->GetTableRecordCount();
C integer = mdProfilerGetTableRecordCount(profiler);
.Net integer = profiler.GetTableRecordCount();


GetTableRecordEmptyCount

This function returns the number of records with empty values for all columns. An empty value is not Null, can contain spaces, and has no string or value.

Syntax profiler->GetTableRecordEmptyCount();
C integer = mdProfilerGetTableRecordEmptyCount(profiler);
.Net integer = profiler.GetTableRecordEmptyCount();


GetTableRecordNullCount

This returns the number of records having Null values for all columns.

Syntax profiler->GetTableRecordNullCount();
C integer = mdProfilerGetTableRecordNullCount(profiler);
.Net integer = profiler.GetTableRecordNullCount();


GetTableExactMatchDistinctCount

This function returns the number of unique records using an Exact Match matching critera. All data fields provided will be compared. Casing and punctuation will be ignored.

Syntax profiler->GetTableExactMatchDistinctCount();
C integer = mdProfilerGetTableExactMatchDistinctCount(profiler);
.Net integer = profiler.GetTableExactMatchDistinctCount();


GetTableExactMatchDupesCount

This function returns the number of duplicate records using an Exact Match matching critera. All data fields provided will be compared. Casing and punctuation will be ignored.

Syntax profiler->GetTableExactMatchDupesCount();
C integer = mdProfilerGetTableExactMatchDupesCount(profiler);
.Net integer = profiler.GetTableExactMatchDupesCount();


GetTableExactMatchLargestGroup

This function returns the size of the largest group of duplicate records using an Exact Match matching critera. All data fields provided will be compared. Casing and punctuation will be ignored.

Syntax profiler->GetTableExactMatchLargestGroup();
C integer = mdProfilerGetTableExactMatchLargestGroup(profiler);
.Net integer = profiler.GetTableExactMatchLargestGroup();


GetTableContactMatchDistinctCount

This function returns the number of distinct records using Address, First Name and Last Name matching criteria.

The Contact Match matching rules used are:

  • Zip5 AND First Name AND Last Name AND Street Number AND Street Name (All have to match)
OR
  • Zip5 AND First Name AND Last Name AND PO Box (All have to match)

Note: The Profiler will parse data present in a single field such as an AddressLine or a FullName for matching purposes. (e.g., From an Address field containing “12 Main Street,” the Profiler will take the “12” as the Street Number and “Main” as the Street Name for its matching needs.)

Syntax profiler->GetTableContactMatchDistinctCount();
C integer = mdProfilerGetTableContactMatchDistinctCount(profiler);
.Net integer = profiler.GetTableContactMatchDistinctCount();


GetTableContactMatchDupesCount

This function returns the number of duplicate records using Contact Match described under GetTableContactMatchDistinctCount.

Syntax profiler->GetTableContactMatchDupesCount();
C integer = mdProfilerGetTableContactMatchDupesCount(profiler);
.Net integer = profiler.GetTableContactMatchDupesCount();


GetTableContactMatchLargestGroup

This function returns the size of the largest group of duplicates using Contact Match described under GetTableContactMatchDistinctCount.

Syntax profiler->GetTableContactMatchLargestGroup();
C integer = mdProfilerGetTableContactMatchLargestGroup(profiler);
.Net integer = profiler.GetTableContactMatchLargestGroup();


GetTableHouseholdMatchDistinctCount

This function returns the number of distinct records using Address, and Last Name matching criteria.

The Household Match matching rules used are:

  • Zip5 AND Last Name AND Street Number AND Street Name (All have to match)
OR
  • Zip5 AND Last Name AND PO Box (All have to match)

Note: The Profiler will parse data present in a single field such as an AddressLine or a FullName for matching purposes. (e.g, From an Address field containing “12 Main Street,” the Profiler will take the “12” as the Street Number and “Main” as the Street Name for its matching needs.)

Syntax profiler->GetTableHouseholdMatchDistinctCount();
C integer = mdProfilerGetTableHouseholdMatchDistinctCount(profiler);
.Net integer = profiler.GetTableHouseholdMatchDistinctCount();


GetTableHouseholdMatchDupesCount

This function returns the number of duplicate records using the Household Match matching strategy described under GetTableHouseholdMatchDistinctCount.

Syntax profiler->GetTableHouseholdMatchDupesCount();
C integer = mdProfilerGetTableHouseholdMatchDupesCount(profiler);
.Net integer = profiler.GetTableHouseholdMatchDupesCount();


GetTableHouseholdMatchLargestGroup

This function returns the size of the largest group of duplicate records using the Household Match matching strategy described under GetTableHouseholdMatchDistinctCount.

Syntax profiler->GetTableHouseholdMatchLargestGroup();
C integer = mdProfilerGetTableHouseholdMatchLargestGroup(profiler);
.Net integer = profiler.GetTableHouseholdMatchLargestGroup();


GetTableAddressMatchDistinctCount

This function returns the number of distinct records using Address only matching criteria.

The Address Match matching rules used are:

  • Zip5 AND Street Number AND Street Name (All have to match)
OR
  • Zip5 AND PO Box (both have to match)

Note: The Profiler will parse data present in a single field such as an AddressLine or a FullName for matching purposes. (e.g., From an Address field containing “12 Main Street,” the Profiler will take the “12” as the Street Number and “Main” as the Street Name for its matching needs.)

Syntax profiler->GetTableAddressMatchDistinctCount();
C integer = mdProfilerGetTableAddressMatchDistinctCount(profiler);
.Net integer = profiler.GetTableAddressMatchDistinctCount();


GetTableAddressMatchDupesCount

This function returns the number of duplicate records using Address Match matching strategy decribed under GetTableHouseholdMatchDistinctCount.

Syntax profiler->GetTableAddressMatchDupesCount();
C integer = mdProfilerGetTableAddressMatchDupesCount(profiler);
.Net integer = profiler.GetTableAddressMatchDupesCount();


GetTableAddressMatchLargestGroup

This function returns the size of the largest group of duplicate records using Address Match matching strategy decribed under GetTableHouseholdMatchDistinctCount.

Syntax profiler->GetTableAddressMatchLargestGroup();
C integer = mdProfilerGetTableAddressMatchLargestGroup(profiler);
.Net integer = profiler.GetTableAddressMatchLargestGroup();


GetTableEmbeddedRowDelimiterCount

This returns the count of the row delimiters that appeared in one of the parsed fields.

This function will return results only if AddDelimitedRecord is used for parsing the input data.

Syntax int = profiler->GetTableEmbeddedRowDelimiterCount();
C int = mdProfilerGetTableEmbeddedRowDelimiterCount(profiler);
.Net integer = profiler.GetTableEmbeddedRowDelimiterCount();


GetTableNotAllFieldsPresentCount

This returns the count of when not all fields were presents. Each field specified by AddColumn() should have a corresponding value after using AddDelimitedRecord(), if not this count will be incremented.

This function will return results only if AddDelimitedRecord() is used for parsing the input data.

Syntax int = profiler->GetTableNotAllFieldsPresentCount();
C int = mdProfilerGetTableNotAllFieldsPresentCount(profiler);
.Net integer = profiler.GetTableNotAllFieldsPresentCount();


GetTableExtraFieldsPresentCount

Each field specified by AddColumn() should have a corresponding value after using AddDelimitedRecord(), if there are any extra fields present this count will be incremented. This function will return results only if AddDelimitedRecord() is used for parsing the input data.

Syntax int = profiler->GetTableExtraFieldsPresentCount();
C int = mdProfilerGetTableExtraFieldsPresentCount(profiler);
.Net integer = profiler.GetTableExtraFieldsPresentCount();


GetTableUnbalancedTextQualifiersCount

The Text Qualifier indicates the character that can (optionally) enclose fields. It is usually used to ‘protect’ in-field delimiters, and is often the double-quote character. Also, if this character appears in the field data itself, it must be properly escaped. If any unbalanced text qualifiers appeared in the data, this count will be incremented. The text qualifier is specified by the SetTextQualifier() function. This function will return results only if AddDelimitedRecord() is used for parsing the input data.

Syntax int = profiler->GetTableUnbalancedTextQualifiersCount();
C int = mdProfilerGetTableUnbalancedTextQualifiersCount(profiler);
.Net integer = profiler.GetTableUnbalancedTextQualifiersCount();


GetTableUnescapedEmbeddedTextQualifiersCount

The Text Qualifier indicates the character that can (optionally) enclose fields. It is usually used to ‘protect’ in-field delimiters, and is often the double-quote character. Also, if this character appears in the field data itself, it must be properly escaped. If any unbalanced text qualifiers were not escaped, this count will be incremented. The text qualifier is specified by the SetTextQualifier() function. This function will return results only if AddDelimitedRecord() is used for parsing the input data.

Syntax int = profiler->GetTableUnescapedEmbeddedTextQualifiersCount();
C int = mdProfilerGetTableUnescapedEmbeddedTextQualifiersCount(profiler);
.Net integer = profiler.GetTableUnescapedEmbeddedTextQualifiersCount();