#region License
// /*
// See license included in this library folder.
// */
#endregion
#undef GENERICS
//#define GENERICS
//#if NET_2_0
#region " Copyright 2005-07 to Marcos Meli - http://www.marcosmeli.com.ar"
// Errors, suggestions, contributions, send a mail to: marcos@filehelpers.com.
#endregion
using System;
using System.Collections;
using System.IO;
using System.Text;
using Transformalize.Libs.FileHelpers.Core;
using Transformalize.Libs.FileHelpers.Engines;
using Transformalize.Libs.FileHelpers.Enums;
using Transformalize.Libs.FileHelpers.ErrorHandling;
using Transformalize.Libs.FileHelpers.Helpers;
namespace Transformalize.Libs.FileHelpers.MasterDetail
{
/// <include file='MasterDetailEngine.docs.xml' path='doc/MasterDetailEngine/*' />
/// <include file='Examples.xml' path='doc/examples/MasterDetailEngine/*' />
#if ! GENERICS
public sealed class MasterDetailEngine : EngineBase
{
#region " Constructor "
/// <include file='MasterDetailEngine.docs.xml' path='doc/MasterDetailEngineCtr1/*' />
public MasterDetailEngine(Type masterType, Type detailType, MasterDetailSelector recordSelector) : base(detailType)
{
mMasterType = masterType;
mMasterInfo = new RecordInfo(masterType);
mRecordSelector = recordSelector;
}
/// <include file='MasterDetailEngine.docs.xml' path='doc/MasterDetailEngineCtr2/*' />
public MasterDetailEngine(Type masterType, Type detailType, CommonSelector action, string selector)
: base(detailType)
{
mMasterInfo = new RecordInfo(masterType);
var sel = new CommonSelectorInternal(action, selector, mMasterInfo.mIgnoreEmptyLines || mRecordInfo.mIgnoreEmptyLines);
mRecordSelector = sel.CommonSelectorMethod;
}
#endregion
#else
/// <typeparam name="M">The Master Record Type</typeparam>
/// <typeparam name="D">The Detail Record Type</typeparam>
public sealed class MasterDetailEngine<M,D> : EngineBase
where M : class
where D : class
{
#region " Constructor "
/// <include file='MasterDetailEngine.docs.xml' path='doc/MasterDetailEngineCtr1/*'/>
public MasterDetailEngine(MasterDetailSelector recordSelector)
: base(typeof(D))
{
mMasterType = typeof(M);
mMasterInfo = new RecordInfo(mMasterType);
mRecordSelector = recordSelector;
}
/// <include file='MasterDetailEngine.docs.xml' path='doc/MasterDetailEngineCtr2/*'/>
public MasterDetailEngine(CommonSelector action, string selector)
: base(typeof(D))
{
mMasterType = typeof(M);
mMasterInfo = new RecordInfo(mMasterType);
MasterDetailEngine.CommonSelectorInternal sel = new MasterDetailEngine.CommonSelectorInternal(action, selector, mMasterInfo.mIgnoreEmptyLines || mRecordInfo.mIgnoreEmptyLines);
mRecordSelector = new MasterDetailSelector(sel.CommonSelectorMethod);
}
#endregion
#endif
#region CommonSelectorInternal
#if ! GENERICS
internal class CommonSelectorInternal
{
private readonly CommonSelector mAction;
private readonly bool mIgnoreEmpty;
private readonly string mSelector;
internal CommonSelectorInternal(CommonSelector action, string selector, bool ignoreEmpty)
{
mAction = action;
mSelector = selector;
mIgnoreEmpty = ignoreEmpty;
}
internal RecordAction CommonSelectorMethod(string recordString)
{
if (mIgnoreEmpty && recordString == string.Empty)
return RecordAction.Skip;
switch (mAction)
{
case CommonSelector.DetailIfContains:
if (recordString.IndexOf(mSelector) >= 0)
return RecordAction.Detail;
else
return RecordAction.Master;
case CommonSelector.MasterIfContains:
if (recordString.IndexOf(mSelector) >= 0)
return RecordAction.Master;
else
return RecordAction.Detail;
case CommonSelector.DetailIfBegins:
if (recordString.StartsWith(mSelector))
return RecordAction.Detail;
else
return RecordAction.Master;
case CommonSelector.MasterIfBegins:
if (recordString.StartsWith(mSelector))
return RecordAction.Master;
else
return RecordAction.Detail;
case CommonSelector.DetailIfEnds:
if (recordString.EndsWith(mSelector))
return RecordAction.Detail;
else
return RecordAction.Master;
case CommonSelector.MasterIfEnds:
if (recordString.EndsWith(mSelector))
return RecordAction.Master;
else
return RecordAction.Detail;
case CommonSelector.DetailIfEnclosed:
if (recordString.StartsWith(mSelector) && recordString.EndsWith(mSelector))
return RecordAction.Detail;
else
return RecordAction.Master;
case CommonSelector.MasterIfEnclosed:
if (recordString.StartsWith(mSelector) && recordString.EndsWith(mSelector))
return RecordAction.Master;
else
return RecordAction.Detail;
}
return RecordAction.Skip;
}
}
#endif
#endregion
#if NET_2_0
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
#endif
private readonly RecordInfo mMasterInfo;
#if NET_2_0
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
#endif
private readonly MasterDetailSelector mRecordSelector;
#if NET_2_0
[DebuggerBrowsable(DebuggerBrowsableState.Never)]
#endif
private readonly Type mMasterType;
/// <summary>Returns the type of the master records handled by this engine.</summary>
public Type MasterType
{
get { return mMasterType; }
}
#region " ReadFile "
/// <include file='MasterDetailEngine.docs.xml' path='doc/ReadFile/*' />
#if ! GENERICS
public MasterDetails[] ReadFile(string fileName)
{
using (var fs = new StreamReader(fileName, mEncoding, true))
{
MasterDetails[] tempRes;
tempRes = ReadStream(fs);
fs.Close();
return tempRes;
}
}
#else
public MasterDetails<M,D>[] ReadFile(string fileName)
{
using (StreamReader fs = new StreamReader(fileName, mEncoding, true))
{
MasterDetails<M,D>[] tempRes;
tempRes = ReadStream(fs);
fs.Close();
return tempRes;
}
}
#endif
#endregion
#region " ReadStream "
/// <include file='MasterDetailEngine.docs.xml' path='doc/ReadStream/*' />
#if ! GENERICS
public MasterDetails[] ReadStream(TextReader reader)
#else
public MasterDetails<M,D>[] ReadStream(TextReader reader)
#endif
{
if (reader == null)
throw new ArgumentNullException("reader", "The reader of the Stream cant be null");
if (mRecordSelector == null)
throw new BadUsageException("The Recordselector cant be null, please pass a not null Selector in the constructor.");
ResetFields();
mHeaderText = String.Empty;
mFooterText = String.Empty;
var resArray = new ArrayList();
var freader = new ForwardReader(reader, mMasterInfo.mIgnoreLast);
freader.DiscardForward = true;
string currentLine, completeLine;
mLineNumber = 1;
completeLine = freader.ReadNextLine();
currentLine = completeLine;
#if !MINI
ProgressHelper.Notify(mNotifyHandler, mProgressMode, 0, -1);
#endif
var currentRecord = 0;
if (mMasterInfo.mIgnoreFirst > 0)
{
for (var i = 0; i < mMasterInfo.mIgnoreFirst && currentLine != null; i++)
{
mHeaderText += currentLine + StringHelper.NewLine;
currentLine = freader.ReadNextLine();
mLineNumber++;
}
}
var byPass = false;
#if ! GENERICS
MasterDetails record = null;
#else
MasterDetails<M,D> record = null;
#endif
var tmpDetails = new ArrayList();
var line = new LineInfo(currentLine);
line.mReader = freader;
while (currentLine != null)
{
try
{
currentRecord++;
line.ReLoad(currentLine);
#if !MINI
ProgressHelper.Notify(mNotifyHandler, mProgressMode, currentRecord, -1);
#endif
var action = mRecordSelector(currentLine);
switch (action)
{
case RecordAction.Master:
if (record != null)
{
#if ! GENERICS
record.mDetails = tmpDetails.ToArray();
#else
record.mDetails = (D[])tmpDetails.ToArray();
#endif
resArray.Add(record);
}
mTotalRecords++;
#if ! GENERICS
record = new MasterDetails();
#else
record = new MasterDetails<M,D>();
#endif
tmpDetails.Clear();
#if ! GENERICS
var lastMaster = mMasterInfo.StringToRecord(line);
#else
M lastMaster = (M)mMasterInfo.StringToRecord(line);
#endif
if (lastMaster != null)
record.mMaster = lastMaster;
break;
case RecordAction.Detail:
#if ! GENERICS
var lastChild = mRecordInfo.StringToRecord(line);
#else
D lastChild = (D) mRecordInfo.StringToRecord(line);
#endif
if (lastChild != null)
tmpDetails.Add(lastChild);
break;
default:
break;
}
}
catch (Exception ex)
{
switch (mErrorManager.ErrorMode)
{
case ErrorMode.ThrowException:
byPass = true;
throw;
case ErrorMode.IgnoreAndContinue:
break;
case ErrorMode.SaveAndContinue:
var err = new ErrorInfo();
err.mLineNumber = mLineNumber;
err.mExceptionInfo = ex;
// err.mColumnNumber = mColumnNum;
err.mRecordString = completeLine;
mErrorManager.AddError(err);
break;
}
}
finally
{
if (byPass == false)
{
currentLine = freader.ReadNextLine();
completeLine = currentLine;
mLineNumber = freader.LineNumber;
}
}
}
if (record != null)
{
#if ! GENERICS
record.mDetails = tmpDetails.ToArray();
#else
record.mDetails = (D[])tmpDetails.ToArray();
#endif
resArray.Add(record);
}
if (mMasterInfo.mIgnoreLast > 0)
{
mFooterText = freader.RemainingText;
}
#if ! GENERICS
return (MasterDetails[]) resArray.ToArray(typeof (MasterDetails));
#else
return (MasterDetails<M,D>[]) resArray.ToArray(typeof (MasterDetails<M,D>));
#endif
}
#endregion
#region " ReadString "
/// <include file='MasterDetailEngine.docs.xml' path='doc/ReadString/*' />
#if ! GENERICS
public MasterDetails[] ReadString(string source)
{
var reader = new StringReader(source);
var res = ReadStream(reader);
reader.Close();
return res;
}
#else
public MasterDetails<M,D>[] ReadString(string source)
{
StringReader reader = new StringReader(source);
MasterDetails<M,D>[] res = ReadStream(reader);
reader.Close();
return res;
}
#endif
#endregion
#region " WriteFile "
#if ! GENERICS
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteFile/*' />
public void WriteFile(string fileName, MasterDetails[] records)
{
WriteFile(fileName, records, -1);
}
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteFile2/*' />
public void WriteFile(string fileName, MasterDetails[] records, int maxRecords)
{
using (var fs = new StreamWriter(fileName, false, mEncoding))
{
WriteStream(fs, records, maxRecords);
fs.Close();
}
}
#else
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteFile/*'/>
public void WriteFile(string fileName, MasterDetails<M,D>[] records)
{
WriteFile(fileName, records, -1);
}
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteFile2/*'/>
public void WriteFile(string fileName, MasterDetails<M,D>[] records, int maxRecords)
{
using (StreamWriter fs = new StreamWriter(fileName, false, mEncoding))
{
WriteStream(fs, records, maxRecords);
fs.Close();
}
}
#endif
#endregion
#region " WriteStream "
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteStream/*' />
#if ! GENERICS
public void WriteStream(TextWriter writer, MasterDetails[] records)
#else
public void WriteStream(TextWriter writer, MasterDetails<M,D>[] records)
#endif
{
WriteStream(writer, records, -1);
}
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteStream2/*' />
#if ! GENERICS
public void WriteStream(TextWriter writer, MasterDetails[] records, int maxRecords)
#else
public void WriteStream(TextWriter writer, MasterDetails<M,D>[] records, int maxRecords)
#endif
{
if (writer == null)
throw new ArgumentNullException("writer", "The writer of the Stream can be null");
if (records == null)
throw new ArgumentNullException("records", "The records can be null. Try with an empty array.");
ResetFields();
if (mHeaderText != null && mHeaderText.Length != 0)
if (mHeaderText.EndsWith(StringHelper.NewLine))
writer.Write(mHeaderText);
else
writer.WriteLine(mHeaderText);
string currentLine = null;
//ConstructorInfo constr = mType.GetConstructor(new Type[] {});
var max = records.Length;
if (maxRecords >= 0)
max = Math.Min(records.Length, maxRecords);
#if !MINI
ProgressHelper.Notify(mNotifyHandler, mProgressMode, 0, max);
#endif
for (var i = 0; i < max; i++)
{
try
{
if (records[i] == null)
throw new BadUsageException("The record at index " + i.ToString() + " is null.");
#if !MINI
ProgressHelper.Notify(mNotifyHandler, mProgressMode, i + 1, max);
#endif
currentLine = mMasterInfo.RecordToString(records[i].mMaster);
writer.WriteLine(currentLine);
if (records[i].mDetails != null)
for (var d = 0; d < records[i].mDetails.Length; d++)
{
currentLine = mRecordInfo.RecordToString(records[i].mDetails[d]);
writer.WriteLine(currentLine);
}
}
catch (Exception ex)
{
switch (mErrorManager.ErrorMode)
{
case ErrorMode.ThrowException:
throw;
case ErrorMode.IgnoreAndContinue:
break;
case ErrorMode.SaveAndContinue:
var err = new ErrorInfo();
err.mLineNumber = mLineNumber;
err.mExceptionInfo = ex;
// err.mColumnNumber = mColumnNum;
err.mRecordString = currentLine;
mErrorManager.AddError(err);
break;
}
}
}
mTotalRecords = records.Length;
if (mFooterText != null && mFooterText != string.Empty)
if (mFooterText.EndsWith(StringHelper.NewLine))
writer.Write(mFooterText);
else
writer.WriteLine(mFooterText);
}
#endregion
#region " WriteString "
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteString/*' />
#if ! GENERICS
public string WriteString(MasterDetails[] records)
#else
public string WriteString(MasterDetails<M,D>[] records)
#endif
{
return WriteString(records, -1);
}
/// <include file='MasterDetailEngine.docs.xml' path='doc/WriteString2/*' />
#if ! GENERICS
public string WriteString(MasterDetails[] records, int maxRecords)
#else
public string WriteString(MasterDetails<M,D>[] records, int maxRecords)
#endif
{
var sb = new StringBuilder();
var writer = new StringWriter(sb);
WriteStream(writer, records, maxRecords);
var res = writer.ToString();
writer.Close();
return res;
}
#endregion
#region " AppendToFile "
/// <include file='MasterDetailEngine.docs.xml' path='doc/AppendToFile1/*' />
#if ! GENERICS
public void AppendToFile(string fileName, MasterDetails record)
{
AppendToFile(fileName, new[] {record});
}
#else
public void AppendToFile(string fileName, MasterDetails<M,D> record)
{
AppendToFile(fileName, new MasterDetails<M,D>[] {record});
}
#endif
/// <include file='MasterDetailEngine.docs.xml' path='doc/AppendToFile2/*' />
#if ! GENERICS
public void AppendToFile(string fileName, MasterDetails[] records)
#else
public void AppendToFile(string fileName, MasterDetails<M,D>[] records)
#endif
{
using (var writer = StreamHelper.CreateFileAppender(fileName, mEncoding, true, false))
{
mHeaderText = String.Empty;
mFooterText = String.Empty;
WriteStream(writer, records);
writer.Close();
}
}
#endregion
}
}
//#endif
Submit an article or tip