Profiler Object:Column-Based Word Table Iteration
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); |