Difference between revisions of "Profiler Object:Column-Based String Statistics"

From Melissa Data Wiki
Jump to navigation Jump to search
(Created page with " ← Profiler Object Reference {| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size...")
 
 
(4 intermediate revisions by the same user not shown)
Line 2: Line 2:
[[Profiler Object:Reference|← Profiler Object Reference]]
[[Profiler Object:Reference|← Profiler Object Reference]]


{| class="mw-collapsible" cellspacing="2" style="background-color:#f9f9f9; border:1px solid #aaaaaa; font-size:9pt; color:#0645ad; padding:8px 8px;"
{{ProfilerObjectNav
! style="text-align:left; color:black; border-bottom:1px solid #aaaaaa;"|'''Profiler Object Interface Navigation'''
|ColumnBasedStatisticsCollapse=
|-
}}
| style="padding-right:220px;"|
|-
|[[Profiler Object:Initialization|Initialization]]
|-
|[[Profiler Object:Object Information|Object Information]]
|-
|[[Profiler Object:Enumeration Listing and Parsing|Enumeration Listing and Parsing]]
|-
|[[Profiler Object:Column Specification|Column Specification]]
|-
|[[Profiler Object:Initiate Profiling|Initiate Profiling]]
|-
|[[Profiler Object:Data Input|Data Input]]
|-
|[[Profiler Object:Profiling|Profiling]]
|-
|[[Profiler Object:Table-Based Statistics|Table-Based Statistics]]
|-
|-
|
{| class="mw-collapsible" style="width:100%;"
|- align="left"
! style="color:black;"|[[Profiler Object:Column-Based Statistics|Column-Based Statistics]]
|-
|[[Profiler Object:Column-Based String Statistics|Column-Based String Statistics]]
|-
|[[Profiler Object:Column-Based Numeric Statistics|Column-Based Numeric Statistics]]
|-
|[[Profiler Object:Column-Based Date/Time Statistics|Column-Based Date/Time Statistics]]
|-
|[[Profiler Object:Column-Based Name Statistics|Column-Based Name Statistics]]
|-
|[[Profiler Object:Column-Based State/Province Statistics|Column-Based State/Province Statistics]]
|-
|[[Profiler Object:Column-Based Zip/Postal Code Statistics|Column-Based Zip/Postal Code Statistics]]
|-
|[[Profiler Object:Column-Based Country Statistics|Column-Based Country Statistics]]
|-
|[[Profiler Object:Column-Based Email Statistics|Column-Based Email Statistics]]
|-
|[[Profiler Object:Column-Based Phone Statistics|Column-Based Phone Statistics]]
|-
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Profiler Object:Iterators|Iterators]]
|-
|[[Profiler Object:Column-Based Value Frequency Table Iteration|Column-Based Value Frequency Table Iteration]]
|-
|[[Profiler Object:Column-Based Value Length Frequency Table Iteration|Column-Based Value Length Frequency Table Iteration]]
|-
|[[Profiler Object:Column-Based Value Pattern Table Iteration|Column-Based Value Pattern Table Iteration]]
|-
|[[Profiler Object:Column-Based Value Date/Time Table Iteration|Column-Based Value Date/Time Table Iteration]]
|-
|[[Profiler Object:Column-Based Value SoundEx Table Iteration|Column-Based Value SoundEx Table Iteration]]
|-
|[[Profiler Object:Column-Based Word Table Iteration|Column-Based Word Table Iteration]]
|-
|[[Profiler Object:Column-Based Word Length Table Iteration|Column-Based Word Length Table Iteration]]
|-
|}
|-
|
{| class="mw-collapsible mw-collapsed" style="width:100%;"
|- align="left"
! style="color:black;"|[[Profiler Object:Result Codes|Result Codes]]
|-
|[[Returned Result Codes:APIs#Profiler Object|Returned Result Codes]]
|-
|[[Result Codes]]
|}
|}




<div class="toclimit-2">{{CustomTOC}}</div>
<div class="toclimit-2">{{CustomTOC}}</div>
Theses statistics should only be retrieved after calling the '''[[Profiler Object:Profiling#ProfileData|ProfileData]]''' function. These values are all column-specific. String statistics are computed for all column types, including non string-based ones (such as numerics, date/times, etc.)
===Quartiles and Medians===
A median value is the 'middle' value. That is, if one were to order a list of 100 values from lowest to highest (including duplicate values), the median value is the value of the 50th item. There are two quartile values: first and third. In the previous example, the first quartile would be the 25th value, and the third quartile would be the 75th value. In cases where the total number of records is not evenly divisible, the value closest to the quartile or median point is used.


==GetColumnStringMaxValue==
==GetColumnStringMaxValue==
Line 98: Line 28:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnStringMaxValue(columnNameStr);
|Syntax=profiler->GetColumnStringMaxValue(columnNameStr);
|C=integer = mdProfilerGetColumnStringMaxValue(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnStringMaxValue(profiler, columnNameStr);
|.Net=integer = profiler.GetColumnStringMaxValue(columnNameStr);
|.Net=string = profiler.GetColumnStringMaxValue(columnNameStr);
}}
}}


Line 116: Line 46:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnStringMinValue(columnNameStr);
|Syntax=profiler->GetColumnStringMinValue(columnNameStr);
|C=integer = mdProfilerGetColumnStringMinValue(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnStringMinValue(profiler, columnNameStr);
|.Net=integer = profiler.GetColumnStringMinValue(columnNameStr);
|.Net=string = profiler.GetColumnStringMinValue(columnNameStr);
}}
}}


Line 134: Line 64:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnStringQ1Value(columnNameStr);
|Syntax=profiler->GetColumnStringQ1Value(columnNameStr);
|C=integer = mdProfilerGetColumnStringQ1Value(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnStringQ1Value(profiler, columnNameStr);
|.Net=integer = profiler.GetColumnStringQ1Value(columnNameStr);
|.Net=string = profiler.GetColumnStringQ1Value(columnNameStr);
}}
}}


Line 152: Line 82:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnStringMedValue(columnNameStr);
|Syntax=profiler->GetColumnStringMedValue(columnNameStr);
|C=integer = mdProfilerGetColumnStringMedValue(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnStringMedValue(profiler, columnNameStr);
|.Net=integer = profiler.GetColumnStringMedValue(columnNameStr);
|.Net=string = profiler.GetColumnStringMedValue(columnNameStr);
}}
}}


Line 170: Line 100:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnStringQ3Value(columnNameStr);
|Syntax=profiler->GetColumnStringQ3Value(columnNameStr);
|C=integer = mdProfilerGetColumnStringQ3Value(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnStringQ3Value(profiler, columnNameStr);
|.Net=integer = profiler.GetColumnStringQ3Value(columnNameStr);
|.Net=string = profiler.GetColumnStringQ3Value(columnNameStr);
}}
}}


Line 224: Line 154:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnStringAvgLength(columnNameStr);
|Syntax=profiler->GetColumnStringAvgLength(columnNameStr);
|C=integer = mdProfilerGetColumnStringAvgLength(profiler, columnNameStr);
|C=double = mdProfilerGetColumnStringAvgLength(profiler, columnNameStr);
|.Net=integer = profiler.GetColumnStringAvgLength(columnNameStr);
|.Net=double = profiler.GetColumnStringAvgLength(columnNameStr);
}}
}}


Line 296: Line 226:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordMaxValue(ColumnNameStr);
|Syntax=profiler->GetColumnWordMaxValue(ColumnNameStr);
|C=integer = mdProfilerGetColumnWordMaxValue(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnWordMaxValue(profiler, columnNameStr);
|.Net=integer = profiler.GetColumWordMaxValue(columnNameStr);
|.Net=string = profiler.GetColumWordMaxValue(columnNameStr);
}}
}}


Line 314: Line 244:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordMinValue(columnNameStr);
|Syntax=profiler->GetColumnWordMinValue(columnNameStr);
|C=integer = mdProfilerGetColumnWordMinValue(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnWordMinValue(profiler, columnNameStr);
|.Net=integer = profiler.GetColumWordMinValue(columnNameStr);
|.Net=string = profiler.GetColumWordMinValue(columnNameStr);
}}
}}


Line 332: Line 262:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordQ1Value(columnNameStr);
|Syntax=profiler->GetColumnWordQ1Value(columnNameStr);
|C=integer = mdProfilerGetColumnWordQ1Value(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnWordQ1Value(profiler, columnNameStr);
|.Net=integer = profiler.GetColumWordQ1Value(columnNameStr);
|.Net=string = profiler.GetColumWordQ1Value(columnNameStr);
}}
}}


Line 350: Line 280:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordMedValue(columnNameStr);
|Syntax=profiler->GetColumnWordMedValue(columnNameStr);
|C=integer = mdProfilerGetColumnWordMedValue(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnWordMedValue(profiler, columnNameStr);
|.Net=integer = profiler.GetColumWordMedValue(columnNameStr);
|.Net=string = profiler.GetColumWordMedValue(columnNameStr);
}}
}}


Line 368: Line 298:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordQ3Value(columnNameStr);
|Syntax=profiler->GetColumnWordQ3Value(columnNameStr);
|C=integer = mdProfilerGetColumnWordQ3Value(profiler, columnNameStr);
|C=const char* = mdProfilerGetColumnWordQ3Value(profiler, columnNameStr);
|.Net=integer = profiler.GetColumWordQ3Value(columnNameStr);
|.Net=string = profiler.GetColumWordQ3Value(columnNameStr);
}}
}}


Line 422: Line 352:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordAvgLength(columnNameStr);
|Syntax=profiler->GetColumnWordAvgLength(columnNameStr);
|C=integer = mdProfilerGetColumnWordAvgLength(profiler, columnNameStr);
|C=double = mdProfilerGetColumnWordAvgLength(profiler, columnNameStr);
|.Net=integer = profiler.GetColumWordAvgLength(columnNameStr);
|.Net=double = profiler.GetColumWordAvgLength(columnNameStr);
}}
}}


Line 493: Line 423:


{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordMaxWords(columnNameStr);
|Syntax=profiler->GetColumnMaxWords(columnNameStr);
|C=integer = mdProfilerGetColumnMaxWords(profiler, columnNameStr);
|C=integer = mdProfilerGetColumnMaxWords(profiler, columnNameStr);
|.Net=integer = profiler.GetColumMaxWords(columnNameStr);
|.Net=integer = profiler.GetColumMaxWords(columnNameStr);
Line 511: Line 441:


{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordMinWords(columnNameStr);
|Syntax=profiler->GetColumnMinWords(columnNameStr);
|C=integer = mdProfilerGetColumnMinWords(profiler, columnNameStr);
|C=integer = mdProfilerGetColumnMinWords(profiler, columnNameStr);
|.Net=integer = profiler.GetColumMinWords(columnNameStr);
|.Net=integer = profiler.GetColumMinWords(columnNameStr);
Line 529: Line 459:


{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnWordAvgWords(columnNameStr);
|Syntax=profiler->GetColumnAvgWords(columnNameStr);
|C=integer = mdProfilerGetColumnAvgWords(profiler, columnNameStr);
|C=double = mdProfilerGetColumnAvgWords(profiler, columnNameStr);
|.Net=integer = profiler.GetColumAvgWords(columnNameStr);
|.Net=double = profiler.GetColumAvgWords(columnNameStr);
}}
}}




[[Category:Profiler Object]]
[[Category:Profiler Object]]

Latest revision as of 22:01, 23 February 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


Theses statistics should only be retrieved after calling the ProfileData function. These values are all column-specific. String statistics are computed for all column types, including non string-based ones (such as numerics, date/times, etc.)

Quartiles and Medians

A median value is the 'middle' value. That is, if one were to order a list of 100 values from lowest to highest (including duplicate values), the median value is the value of the 50th item. There are two quartile values: first and third. In the previous example, the first quartile would be the 25th value, and the third quartile would be the 75th value. In cases where the total number of records is not evenly divisible, the value closest to the quartile or median point is used.

GetColumnStringMaxValue

This function returns a column's largest value (as sorted A-Z.)

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get column's largest value.


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


GetColumnStringMinValue

This function returns a column’s smallest value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get column’s smallest value.


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


GetColumnStringQ1Value

This function returns a column’s first quartile value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get column’s first quartile value


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


GetColumnStringMedValue

This function returns a column’s median value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get column’s median value


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


GetColumnStringQ3Value

This function returns a column’s third quartile value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get column’s third quartile value


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


GetColumnStringMaxLength

This function returns the length of a column’s longest value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the length of the column’s longest value


Syntax profiler->GetColumnStringMaxLength(columnNameStr);
C integer = mdProfilerGetColumnStringMaxLength(profiler, columnNameStr);
.Net integer = profiler.GetColumnStringMaxLength(columnNameStr);


GetColumnStringMinLength

This function returns the length of a column’s shortest value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the length of the column’s shortest value


Syntax profiler->GetColumnStringMinLength(columnNameStr);
C integer = mdProfilerGetColumnStringMinLength(profiler, columnNameStr);
.Net integer = profiler.GetColumnStringMinLength(columnNameStr);


GetColumnStringAvgLength

This funciton returns the average length of the column.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the average length of the column’s value


Syntax profiler->GetColumnStringAvgLength(columnNameStr);
C double = mdProfilerGetColumnStringAvgLength(profiler, columnNameStr);
.Net double = profiler.GetColumnStringAvgLength(columnNameStr);


GetColumnStringQ1Length

This function returns a column’s first quartile length.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the first quartile length


Syntax profiler->GetColumnStringQ1Length(columnNameStr);
C integer = mdProfilerGetColumnStringQ1Length(profiler, columnNameStr);
.Net integer = profiler.GetColumnStringQ1Length(columnNameStr);


GetColumnStringMedLength

This function returns a column’s median length.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the median length


Syntax profiler->GetColumnStringMedLength(ColumnNameStr);
C integer = mdProfilerGetColumnStringMedLength(profiler, columnNameStr);
.Net integer = profiler.GetColumnStringMedLength(columnNameStr);


GetColumnStringQ3Length

This function returns a column’s third quartile length.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the third quartile length


Syntax profiler->GetColumnStringQ3Length(columnNameStr);
C integer = mdProfilerGetColumnStringQ3Length(profiler, columnNameStr);
.Net integer = profiler.GetColumnStringQ3Length(columnNameStr);


GetColumnWordMaxValue

This function returns a column’s largest word value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the column’s largest word value


Syntax profiler->GetColumnWordMaxValue(ColumnNameStr);
C const char* = mdProfilerGetColumnWordMaxValue(profiler, columnNameStr);
.Net string = profiler.GetColumWordMaxValue(columnNameStr);


GetColumnWordMinValue

This function returns a column’s shortest word value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the column’s shortest word value


Syntax profiler->GetColumnWordMinValue(columnNameStr);
C const char* = mdProfilerGetColumnWordMinValue(profiler, columnNameStr);
.Net string = profiler.GetColumWordMinValue(columnNameStr);


GetColumnWordQ1Value

This function returns a column’s first quartile word value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the column’s first quartile word value


Syntax profiler->GetColumnWordQ1Value(columnNameStr);
C const char* = mdProfilerGetColumnWordQ1Value(profiler, columnNameStr);
.Net string = profiler.GetColumWordQ1Value(columnNameStr);


GetColumnWordMedValue

This function returns a column’s median word value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the column’s median word value


Syntax profiler->GetColumnWordMedValue(columnNameStr);
C const char* = mdProfilerGetColumnWordMedValue(profiler, columnNameStr);
.Net string = profiler.GetColumWordMedValue(columnNameStr);


GetColumnWordQ3Value

This function returns a column’s third quartile word value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the column’s third quartile word value


Syntax profiler->GetColumnWordQ3Value(columnNameStr);
C const char* = mdProfilerGetColumnWordQ3Value(profiler, columnNameStr);
.Net string = profiler.GetColumWordQ3Value(columnNameStr);


GetColumnWordMaxLength

This function returns the length of a column’s largest word value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the length of the column’s largest word value


Syntax profiler->GetColumnWordMaxValue(ColumnNameStr);
C integer = mdProfilerGetColumnWordMaxValue(profiler, columnNameStr);
.Net integer = profiler.GetColumWordMaxValue(columnNameStr);


GetColumnWordMinLength

This function returns the length of a column’s shortest word value.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the length of the column’s shortest word value


Syntax profiler->GetColumnWordMinLength(columnNameStr);
C integer = mdProfilerGetColumnWordMinLength(profiler, columnNameStr);
.Net integer = profiler.GetColumWordMinLength(columnNameStr);


GetColumnWordAvgLength

This function returns the average length of a column’s words.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the average length of the column’s words


Syntax profiler->GetColumnWordAvgLength(columnNameStr);
C double = mdProfilerGetColumnWordAvgLength(profiler, columnNameStr);
.Net double = profiler.GetColumWordAvgLength(columnNameStr);


GetColumnWordQ1Length

This function returns a column’s first quartile word length.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the first quartile word length.


Syntax profiler->GetColumnWordQ1Length(columnNameStr);
C integer = mdProfilerGetColumnQ1Length(profiler, columnNameStr);
.Net integer = profiler.GetColumWordQ1Length(ColumnNameStr);


GetColumnWordMedLength

This function returns a column’s median word length.

This function takes one parameter.

Parameters

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


Syntax profiler->GetColumnWordMedLength(columnNameStr);
C integer = mdProfilerGetColumnWordMedLength(profiler, columnNameStr);
.Net integer = profiler.GetColumWordMedLength(columnNameStr);


GetColumnWordQ3Length

This function returns a column’s third quartile word length.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the column’s third quartile word length


Syntax profiler->GetColumnWordQ3Length(columnNameStr);
C integer = mdProfilerGetColumnWordQ3Length(profiler, columnNameStr);
.Net integer = profiler.GetColumWordQ3Length(columnNameStr);


GetColumnMaxWords

This function returns a column’s maximum number of words.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the columns maximum number of words.


Syntax profiler->GetColumnMaxWords(columnNameStr);
C integer = mdProfilerGetColumnMaxWords(profiler, columnNameStr);
.Net integer = profiler.GetColumMaxWords(columnNameStr);


GetColumnMinWords

This function returns a column’s minimum number of words.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the columns minimum number of words.


Syntax profiler->GetColumnMinWords(columnNameStr);
C integer = mdProfilerGetColumnMinWords(profiler, columnNameStr);
.Net integer = profiler.GetColumMinWords(columnNameStr);


GetColumnAvgWords

This function returns a column’s average number of words.

This function takes one parameter.

Parameters

Name Data Type Description
ColumnName String Column Name to get the columns average number of words.


Syntax profiler->GetColumnAvgWords(columnNameStr);
C double = mdProfilerGetColumnAvgWords(profiler, columnNameStr);
.Net double = profiler.GetColumAvgWords(columnNameStr);