Profiler Object:Column-Based Word Table Iteration: Difference between revisions

From Melissa Data Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 12: Line 12:


==StartWordFrequency==
==StartWordFrequency==
This function initiates the iterator.
This function initiates the iterator. It returns 1 to indicate if there are records to iterate through. Otherwise it returns 0.


This function takes two parameters.
This function takes two parameters.
Line 27: Line 27:


{{Object Syntax
{{Object Syntax
|Syntax=profiler->StartWordFrequency(columnNameStr, Order);
|Syntax=int = profiler->StartWordFrequency(columnNameStr, Order);
|C=mdProfilerStartWordFrequency(profiler,columnNameStr, Order);
|C=int = mdProfilerStartWordFrequency(profiler,columnNameStr, Order);
|.Net=profiler.StartWordFrequency(columnNameStr, Order);
|.Net=integer = profiler.StartWordFrequency(columnNameStr, Order);
}}
}}



Latest revision as of 16:33, 15 May 2015

← 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


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

StartWordFrequency

This function initiates the iterator. It returns 1 to indicate if there are records to iterate through. Otherwise it returns 0.

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 int = profiler->StartWordFrequency(columnNameStr, Order);
C int = mdProfilerStartWordFrequency(profiler,columnNameStr, Order);
.Net integer = profiler.StartWordFrequency(columnNameStr, Order);


GetWordFrequencyValue

This function returns a column's distinct word.

This function takes one parameter.

Parameters

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


Syntax profiler->GetWordFrequencyValue(columnNameStr);
C const char* = mdProfilerGetWordFrequencyValue(profiler,columnNameStr);
.Net string = profiler.GetWordFrequencyValue(columnNameStr);


GetWordFrequencyCount

This function returns the number of times the word appears in the profiled data for this particular column. Multiple occurrences of the same word in a single record will all be counted.

This function takes one parameter.

Parameters

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


Syntax profiler->GetWordFrequencyCount(columnNameStr);
C integer = mdProfilerGetWordFrequencyCount(profiler,columnNameStr);
.Net integer = profiler.GetWordFrequencyCount(columnNameStr);


GetNextWordFrequency

This function steps to the next distinct word. 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 word.


Syntax profiler->GetNextWordFrequency(columnNameStr);
C integer = mdProfilerGetNextWordFrequency(profiler,columnNameStr);
.Net integer = profiler.GetNextWordFrequency(columnNameStr);