Abstract base class for implementations of ITemplateLineAggregator<T>. More...
Public Member Functions | |
| void | AfterPropertiesSet () |
| Post Initialization operation. More... | |
| string | Aggregate (T item) |
| Transforms an item into a line using a template read from a file. More... | |
| virtual void | WriteHeader (TextWriter writer) |
| Subclasses may override this More... | |
| virtual void | WriteFooter (TextWriter writer) |
| Subclasses may override this More... | |
Protected Member Functions | |
| AbstractTemplateLineAggregator () | |
| Default constructor that sets the default values. More... | |
| string | GetFormattedLine (string lineId, IEnumerable< object > parameters) |
| Formats and return the specified line. More... | |
| abstract IEnumerable< object > | GetParameters (T item) |
| Returns the parameters to use when formatting the template line. More... | |
Properties | |
| IResource | Template [get, set] |
| A resource to the template file. More... | |
| Encoding | InputEncoding [get, set] |
| The encoding of the template file. Default is Encoding.Default. More... | |
| CultureInfo | Culture [get, set] |
| The culture to use when formatting lines. Default is CultureInfo.CurrentCulture. More... | |
| string | LineSeparator [get, set] |
| The line separator to use when aggregating several lines. Default is Environment.NewLine. More... | |
| string | TemplateId [get, set] |
| The id of the template line to use. More... | |
 Properties inherited from Summer.Batch.Extra.Template.ITemplateLineAggregator< T > | |
| string | TemplateId [set] |
| The id of the template line to use. More... | |
Detailed Description
Abstract base class for implementations of ITemplateLineAggregator<T>.
- Template Parameters
-
T
Constructor & Destructor Documentation
|
protected |
Default constructor that sets the default values.
Member Function Documentation
| void Summer.Batch.Extra.Template.AbstractTemplateLineAggregator< T >.AfterPropertiesSet | ( | ) |
Post Initialization operation.
Implements Summer.Batch.Common.Factory.IInitializationPostOperations.
| string Summer.Batch.Extra.Template.AbstractTemplateLineAggregator< T >.Aggregate | ( | T | item | ) |
Transforms an item into a line using a template read from a file.
- Parameters
-
item the item to transform
- Returns
- the line corresponding to the given item
|
protected |
Formats and return the specified line.
- Parameters
-
lineId the id of the line to get parameters the parameters for formatting the line
- Returns
- the formatted line
|
protectedpure virtual |
Returns the parameters to use when formatting the template line.
- Parameters
-
item the item to display
- Returns
- the parameters of the current line corresponding to item
|
virtual |
Subclasses may override this
- Parameters
-
writer
Implements Summer.Batch.Infrastructure.Item.File.IFooterWriter.
|
virtual |
Subclasses may override this
- Parameters
-
writer
Implements Summer.Batch.Infrastructure.Item.File.IHeaderWriter.
Property Documentation
|
getset |
The culture to use when formatting lines. Default is CultureInfo.CurrentCulture.
|
getset |
The encoding of the template file. Default is Encoding.Default.
|
getset |
The line separator to use when aggregating several lines. Default is Environment.NewLine.
|
getset |
A resource to the template file.
|
getset |
The id of the template line to use.
The documentation for this class was generated from the following file:
- Summer.Batch.Extra/Template/AbstractTemplateLineAggregator.cs