Logged out, click to login

JEDI Online help - Browsing a unit



Back to project JVCL Back Add an item Edit unit Generate DTX file Search Administration

Unit JvCsvData.pas

Author: Warren Postma

Package: DB

Status: Completed

The unit JvCsvData contains TJvCsvDataSet (and its ancestor TJvCustomCsvDataSet), an in-memory TDataSet component similar to TTable. <INCLUDE JVCL.UnitText.dtx>

Last changed by obones on 2009-01-05 18:01:36 CET

Items in the unit

Item
Summary
CsvRowClearDirtyBit Internal Helper function. Clear dirty bit.
CsvRowGetColumnMarker Internal Helper function.
CsvRowGetDirtyBit Internal Helper function.
CsvRowItemCopy Internal Helper function.
CsvRowSetColumnMarker Internal Helper Function.
CsvRowSetDirtyBit Internal Helper Function.
CsvRowToString Internal Helper Function.
DateTimeToTimeTHex Encodes Date/Time as Hex string.
EJvCsvDataSetError Exception class for dataset errors.
EJvCsvKeyError Exception class for CSV key errors. Invalid or duplicate primary key.
GetCsvRowItem Internal Helper.
JvCsvBackupPreviousFiles Backups a CSV file.
JvCsvNumCondition Write here a summary (1 line)
JvCsvWildcardMatch Internal wildcard matching function used by SetFilter
JvDateIsoStr Write here a summary (1 line)
JvDateTimeIsoStr Write here a summary (1 line)
JvIsoDateStrToDate Write here a summary (1 line)
JvIsoDateTimeStrToDateTime Write here a summary (1 line)
JvIsoTimeStrToTime Write here a summary (1 line)
JvTimeIsoStr Write here a summary (1 line)
PCsvColumn CSV Column Data Record
PCsvRow Internal in-memory row data object stored inside a TJvCsvDataSet.
PtrToPtrToCsvRow
SetCsvRowItem Internal Helper.
StringToCsvRow Internal Helper.
TimeTHexToDateTime Decode hex string to date Time.
TJvCsvBookmark A bookmark object (pointer type) used by Data Set Bookmark operations
TJvCsvBookmark.Data Data is a standard field required for bookmark types
TJvCsvBookmark.Flag Flag is a standard field required for bookmark types
TJvCsvColumn CSV Column Data Record
TJvCsvColumn.FFieldDef The corresponding VCL Field Def object for this CsvColumn record.
TJvCsvColumn.FFlag The CSV Field Type is stored in FFlag.
TJvCsvColumn.FKeyFlag Description for FKeyFlag
TJvCsvColumn.FPhysical The Physical Column number is stored in FPhysical.
TJvCsvColumnFlag Enumerated Values for TJvCsvColumn.FFlag
TJvCsvColumnFlag.jcsvAsciiDate Description for jcsvAsciiDate
TJvCsvColumnFlag.jcsvAsciiDateTime A datetime field with the date/time stored as an ISO string
TJvCsvColumnFlag.jcsvAsciiTime Description for jcsvAsciiTime
TJvCsvColumnFlag.jcsvGMTDateTime A datetime field with the date/time stored as a HEX encoded UTC TIME_T timestamp.
TJvCsvColumnFlag.jcsvNull A NULL column descriptor (not yet initialized, or invalid).
TJvCsvColumnFlag.jcsvNumeric A numeric field (integer or float)
TJvCsvColumnFlag.jcsvString A string field.
TJvCsvColumnFlag.jcsvTZDateTime A datetime field with the date/time stored as a HEX encoded TIME_T timestamp in a local timezone.
TJvCsvColumns A TList based list of TJvCsvColumn records.
TJvCsvColumns.AddColumn Standard TList.Add Method.
TJvCsvColumns.Clear Erase all Columns.
TJvCsvColumns.FindByFieldNo Return the Column record for a particular field number.
TJvCsvColumns.FindByName Return a column record for a particular field, search by field name.
TJvCsvDataSet In-memory TDataSet component similar to TTable.
TJvCsvDataSet.FieldDefs Standard VCL Data Aware Component Feature.
TJvCsvFilterNumCompare Write here a summary (1 line)
TJvCsvFilterNumCompare.jfGreaterThan Description for jfGreaterThan
TJvCsvFilterNumCompare.jfIntEqual Description for jfIntEqual
TJvCsvFilterNumCompare.jfIntNotEqual Description for jfIntNotEqual
TJvCsvFilterNumCompare.jfLessThan Description for jfLessThan
TJvCsvOnGetFieldData Event fired when field data is going to be provided to a data aware control.
TJvCsvOnSetFieldData Event fired when field data is going to be updated from data aware control back into our Dataset.
TJvCsvOnSpecialData Occurs when metadata is embedded in a csv data file.
TJvCsvRow Internal in-memory row data object stored inside a TJvCsvDataSet.
TJvCsvRow.Bookmark The bookmark object for this row.
TJvCsvRow.Columns Number of columns in this row.
TJvCsvRow.Filtered Description for Filtered
TJvCsvRow.Index Description for Index
TJvCsvRow.IsDirty The row object's dirty bits. True means row been modified and not yet saved to disk.
TJvCsvRow.RecursionFlag Description for RecursionFlag
TJvCsvRow.Text The raw CSV row text.
TJvCsvRow.WordField Array of indexes to the beginning of each csv column.
TJvCsvRows A TList of TJvCsvRow objects.
TJvCsvRows.AddRow Adds a row.
TJvCsvRows.AddRowStr Converts from string to row, add it to rows list.
TJvCsvRows.Clear Deletes all rows.
TJvCsvRows.DeleteRow Deletes one row.
TJvCsvRows.EnquoteBackslash Specifies whether the component supports enquoting using backslashes.
TJvCsvRows.GetARowItem Get a single value from a certain row and certain column.
TJvCsvRows.GetRowPtr Get pointer to a row object.
TJvCsvRows.GetRowStr Get a row as a csv string.
TJvCsvRows.InsertRow Inserts a row in the dataset.
TJvCsvRows.SetARowItem Write a new value to a column in an existing row.
TJvCsvRows.SetRowStr Sets the value of all fields in an existing row, using a string value.
TJvCsvRows.UserData Provides indexed access to user data storage.
TJvCsvRows.UserTag Provides indexed access to user data storage.
TJvCustomCsvDataSet Base class for TJvCsvDataSet.
TJvCustomCsvDataSet.AlwaysEnquoteStrings Write here a summary (1 line)
TJvCustomCsvDataSet.AppendedFieldCount Returns number of fields that were automatically appended to the file-in-memory when the file was loaded from the disk.
TJvCustomCsvDataSet.AppendRowString This allows you to add a new row to an open dataset, in CSV string form.
TJvCustomCsvDataSet.AppendWith Adds contents of a TStrings object to the existing rows in the database.
TJvCustomCsvDataSet.AssignFromStrings Opens the given TStrings list of strings as its data set.
TJvCustomCsvDataSet.AssignToStrings Gets the contents of the CSV table and adds them to a TStrings string list, which you provide.
TJvCustomCsvDataSet.AutoBackupCount If greater than zero, automatically numbered backups of the CSV file are kept. Backups go in the Backup subdirectory, below wherever the CSV file itself is located.
TJvCustomCsvDataSet.CaseInsensitive CSV Key Uniqueness and Key Comparisons are case insensitive mode if True, or else they are case sensitive.
TJvCustomCsvDataSet.Changed This is the World-Famous 'Dirty Bit'.
TJvCustomCsvDataSet.ClearFilter Make all filtered rows visible again.
TJvCustomCsvDataSet.CloneRow Write here a summary (1 line)
TJvCustomCsvDataSet.CopyFromDataset Write here a summary (1 line)
TJvCustomCsvDataSet.CreatePaths Write here a summary (1 line)
TJvCustomCsvDataSet.CsvFieldDef Comma separated list of field names.
TJvCustomCsvDataSet.CsvKeyDef Primary Key Definition.
TJvCustomCsvDataSet.CsvUniqueKeys Are Unique Keys Enforced when rows are added or modified?
TJvCustomCsvDataSet.CurrentRowAsString Write here a summary (1 line)
TJvCustomCsvDataSet.CustomFilter Write here a summary (1 line)
TJvCustomCsvDataSet.DeleteCsvColumn Write here a summary (1 line)
TJvCustomCsvDataSet.DeleteRows Quickly zap a range of rows from a dataset.
TJvCustomCsvDataSet.EmptyTable Clears everything from the table.
TJvCustomCsvDataSet.EnquoteBackslash Specifies whether the component supports enquoting using backslashes.
TJvCustomCsvDataSet.ExportCsvFile Writes contents of memory to the disk as a csv file.
TJvCustomCsvDataSet.ExportRows Allows selective export of only a certain range of rows from a dataset.
TJvCustomCsvDataSet.ExtendedHeaderInfo Probably never used. Leave it false.
TJvCustomCsvDataSet.FileName The filename that this dataset component loads its data from when opening, and saves it back to when closing.
TJvCustomCsvDataSet.FindByCsvKey Key lookup for datasets where CsvKeyDef is set.
TJvCustomCsvDataSet.Flush Saves changes.
TJvCustomCsvDataSet.GetAsString For Experts Only. Return the string value of a particular field.
TJvCustomCsvDataSet.GetAutoincrement Write here a summary (1 line)
TJvCustomCsvDataSet.GetColumnsAsString Returns CSV Column names in logical order.
TJvCustomCsvDataSet.GetCsvHeader Returns CSV header in File Order.
TJvCustomCsvDataSet.GetRowAsString Get currently selected row as a CSV string, as it would appear in the CSV file.
TJvCustomCsvDataSet.GetUserData Get the user data (pointer) value for a particular record (specified by record number)
TJvCustomCsvDataSet.GetUserTag Get the user tag (integer) value for a particular record (specified by record number)
TJvCustomCsvDataSet.HasHeaderRow Specifies whether the CSV file has a list of field names on the first line.
TJvCustomCsvDataSet.HeaderRow Write here a summary (1 line)
TJvCustomCsvDataSet.InternalData Protected internal property
TJvCustomCsvDataSet.IsKeyUnique Manually check key uniqueness.
TJvCustomCsvDataSet.LoadFromFile Load (one time) from file, without needing the LoadsFromFile property to be set true.
TJvCustomCsvDataSet.LoadsFromFile Specifies whether to automatically load contents of the CSV Filename when you set the table Active property to true.
TJvCustomCsvDataSet.OnGetFieldData Event fired when field data is going to be provided to a data aware control.
TJvCustomCsvDataSet.OnSetFieldData Event fired when field data is going to be updated from data aware control back into our Dataset.
TJvCustomCsvDataSet.OnSpecialData Occurs when metadata is embedded in a csv data file.
TJvCustomCsvDataSet.OpenFileName Write here a summary (1 line)
TJvCustomCsvDataSet.OpenWith Open up any TStrings list of strings as a CSV data set.
TJvCustomCsvDataSet.ReadOnly Data is non-modifiable (read only).
TJvCustomCsvDataSet.Refresh Refresh all data aware controls that are currently connected to this dataset.
TJvCustomCsvDataSet.SavesChanges Specifies whether to write the contents of the data to the file.
TJvCustomCsvDataSet.SaveToFile Save entire contents to the specified filename.
TJvCustomCsvDataSet.Separator Advanced Users Only. Specify Custom Separator Character.
TJvCustomCsvDataSet.SetAllUserData An easy way to set a default value, or clear all values, from all user data.
TJvCustomCsvDataSet.SetAllUserTags An easy way to set a default value, or clear all values, from all user tags.
TJvCustomCsvDataSet.SetFilter Make only certain rows in a dataset visible.
TJvCustomCsvDataSet.SetFilterNum Write here a summary (1 line)
TJvCustomCsvDataSet.SetFilterOnNull Write here a summary (1 line)
TJvCustomCsvDataSet.SetUserData Set the user data (pointer) for a specified record, by record number (recno).
TJvCustomCsvDataSet.SetUserTag Set the user tag (integer) for a specified record, by record number (recno).
TJvCustomCsvDataSet.Sort Sort a dataset by one or more fields, in ascending or descending order.
TJvCustomCsvDataSet.StoreDefs Advanced Users Only. Leave it at Default value of true.
TJvCustomCsvDataSet.TableName A read only property. Returns the same value as TJvCsvDataSet.Filename.
TJvCustomCsvDataSet.TimeZoneCorrection TimeZone Correction. Set to Zero to assume everyone is using UTC.
TJvCustomCsvDataSet.UserData A user-defined Pointer property for the currently active row in the dataset.
TJvCustomCsvDataSet.UserTag A user-defined Integer property for the currently active row in the dataset.
TJvCustomCsvDataSet.ValidateHeaderRow Checks if first row of CSV file is valid.
TJvCustomCsvDataSet._ClearFilter Internal Use Only.
TJvCustomCsvDataSetFilterFunction Write here a summary (1 line)

Copyright (c) 2004 by the JVCL Team; all rights reserved
Uses PclZip by phpconcept and parts of the PEAR library