Difference between revisions of "Profiler Object:Enumeration Listing and Parsing"

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...")
 
 
(6 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'''
|-
| 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 mw-collapsed" 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]]
|}
|}




Line 91: Line 14:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnTypeEnum();
|Syntax=profiler->GetColumnTypeEnum();
|C=string = mdProfilerGetColumTypeEnum(profiler);
|C=const char* = mdProfilerGetColumTypeEnum(profiler);
|.Net=string = profiler.GetColumnTypeEnum();
|.Net=string = profiler.GetColumnTypeEnum();
}}
}}
Line 104: Line 27:
|Name=ProfilerColumnTypeValue
|Name=ProfilerColumnTypeValue
|Data Type=ProfilerColumnType
|Data Type=ProfilerColumnType
|Description=For enumeration details refer the section Profiler Column Type Enumerations.
|Description= See [[#ProfilerColumnType Enumerations|ProfilerColumnType Enumerations]] for more details.
}}
}}


{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnTypeDescription(ProfilerColumnTypeValue);
|Syntax=profiler->GetColumnTypeDescription(ProfilerColumnTypeValue);
|C=string = mdProfilerGetColumTypeDescription(profiler, ProfilerColumnTypeValue);
|C=const char* = mdProfilerGetColumTypeDescription(profiler, ProfilerColumnTypeValue);
|.Net=string = profiler.GetColumnTypeDescription(ProfilerColumnTypeValue);
|.Net=string = profiler.GetColumnTypeDescription(ProfilerColumnTypeValue);
}}
}}
Line 130: Line 53:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->ParseColumnTypeDescription(ColumnTypeDescString);
|Syntax=profiler->ParseColumnTypeDescription(ColumnTypeDescString);
|C=ProfilerColumnTypeValue = mdProfilerParseColumnTypeDescription(profiler, ColumnTypeDescString);
|C=const char* = mdProfilerParseColumnTypeDescription(profiler, ColumnTypeDescString);
|.Net=ProfilerColumnTypeValue = profiler.GetColumnTypeDescription(ColumnTypeDescString);
|.Net=string = profiler.GetColumnTypeDescription(ColumnTypeDescString);
}}
}}


Line 139: Line 62:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetColumnTypeEnum();
|Syntax=profiler->GetColumnTypeEnum();
|C=string = mdProfilerGetDataTypeEnum(profiler);
|C=const char* = mdProfilerGetDataTypeEnum(profiler);
|.Net=string = profiler.GetDataTypeEnum();
|.Net=string = profiler.GetDataTypeEnum();
}}
}}
Line 157: Line 80:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetDataTypeDescription(profilerDataTypeValue);
|Syntax=profiler->GetDataTypeDescription(profilerDataTypeValue);
|C=string = mdProfilerGetDataTypeDescription(profiler,profilerDataTypeValue);
|C=const char* = mdProfilerGetDataTypeDescription(profiler,profilerDataTypeValue);
|.Net=string = profiler.GetDataTypeDescription(profilerDataTypeValue);
|.Net=string = profiler.GetDataTypeDescription(profilerDataTypeValue);
}}
}}
Line 176: Line 99:


{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->ParseColumnTypeDescription(StringValue);
|Syntax=profiler->ParseDataTypeDescription(StringValue);
|C=ProfilerDataTypeValue = mdProfilerParseDataTypeDescription(profiler, string);
|C=ProfilerDataTypeValue = mdProfilerParseDataTypeDescription(profiler, string);
|.Net=ProfilerDataTypeValue = profiler.GetColumnTypeDescription(string);
|.Net=ProfilerDataTypeValue = profiler.ParseDataTypeDescription(string);
}}
}}


Line 186: Line 109:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetResultCodeEnum();
|Syntax=profiler->GetResultCodeEnum();
|C=stringValue = mdProfilerGetResultCodeEnum(profiler);
|C=const char* = mdProfilerGetResultCodeEnum(profiler);
|.Net=stringValue = profiler.GetResultCodeEnum();
|.Net=string = profiler.GetResultCodeEnum();
}}
}}


Line 204: Line 127:
{{ Object Syntax
{{ Object Syntax
|Syntax=profiler->GetResultCodeDescription(resultcodeStr);
|Syntax=profiler->GetResultCodeDescription(resultcodeStr);
|C=stringValue = mdProfilerGetResultCodeDescription(profiler, ResultCodeString);
|C=const char* = mdProfilerGetResultCodeDescription(profiler, ResultCodeString);
|.Net=stringValue = profiler.GetResultCodeDescription(ResultCodeString);
|.Net=string = profiler.GetResultCodeDescription(ResultCodeString);
}}
}}


Line 218: Line 141:
|1
|1
|ColumnTypeInt1
|ColumnTypeInt1
|8 bit signed integer
|8 bit Signed Integer
|-
|-
|2
|2
|ColumnTypeInt2
|ColumnTypeInt2
|16 bit signed integer
|16 bit Signed Integer
|-
|-
|3
|3
|ColumnTypeInt4
|ColumnTypeInt4
|32 bit signed integer.
|32 bit Signed Integer
|-
|-
|4
|4
|ColumnTypeInt8
|ColumnTypeInt8
|64 bit signed integer.
|64 bit Signed Integer
|-
|-
|5
|5
|ColumnTypeUInt1
|ColumnTypeUInt1
|8 bit unsigned integer
|8 bit Unsigned Integer
|-
|-
|6
|6
|ColumnTypeUInt1
|ColumnTypeUInt2
|16 bit unsigned integer
|16 bit Unsigned Integer
|-
|-
|7
|7
|ColumnTypeUInt1
|ColumnTypeUInt4
|32 bit unsigned integer.
|32 bit Unsigned Integer
|-
|-
|8
|8
|ColumnTypeUInt1
|ColumnTypeUInt8
|64 bit unsigned integer.
|64 bit Unsigned Integer
|-
|-
|9
|9
|ColumnTypeReal4
|ColumnTypeReal4
|32 bit floating point number.
|32 bit Floating Point Number
|-
|-
|10
|10
|ColumnTypeReal8
|ColumnTypeReal8
|64 bit floating point number.
|64 bit Floating Point Number
|-
|-
|11
|11
Line 270: Line 193:
|14
|14
|ColumnTypeFixedMBCSString
|ColumnTypeFixedMBCSString
|Fixed-length multi-byte string.
|Fixed-Length Multi-Byte String
|-
|-
|15
|15
|ColumnTypeVariableMBCSString
|ColumnTypeVariableMBCSString
|Variable-length multi-byte string.
|Variable-Length multi-byte string
|-
|-
|16
|16
|ColumnTypeFixedUnicodeString
|ColumnTypeFixedUnicodeString
|Fixed-length Unicode string
|Fixed-Length Unicode String
|-
|-
|17
|17
|ColumnTypeVariableUnicodeString
|ColumnTypeVariableUnicodeString
|Variable length Unicode string
|Variable-Length Unicode String
|-
|-
|18
|18
Line 290: Line 213:
|19
|19
|ColumnTypeDBDate
|ColumnTypeDBDate
|Database date
|Database Date
|-
|-
|20
|20
Line 302: Line 225:
|22
|22
|ColumnTypeDBTimeStamp
|ColumnTypeDBTimeStamp
|Time stamp
|Time Stamp
|-
|-
|23
|23
|ColumnTypeDBTimeStamp2
|ColumnTypeDBTimeStamp2
|Time stamp
|Time Stamp
|-
|-
|24
|24
|ColumnTypeDBTimeStampOffset
|ColumnTypeDBTimeStampOffset
|Date/Time offset
|Date/Time Offset
|-
|-
|25
|25
Line 322: Line 245:
|27
|27
|ColumnTypeGUID
|ColumnTypeGUID
|GUID value
|GUID Value
|-
|-
|28
|28

Latest revision as of 21:43, 25 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


These functions are largely used by enterprise client applications to poll enumerators and result codes. For example, a GUI product author may opt to not to use a hard-coded list of column types, and rather retrieve a list of valid column types from the object itself. This provides some amount of upward compatibility, as new column types can be added to the object without requiring the developers to update and rebuild their applications.

GetColumnTypeEnum

This function returns all Column Type enumerations. This returns a comma delimited list of the numeric values of each enumeration (i.e., "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29".) You will typically use this by splitting the result by the comma delimiter and iterate through the list of numeric values, passing each value to GetColumnTypeDescription, to get a description of this enumeration. See ProfilerColumnType Enumerations for more details.

Syntax profiler->GetColumnTypeEnum();
C const char* = mdProfilerGetColumTypeEnum(profiler);
.Net string = profiler.GetColumnTypeEnum();


GetColumnTypeDescription

This function returns the description for the specified ColumnType Enumerator.

This function accepts one parameter.

Parameters

Name Data Type Description
ProfilerColumnTypeValue ProfilerColumnType See ProfilerColumnType Enumerations for more details.


Syntax profiler->GetColumnTypeDescription(ProfilerColumnTypeValue);
C const char* = mdProfilerGetColumTypeDescription(profiler, ProfilerColumnTypeValue);
.Net string = profiler.GetColumnTypeDescription(ProfilerColumnTypeValue);


ParseColumnTypeDescription

This function parses the description of the Column Type. This is actually a reverse function of GetColumnTypeDescription. See ProfilerColumnType Enumerations for details.

This function accepts one parameter.

Parameters

Name Data Type Description
ColumnTypeDescString String This string contains the description of the Profiler Column Type.


Return Value

This function returns a ProfilerColumnType value.

Syntax profiler->ParseColumnTypeDescription(ColumnTypeDescString);
C const char* = mdProfilerParseColumnTypeDescription(profiler, ColumnTypeDescString);
.Net string = profiler.GetColumnTypeDescription(ColumnTypeDescString);


GetDataTypeEnum

This function returns all Data Type enumerations. This returns a comma delimited list of the numeric values of each enumeration (i.e., "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23".)You will typically use this by splitting the result by the comma delimiter and iterate through the list of numeric values, passing each value to GetDataTypeDescription, to get a description of this enumeration. See ProfilerDataType Enumerations for more details.

Syntax profiler->GetColumnTypeEnum();
C const char* = mdProfilerGetDataTypeEnum(profiler);
.Net string = profiler.GetDataTypeEnum();


GetDataTypeDescription

This function returns the description for a specified Data Type enumerator.

This function accepts one parameter.

Parameters

Name Data Type Description
ProfilerDataTypeVale ProfilerDataType See ProfilerDataType Enumerations for details.


Syntax profiler->GetDataTypeDescription(profilerDataTypeValue);
C const char* = mdProfilerGetDataTypeDescription(profiler,profilerDataTypeValue);
.Net string = profiler.GetDataTypeDescription(profilerDataTypeValue);


ParseDataTypeDescription

This function parses the description of the Data Type. This is actually a reverse function of GetDataTypeDescription.

This function accepts the Data Type description in string form as a parameter. See ProfilerDataType Enumerations for details.

Parameters

Name Data Type Description
DataTypeString String The string contains the description of the Profiler Data Type.

Return Value

This function returns a ProfilerDataType value.

Syntax profiler->ParseDataTypeDescription(StringValue);
C ProfilerDataTypeValue = mdProfilerParseDataTypeDescription(profiler, string);
.Net ProfilerDataTypeValue = profiler.ParseDataTypeDescription(string);


GetResultCodeEnum

This function returns a comma delimited list of all Result Code enumerations. See Result Codes for more information.

Syntax profiler->GetResultCodeEnum();
C const char* = mdProfilerGetResultCodeEnum(profiler);
.Net string = profiler.GetResultCodeEnum();


GetResultCodeDescription

This function returns the specified result code's description. See Result Codes for more information.

This function accepts one parameter.

Parameters

Name Data Type Description
ResultCodeString String The string contains the result code.


Syntax profiler->GetResultCodeDescription(resultcodeStr);
C const char* = mdProfilerGetResultCodeDescription(profiler, ResultCodeString);
.Net string = profiler.GetResultCodeDescription(ResultCodeString);


ProfilerColumnType Enumerations

These enumerations describe the type of column to be profiled. They are used as input parameters for AddColumn.

Value Name Description
1 ColumnTypeInt1 8 bit Signed Integer
2 ColumnTypeInt2 16 bit Signed Integer
3 ColumnTypeInt4 32 bit Signed Integer
4 ColumnTypeInt8 64 bit Signed Integer
5 ColumnTypeUInt1 8 bit Unsigned Integer
6 ColumnTypeUInt2 16 bit Unsigned Integer
7 ColumnTypeUInt4 32 bit Unsigned Integer
8 ColumnTypeUInt8 64 bit Unsigned Integer
9 ColumnTypeReal4 32 bit Floating Point Number
10 ColumnTypeReal8 64 bit Floating Point Number
11 ColumnTypeNumeric Numeric Value
12 ColumnTypeDecimal Numeric Value
13 ColumnTypeCurrency Numeric Value
14 ColumnTypeFixedMBCSString Fixed-Length Multi-Byte String
15 ColumnTypeVariableMBCSString Variable-Length multi-byte string
16 ColumnTypeFixedUnicodeString Fixed-Length Unicode String
17 ColumnTypeVariableUnicodeString Variable-Length Unicode String
18 ColumnTypeDate Date
19 ColumnTypeDBDate Database Date
20 ColumnTypeDBTime Database Time
21 ColumnTypeDBTime2 Database Time
22 ColumnTypeDBTimeStamp Time Stamp
23 ColumnTypeDBTimeStamp2 Time Stamp
24 ColumnTypeDBTimeStampOffset Date/Time Offset
25 ColumnTypeFileTime File Date/Time
26 ColumnTypeBoolean Boolean Value
27 ColumnTypeGUID GUID Value
28 ColumnTypeBytes Byte Array
29 ColumnTypeImage Image Array


ProfilerDataType Enumerations

These enumerations describe the type of data to be profiled. They are used as input parameters for AddColumn.

Value Name Description
1 DataTypeFullName Full name
2 DataTypeInverseName Inverse ordered name (Last – First)
3 DataTypeNamePrefix Name prefix
4 DataTypeFirstName First name
5 DataTypeMiddleName Middle name
6 DataTypeLastName Last name
7 DataTypeNameSuffix Name Suffix
8 DataTypeTitle Title / Department
9 DataTypeCompany Company or Organization
10 DataTypeAddress Street address
11 DataTypeCity City Name
12 DataTypeStateOrProvince US state or Canadian province
13 DataTypeZipOrPostalCode US zip code or Canadian postal code
14 DataTypeCityStateZip City/State/Zip combined
15 DataTypeCountry Country Name
16 DataTypePhone Phone number
17 DataTypeEmail Email address
18 DataTypeString Generic string value
19 DataTypeNumeric Generic numeric value
20 DataTypeDateMDY Generic Date/Time(formatted Month Day Year)
21 DataTypeDateYMD Generic Date/Time(formatted Year Month Day)
22 DataTypeDateDMY Generic Date/Time(formatted Day Month Year)
23 DataTypeBoolean Generic Boolean Value
Retrieved from "http://wiki.melissadata.com/index.php?title=Profiler_Object:Enumeration_Listing_and_Parsing&oldid=7986"