Profiler Object:Column-Based Value Pattern Table Iteration

From Melissa Data Wiki
Revision as of 18:54, 2 February 2015 by Admin (talk | contribs)
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
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
Returned Result Codes
Result Codes


These functions allow you to step through each distinct value pattern for a specific column.

StartPatternFrequency

This function initiates the iterator.

This function takes two parameters.

Parameters

Name Data Type Description
ColumnName String Column Name to start the iterator.
Order Order This specifies how to order. See Order Enumeration for details.


Syntax profiler->StartPatternFrequency(columnNameStr, Order);
C mdProfilerStartPatternFrequency(profiler,columnNameStr, Order);
.Net profiler.StartPatternFrequency(columnNameStr, Order);


GetPatternFrequencyValue

This function returns a column's distinct pattern.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the column’s distinct pattern.


Syntax profiler->GetPatternFrequencyValue(columnNameStr);
C integer = mdProfilerGetPatternFrequencyValue(profiler,columnNameStr);
.Net integer = profiler.GetPatternFrequencyValue(columnNameStr);


GetPatternFrequencyRegEx

This function returns a regular expression for a distinct pattern. The regular expressions are 'tuned' for your specified data type. Where appropriate, letters or numbers may be lumped together using the 'one or more' quantifier.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get a regular expression for a distinct pattern.


Syntax profiler->GetPatternFrequencyRegEx(columnNameStr);
C integer = mdProfilerGetPatternFrequencyRegEx(profiler,columnNameStr);
.Net integer = profiler.GetPatternFrequencyRegEx(columnNameStr);


GetPatternFrequencyExample

This function returns an example value represented by the pattern. This will always be the first value encountered while profiling.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get an example value represented by the pattern.


Syntax profiler->GetPatternFrequencyExample(columnNameStr);
C integer = mdProfilerGetPatternFrequencyExample(profiler,columnNameStr);
.Net integer = profiler.GetPatternFrequencyExample(columnNameStr);


GetPatternFrequencyCount

This function returns the number of times the pattern appears in the profiled data for this particular column.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the number of times the pattern appears in the profiled data.


Syntax profiler->GetPatternFrequencyCount(columnNameStr);
C integer = mdProfilerGetPatternFrequencyCount(profiler,columnNameStr);
.Net integer = profiler.GetPatternFrequencyCount(columnNameStr);


GetNextPatternFrequency

This function steps to the next distinct pattern. It returns 1 if there are more distinct patterns or 0 when there are no more patterns.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the next distinct pattern.


Syntax profiler->GetNextPatternFrequency(columnNameStr);
C integer = mdProfilerGetNextPatternFrequency(profiler,columnNameStr);
.Net integer = profiler.GetNextPatternFrequency(columnNameStr);