// Example of using FtWriter to write a declared Fielded Text (CSV) file.
static void Main(string[] args)
{
// Name of file containing Meta
const string MetaFileName = "BasicExampleMeta.ftm";
// Name of file to be written
const string FtxFileName = "BasicExample.ftx";
// Define FieldNames
const string PetNameFieldName = "PetName";
const string AgeFieldName = "Age";
const string ColorFieldName = "Color";
const string DateReceivedFieldName = "DateReceived";
const string PriceFieldName = "Price";
const string NeedsWalkingFieldName = "NeedsWalking";
const string TypeFieldName = "Type";
// Create Meta from file
FtMeta meta = FtMetaSerializer.Deserialize(MetaFileName);
meta.LineCommentChar = '!'; // Is not set as with other examples. Change to !
meta.HeadingLineCount = 0; // Is set to 2 as with other examples. Change to 0 as we do not want any heading lines in this example
// Create FtWriterSettings to flag we want Declared file written
FtWriterSettings settings = new FtWriterSettings();
settings.Declared = true;
settings.MetaReferenceType = FtMetaReferenceType.Embedded;
// Create Writer
using (FtWriter writer = new FtWriter(meta, FtxFileName, settings))
{
// Write 1st Record
writer[PetNameFieldName] = "Rover";
writer[AgeFieldName] = 4.5;
writer[ColorFieldName] = "Brown";
writer[DateReceivedFieldName] = new DateTime(2004, 2, 12);
writer[PriceFieldName] = 80M;
writer[NeedsWalkingFieldName] = true;
writer[TypeFieldName] = "Dog";
writer.Write();
// Write 2nd Record
writer[PetNameFieldName] = "Charlie";
writer[AgeFieldName] = null;
writer[ColorFieldName] = "Gold";
writer[DateReceivedFieldName] = new DateTime(2007, 4, 5);
writer[PriceFieldName] = 12.3M;
writer[NeedsWalkingFieldName] = false;
writer[TypeFieldName] = "Fish";
writer.Write();
}
}
protected void Open(TextWriter writer, bool writerOwned, FtWriterSettings settings)
{
if (this.writer != null && writerOwned)
{
this.writer.Close();
}
this.writer = writer;
this.writerOwned = writerOwned;
this.settings = settings;
Reset();
InvokeRootSequence();
}
public void Close()
{
if (writer != null)
{
if (writerOwned)
{
writer.Close();
}
writer = null;
}
settings = null;
Reset();
}
public void WebSiteBasicExample()
{
FtMeta meta = new FtMeta();
meta.LineCommentChar = '~';
meta.HeadingLineCount = 2;
FtStringMetaField petNameMetaField = meta.FieldList.New(FtStandardDataType.String) as FtStringMetaField;
petNameMetaField.Name = "PetName";
FtFloatMetaField ageMetaField = meta.FieldList.New(FtStandardDataType.Float) as FtFloatMetaField;
ageMetaField.Name = "Age";
FtStringMetaField colorMetaField = meta.FieldList.New(FtStandardDataType.String) as FtStringMetaField;
colorMetaField.Name = "Color";
FtDateTimeMetaField dateReceivedMetaField = meta.FieldList.New(FtStandardDataType.DateTime) as FtDateTimeMetaField;
dateReceivedMetaField.Name = "DateReceived";
dateReceivedMetaField.Format = "d MMM yyyy";
FtDecimalMetaField priceMetaField = meta.FieldList.New(FtStandardDataType.Decimal) as FtDecimalMetaField;
priceMetaField.Name = "Price";
FtBooleanMetaField needsWalkingMetaField = meta.FieldList.New(FtStandardDataType.Boolean) as FtBooleanMetaField;
needsWalkingMetaField.Name = "NeedsWalking";
FtStringMetaField typeMetaField = meta.FieldList.New(FtStandardDataType.String) as FtStringMetaField;
typeMetaField.Name = "Type";
string filePath = Path.Combine(TestFolder, BasicExampleFileName);
FtWriterSettings writerSettings = new FtWriterSettings();
writerSettings.Declared = true;
writerSettings.MetaReferenceType = FtMetaReferenceType.Embedded;
writerSettings.EmbeddedMetaIndent = true;
writerSettings.EmbeddedMetaIndentChars = " ";
using (StreamWriter strmWriter = new StreamWriter(filePath, false, System.Text.Encoding.UTF8))
{
using (FtWriter writer = new FtWriter(meta, strmWriter, writerSettings))
{
FtStringField petNameField = writer.FieldList.Get(petNameMetaField.Name) as FtStringField;
int petNameFieldIndex = writer.GetOrdinal(petNameMetaField.Name);
FtFloatField ageField = writer.FieldList.Get(ageMetaField.Name) as FtFloatField;
int ageFieldIndex = writer.GetOrdinal(ageMetaField.Name);
FtStringField colorField = writer.FieldList.Get(colorMetaField.Name) as FtStringField;
int colorFieldIndex = writer.GetOrdinal(colorMetaField.Name);
FtDateTimeField dateReceivedField = writer.FieldList.Get(dateReceivedMetaField.Name) as FtDateTimeField;
int dateReceivedFieldIndex = writer.GetOrdinal(dateReceivedMetaField.Name);
FtDecimalField priceField = writer.FieldList.Get(priceMetaField.Name) as FtDecimalField;
int priceFieldIndex = writer.GetOrdinal(priceMetaField.Name);
FtBooleanField needsWalkingField = writer.FieldList.Get(needsWalkingMetaField.Name) as FtBooleanField;
int needsWalkingFieldIndex = writer.GetOrdinal(needsWalkingMetaField.Name);
FtStringField typeField = writer.FieldList.Get(typeMetaField.Name) as FtStringField;
int typeFieldIndex = writer.GetOrdinal(typeMetaField.Name);
for (int i = 0; i < headingArray.Length; i++)
{
petNameField.Headings[i] = headingArray[i].PetName;
ageField.Headings[i] = headingArray[i].Age;
colorField.Headings[i] = headingArray[i].Color;
dateReceivedField.Headings[i] = headingArray[i].DateReceived;
priceField.Headings[i] = headingArray[i].Price;
needsWalkingField.Headings[i] = headingArray[i].NeedsWalking;
typeField.Headings[i] = headingArray[i].Type;
}
for (int i = 0; i < 2; i++)
{
if (recArray[i].PetName != null)
{
petNameField.Value = recArray[i].PetName;
}
if (recArray[i].Age.HasValue)
{
// test assigning to AsObject as Single
Single ageAsSingle = (Single)(recArray[i].Age.Value);
ageField.AsObject = ageAsSingle;
Assert.AreEqual <Single>(ageAsSingle, (Single)ageField.Value);
// test assigning to AsObject as Decimal
Decimal ageAsDecimal = (Decimal)(recArray[i].Age.Value);
ageField.AsObject = ageAsDecimal;
Assert.AreEqual <Decimal>(ageAsDecimal, (Decimal)ageField.Value);
// assign as Double
ageField.Value = recArray[i].Age.Value;
}
if (recArray[i].Color != null)
{
colorField.Value = recArray[i].Color;
}
if (recArray[i].DateReceived.HasValue)
{
dateReceivedField.Value = recArray[i].DateReceived.Value;
}
if (recArray[i].Price.HasValue)
{
// test assigning to AsObject as Single
Single priceAsSingle = (Single)(recArray[i].Price.Value);
priceField.AsObject = priceAsSingle;
Assert.AreEqual <Single>(priceAsSingle, (Single)priceField.Value);
// test assigning to AsObject as Double
Double priceAsDouble = (Double)(recArray[i].Price.Value);
priceField.AsObject = priceAsDouble;
Assert.AreEqual <Double>(priceAsDouble, (Double)priceField.Value);
// assign as Decimal
priceField.Value = recArray[i].Price.Value;
}
if (recArray[i].NeedsWalking.HasValue)
{
needsWalkingField.Value = recArray[i].NeedsWalking.Value;
}
if (recArray[i].Type != null)
{
typeField.Value = recArray[i].Type;
}
writer.Write();
}
for (int i = 2; i < 3; i++)
{
if (recArray[i].PetName == null)
{
writer.SetNull(i);
}
else
{
writer.SetString(petNameFieldIndex, recArray[i].PetName);
}
if (!recArray[i].Age.HasValue)
{
writer.SetNull(i);
}
else
{
// test assigning to AsObject as Single
Single ageAsSingle = (Single)recArray[i].Age.Value;
writer[ageMetaField.Name] = ageAsSingle;
Assert.AreEqual <Single>(ageAsSingle, (Single)ageField.Value);
// test assigning to AsObject as Decimal
Decimal ageAsDecimal = (Decimal)(recArray[i].Age.Value);
writer[ageMetaField.Name] = ageAsDecimal;
Assert.AreEqual <Decimal>(ageAsDecimal, (Decimal)ageField.Value);
// assign as Double
writer.SetDouble(ageFieldIndex, recArray[i].Age.Value);
}
if (recArray[i].Color == null)
{
writer.SetNull(i);
}
else
{
writer.SetString(colorFieldIndex, recArray[i].Color);
}
if (!recArray[i].DateReceived.HasValue)
{
writer.SetNull(i);
}
else
{
writer.SetDateTime(dateReceivedFieldIndex, recArray[i].DateReceived.Value);
}
if (!recArray[i].Price.HasValue)
{
writer.SetNull(i);
}
else
{
// test assigning to AsObject as Single
Single priceAsSingle = (Single)(recArray[i].Price.Value);
writer[priceField.Name] = priceAsSingle;
Assert.AreEqual <Single>(priceAsSingle, (Single)priceField.Value);
// test assigning to AsObject as Double
Double priceAsDouble = (Double)(recArray[i].Price.Value);
writer[priceField.Name] = priceAsDouble;
Assert.AreEqual <Double>(priceAsDouble, (Double)priceField.Value);
// assign as Decimal
writer.SetDecimal(priceFieldIndex, recArray[i].Price.Value);
}
if (!recArray[i].NeedsWalking.HasValue)
{
writer.SetNull(i);
}
else
{
writer.SetBoolean(needsWalkingFieldIndex, recArray[i].NeedsWalking.Value);
}
if (recArray[i].Type == null)
{
writer.SetNull(i);
}
else
{
writer.SetString(typeFieldIndex, recArray[i].Type);
}
writer.Write();
}
for (int i = 3; i < recArray.Length; i++)
{
if (recArray[i].PetName == null)
{
writer[petNameMetaField.Name] = null;
}
else
{
writer[petNameMetaField.Name] = recArray[i].PetName;
}
if (!recArray[i].Age.HasValue)
{
writer[ageMetaField.Name] = null;
}
else
{
// test assigning to AsObject as Single
Single ageAsSingle = (Single)recArray[i].Age.Value;
writer[ageMetaField.Name] = ageAsSingle;
Assert.AreEqual <Single>(ageAsSingle, (Single)ageField.Value);
// test assigning to AsObject as Decimal
Decimal ageAsDecimal = (Decimal)(recArray[i].Age.Value);
writer[ageMetaField.Name] = ageAsDecimal;
Assert.AreEqual <Decimal>(ageAsDecimal, (Decimal)ageField.Value);
// assign as Double
writer[ageMetaField.Name] = recArray[i].Age.Value;
}
if (recArray[i].Color == null)
{
writer[colorMetaField.Name] = null;
}
else
{
writer[colorMetaField.Name] = recArray[i].Color;
}
if (!recArray[i].DateReceived.HasValue)
{
writer[dateReceivedMetaField.Name] = null;
}
else
{
writer[dateReceivedMetaField.Name] = recArray[i].DateReceived.Value;
}
if (!recArray[i].Price.HasValue)
{
writer[priceMetaField.Name] = null;
}
else
{
// test assigning to AsObject as Single
Single priceAsSingle = (Single)(recArray[i].Price.Value);
writer[priceField.Name] = priceAsSingle;
Assert.AreEqual <Single>(priceAsSingle, (Single)priceField.Value);
// test assigning to AsObject as Double
Double priceAsDouble = (Double)(recArray[i].Price.Value);
writer[priceField.Name] = priceAsDouble;
Assert.AreEqual <Double>(priceAsDouble, (Double)priceField.Value);
// assign as Decimal
writer[priceMetaField.Name] = recArray[i].Price.Value;
}
if (!recArray[i].NeedsWalking.HasValue)
{
writer[needsWalkingMetaField.Name] = null;
}
else
{
writer[needsWalkingMetaField.Name] = recArray[i].NeedsWalking.Value;
}
if (recArray[i].Type == null)
{
writer[typeMetaField.Name] = null;
}
else
{
writer[typeMetaField.Name] = recArray[i].Type;
}
writer.Write();
}
}
}
string DataFilePath = Path.Combine(DataFolder, BasicExampleFileName);
if (!TextFilesAreEqual(filePath, DataFilePath))
{
Assert.Fail("BasicExample does not match Test Data");
}
else
{
using (FtReader ftReader = new FtReader())
{
ftReader.Open(filePath);
using (StreamReader strmReader = new StreamReader(filePath))
{
Assert.AreEqual <bool>(true, ftReader.Declared);
Assert.AreEqual <bool>(true, ftReader.HeaderRead);
Assert.AreEqual <int>(headingArray.Length, ftReader.HeadingLineReadCount);
Assert.AreEqual <FtMetaReferenceType>(FtMetaReferenceType.Embedded, ftReader.MetaReferenceType);
Assert.AreEqual <FtLineType>(FtLineType.Heading, ftReader.LineType); // last line in header
FtStringField petNameField = ftReader.FieldList.Get(petNameMetaField.Name) as FtStringField;
int petNameFieldIndex = ftReader.GetOrdinal(petNameMetaField.Name);
FtFloatField ageField = ftReader.FieldList.Get(ageMetaField.Name) as FtFloatField;
int ageFieldIndex = ftReader.GetOrdinal(ageMetaField.Name);
FtStringField colorField = ftReader.FieldList.Get(colorMetaField.Name) as FtStringField;
int colorFieldIndex = ftReader.GetOrdinal(colorMetaField.Name);
FtDateTimeField dateReceivedField = ftReader.FieldList.Get(dateReceivedMetaField.Name) as FtDateTimeField;
int dateReceivedFieldIndex = ftReader.GetOrdinal(dateReceivedMetaField.Name);
FtDecimalField priceField = ftReader.FieldList.Get(priceMetaField.Name) as FtDecimalField;
int priceFieldIndex = ftReader.GetOrdinal(priceMetaField.Name);
FtBooleanField needsWalkingField = ftReader.FieldList.Get(needsWalkingMetaField.Name) as FtBooleanField;
int needsWalkingFieldIndex = ftReader.GetOrdinal(needsWalkingMetaField.Name);
FtStringField typeField = ftReader.FieldList.Get(typeMetaField.Name) as FtStringField;
int typeFieldIndex = ftReader.GetOrdinal(typeMetaField.Name);
// skip comment lines
string strmLine;
do
{
strmLine = strmReader.ReadLine();
}while (strmLine[0] == ftReader.LineCommentChar);
for (int i = 0; i < headingArray.Length; i++)
{
strmLine = strmReader.ReadLine();
Assert.AreEqual <string>(headingArray[i].PetName, petNameField.Headings[i]);
Assert.AreEqual <string>(headingArray[i].Age, ageField.Headings[i]);
Assert.AreEqual <string>(headingArray[i].Color, colorField.Headings[i]);
Assert.AreEqual <string>(headingArray[i].DateReceived, dateReceivedField.Headings[i]);
Assert.AreEqual <string>(headingArray[i].Price, priceField.Headings[i]);
Assert.AreEqual <string>(headingArray[i].NeedsWalking, needsWalkingField.Headings[i]);
Assert.AreEqual <string>(headingArray[i].Type, typeField.Headings[i]);
}
for (int i = 0; i < recArray.Length; i++)
{
ftReader.Read();
Assert.AreEqual <string>(strmLine, ftReader.Line);
Assert.AreEqual <int>(-1, ftReader.IgnoreExtraCharsLinePosition);
Assert.AreEqual <int>(i + 1, ftReader.RecordCount);
Assert.AreEqual <int>(1, ftReader.TableCount);
if (recArray[i].PetName == null)
{
Assert.AreEqual <bool>(true, petNameField.IsNull());
}
else
{
Assert.AreEqual <string>(recArray[i].PetName, petNameField.Value);
Assert.AreEqual <object>(recArray[i].PetName, ftReader[petNameMetaField.Name]);
Assert.AreEqual <object>(recArray[i].PetName, ftReader[petNameFieldIndex]);
Assert.AreEqual <string>(recArray[i].PetName, ftReader.GetString(petNameFieldIndex));
}
if (!recArray[i].Age.HasValue)
{
Assert.AreEqual <bool>(true, ageField.IsNull());
Assert.AreEqual <bool>(true, ftReader.IsDBNull(ageFieldIndex));
}
else
{
Assert.AreEqual <double>(recArray[i].Age.Value, ageField.Value);
Assert.AreEqual <object>(recArray[i].Age, ftReader[ageMetaField.Name]);
Assert.AreEqual <object>(recArray[i].Age, ftReader[ageFieldIndex]);
Assert.AreEqual <double>(recArray[i].Age.Value, ftReader.GetDouble(ageFieldIndex));
}
if (recArray[i].Color == null)
{
Assert.AreEqual <bool>(true, colorField.IsNull());
}
else
{
Assert.AreEqual <string>(recArray[i].Color, colorField.Value);
Assert.AreEqual <object>(recArray[i].Color, ftReader[colorMetaField.Name]);
Assert.AreEqual <object>(recArray[i].Color, ftReader[colorFieldIndex]);
Assert.AreEqual <string>(recArray[i].Color, ftReader.GetString(colorFieldIndex));
}
if (!recArray[i].DateReceived.HasValue)
{
Assert.AreEqual <bool>(true, dateReceivedField.IsNull());
}
else
{
Assert.AreEqual <DateTime>(recArray[i].DateReceived.Value, dateReceivedField.Value);
Assert.AreEqual <object>(recArray[i].DateReceived, ftReader[dateReceivedMetaField.Name]);
Assert.AreEqual <object>(recArray[i].DateReceived, ftReader[dateReceivedFieldIndex]);
Assert.AreEqual <DateTime>(recArray[i].DateReceived.Value, ftReader.GetDateTime(dateReceivedFieldIndex));
}
if (!recArray[i].Price.HasValue)
{
Assert.AreEqual <bool>(true, priceField.IsNull());
}
else
{
Assert.AreEqual <decimal>(recArray[i].Price.Value, priceField.Value);
Assert.AreEqual <object>(recArray[i].Price, ftReader[priceMetaField.Name]);
Assert.AreEqual <object>(recArray[i].Price, ftReader[priceFieldIndex]);
Assert.AreEqual <decimal>(recArray[i].Price.Value, ftReader.GetDecimal(priceFieldIndex));
}
if (!recArray[i].NeedsWalking.HasValue)
{
Assert.AreEqual <bool>(true, needsWalkingField.IsNull());
}
else
{
Assert.AreEqual <bool>(recArray[i].NeedsWalking.Value, needsWalkingField.Value);
Assert.AreEqual <object>(recArray[i].NeedsWalking, ftReader[needsWalkingMetaField.Name]);
Assert.AreEqual <object>(recArray[i].NeedsWalking, ftReader[needsWalkingFieldIndex]);
Assert.AreEqual <bool>(recArray[i].NeedsWalking.Value, ftReader.GetBoolean(needsWalkingFieldIndex));
}
if (recArray[i].Type == null)
{
Assert.AreEqual <bool>(true, typeField.IsNull());
}
else
{
Assert.AreEqual <string>(recArray[i].Type, typeField.Value);
Assert.AreEqual <object>(recArray[i].Type, ftReader[typeMetaField.Name]);
Assert.AreEqual <object>(recArray[i].Type, ftReader[typeFieldIndex]);
Assert.AreEqual <string>(recArray[i].Type, ftReader.GetString(typeFieldIndex));
}
strmLine = strmReader.ReadLine();
}
Assert.AreEqual <bool>(false, ftReader.Read());
Assert.AreEqual <int>(recArray.Length, ftReader.RecordCount);
}
// repeat but read header separately
ftReader.Open(filePath, false);
Assert.AreEqual <int>(0, ftReader.HeadingLineReadCount);
Assert.AreEqual <int>(0, ftReader.RecordCount);
Assert.AreEqual <int>(0, ftReader.TableCount);
Assert.AreEqual <bool>(true, ftReader.Declared);
Assert.AreEqual <bool>(false, ftReader.HeaderRead);
ftReader.ReadHeader();
Assert.AreEqual <bool>(true, ftReader.HeaderRead);
Assert.AreEqual <int>(headingArray.Length, ftReader.HeadingLineReadCount);
Assert.AreEqual <FtMetaReferenceType>(FtMetaReferenceType.Embedded, ftReader.MetaReferenceType);
Assert.AreEqual <FtLineType>(FtLineType.Heading, ftReader.LineType); // last line in header
ftReader.SeekEnd();
Assert.AreEqual <int>(recArray.Length, ftReader.RecordCount);
// repeat but reading each line individually
ftReader.Open(filePath, false);
Assert.AreEqual <bool>(false, ftReader.HeaderRead);
Assert.AreEqual <int>(0, ftReader.HeadingLineReadCount);
Assert.AreEqual <int>(0, ftReader.RecordCount);
Assert.AreEqual <int>(0, ftReader.TableCount);
ftReader.ReadLine();
Assert.AreEqual <FtLineType>(FtLineType.Signature, ftReader.LineType);
ftReader.ReadLine();
Assert.AreEqual <FtLineType>(FtLineType.Declaration2, ftReader.LineType);
Assert.AreEqual <FtMetaReferenceType>(FtMetaReferenceType.Embedded, ftReader.MetaReferenceType);
for (int i = 0; i < 10; i++)
{
ftReader.ReadLine();
if (i == 0)
{
Assert.AreEqual <FtLineType>(FtLineType.Comment, ftReader.LineType);
}
else
{
Assert.AreEqual <FtLineType>(FtLineType.EmbeddedMeta, ftReader.LineType);
}
}
for (int i = 0; i < headingArray.Length; i++)
{
ftReader.ReadLine();
Assert.AreEqual <FtLineType>(FtLineType.Heading, ftReader.LineType);
}
Assert.AreEqual <int>(headingArray.Length, ftReader.HeadingLineReadCount);
Assert.AreEqual <bool>(true, ftReader.HeaderRead);
for (int i = 0; i < recArray.Length; i++)
{
ftReader.ReadLine();
Assert.AreEqual <FtLineType>(FtLineType.Record, ftReader.LineType);
}
Assert.AreEqual <bool>(false, ftReader.Read());
Assert.AreEqual <int>(recArray.Length, ftReader.RecordCount);
Assert.AreEqual <int>(1, ftReader.TableCount);
}
}
}
