VerityDotNet 1.0
C# library for Verity data profiling, quality control, remediation
Public Member Functions | Public Attributes | List of all members
VerityDotNet.Field Class Reference

Field object with properties for title, datatype, formatting. More...

Public Member Functions

 Field ()
 Constructor.
 
string GetJSON ()
 make JSON of field object as {"field":{"title":"xxxx","datatype":"xxxxx","strcase":fmt_strcase,"strlen":fmt_strlen....}}
 

Public Attributes

string title
 Field name. Cannot use special characters.
 
string datatype
 Field datatype (string, int, real, bool, date)
 
string fmt_strcase
 for datatype=string, optionally specifies a value is upper or lower case. (upper,lower,"")
 
int fmt_strlen
 for datatype=string, optionally specifies a required integer length (1-n). If value less than 1 then this is ignored.
 
string fmt_strcut
 for datatype= string when strlen>0 and value length larger then chars removed from either front or back. Default is back (front,back)
 
string fmt_strpad
 for datatype= string when strlen>0 and value length shorter then chars added to either front or back. Default is back (front,back)
 
string fmt_strpadchar
 for datatype= string when padding uses this character. Must be 1 character or use one of names (space, fslash, bslash, tab). Default is _
 
int fmt_decimal
 for datatype=real, optionally specifies a required integer number of decimal places (0-n)
 
string fmt_date
 fmt_date: for datatype=date, optionally specifies a required date format as one of- mmddyy, mmdyy, mdyy, mmddyyyy, mmdyyyy, mdyyyy, ddmmyy, ddmyy, dmyy, ddmmyyyy, ddmyyyy, dmyyyy, yymmdd, yymmd, yymd, yyyymmdd, yyyymmd, yyyymd, yyyyddd(3 digit day number within year), yyyyMMMdd, ddMMMyyyy(MMM = 3 letter month title like 'JAN'), 'MONTHdd,yyyy', 'ddMONTH,yyyy', yyyyMONTHdd, ddMONTHyyyy, yyMONTHdd, ddMONTHyy(MONTH full title), *dmmyyyy, mm*dyyyy, *mddyyyy, dd*myyyy(*= can be 1 or 2 characters)
 
string mapto
 when using this Field as an output (i.e. target) field then this specifies if it is mapped to a differently titled source field
 
string parseErrorAction
 Handle empty field values due to parsing errors. Used within RefineData.cs as: a) provide a value to assign to field like 'NA' to denote parse error even for non-string datatypes which means the resulting field will have datatype and formatting errors b) set to '-ignore-' which causes the field value to remain as empty since no transform nor normalize will be done c) set to either '-use-' or '' which causes the empty field value to continue to transform and normalization routines. Note the transform function ifEmpty and ifNotEmpty can be used to set field specific values.
 

Detailed Description

Field object with properties for title, datatype, formatting.

Member Function Documentation

◆ GetJSON()

string VerityDotNet.Field.GetJSON ( )

make JSON of field object as {"field":{"title":"xxxx","datatype":"xxxxx","strcase":fmt_strcase,"strlen":fmt_strlen....}}

Returns
JSON string or if error starts with notok:

The documentation for this class was generated from the following file: