Default implementation of IBatchRenderer. More...

Inheritance diagram for CSF.Zpt.BatchRendering.BatchRenderer:

Collaboration diagram for CSF.Zpt.BatchRendering.BatchRenderer:

Public Member Functions
virtual IBatchRenderingResponse	Render (IBatchRenderingOptions batchOptions, IRenderingSettings settings)
	Parse and render the documents found using the given batch rendering options. More...

virtual IBatchRenderingResponse	Render (IBatchRenderingOptions batchOptions, IRenderingOptions options=null)
	Parse and render the documents found using the given batch rendering options. More...

virtual Action < IModelValueContainer >	GetContextConfigurator (IRenderingJob job)
	Gets the rendering context configurator for a given job. More...

	BatchRenderer (IRenderingJobFactory renderingJobFactory=null, IRenderingSettingsFactory settingsFactory=null, IBatchRenderingOptionsValidator optionsValidator=null)
	Initializes a new instance of the CSF.Zpt.BatchRendering.BatchRenderer class. More...

Protected Member Functions
virtual IBatchRenderingDocumentResponse	Render (IRenderingJob job, IRenderingSettings options, IBatchRenderingOptions batchOptions, Action< IModelValueContainer > contextConfigurator)
	Renders a single rendering job and returns a response. More...

virtual IBatchRenderingDocumentResponse	Render (IZptDocument doc, Stream outputStream, IRenderingSettings options, Action< IModelValueContainer > contextConfigurator, string outputInfo)
	Renders a single ZPT document and returns a response. More...

virtual IEnumerable < IRenderingJob >	GetRenderingJobs (IBatchRenderingOptions options, RenderingMode?mode)
	Gets the rendering jobs from the rendering job factory. More...

virtual void	ValidateBatchOptions (IBatchRenderingOptions options)
	Validates the batch rendering options. More...

virtual IZptDocument	GetDocument (IRenderingJob job)
	Gets the document for a given rendering job. More...

virtual string	GetOutputInfo (IRenderingJob job, IBatchRenderingOptions batchOptions)
	Gets the output info for a given rendering job. More...

virtual Stream	GetOutputStream (IRenderingJob job, IBatchRenderingOptions batchOptions)
	Gets the output stream for a given rendering job. More...

Detailed Description

Default implementation of IBatchRenderer.

Constructor & Destructor Documentation

CSF.Zpt.BatchRendering.BatchRenderer.BatchRenderer	(	IRenderingJobFactory	renderingJobFactory = `null`,
		IRenderingSettingsFactory	settingsFactory = `null`,
		IBatchRenderingOptionsValidator	optionsValidator = `null`
	)

inline

Initializes a new instance of the CSF.Zpt.BatchRendering.BatchRenderer class.

Parameters

renderingJobFactory	Rendering job factory.
settingsFactory	Rendering settings factory.
optionsValidator	Options validator.

Member Function Documentation

virtual Action<IModelValueContainer> CSF.Zpt.BatchRendering.BatchRenderer.GetContextConfigurator ( IRenderingJob job )

inlinevirtual

Gets the rendering context configurator for a given job.

Returns: The context configurator.

Parameters

job Job.

virtual IZptDocument CSF.Zpt.BatchRendering.BatchRenderer.GetDocument ( IRenderingJob job )

inlineprotectedvirtual

Gets the document for a given rendering job.

Returns: The document.

Parameters

job Job.

virtual string CSF.Zpt.BatchRendering.BatchRenderer.GetOutputInfo	(	IRenderingJob	job,
		IBatchRenderingOptions	batchOptions
	)

inlineprotectedvirtual

Gets the output info for a given rendering job.

Returns: The output info.

Parameters

job	Job.
batchOptions	Batch options.

virtual Stream CSF.Zpt.BatchRendering.BatchRenderer.GetOutputStream	(	IRenderingJob	job,
		IBatchRenderingOptions	batchOptions
	)

inlineprotectedvirtual

Gets the output stream for a given rendering job.

Returns: The output stream.

Parameters

job	Job.
batchOptions	Batch options.

virtual IEnumerable<IRenderingJob> CSF.Zpt.BatchRendering.BatchRenderer.GetRenderingJobs	(	IBatchRenderingOptions	options,
		RenderingMode?	mode
	)

inlineprotectedvirtual

Gets the rendering jobs from the rendering job factory.

Returns: The rendering jobs.

Parameters

options	Batch rendering options.
mode	An optional rendering mode override.

virtual IBatchRenderingResponse CSF.Zpt.BatchRendering.BatchRenderer.Render	(	IBatchRenderingOptions	batchOptions,
		IRenderingSettings	settings
	)

inlinevirtual

Parse and render the documents found using the given batch rendering options.

Parameters

settings	Rendering settings.
batchOptions	Batch rendering options, indicating the source and destination files.

Implements CSF.Zpt.BatchRendering.IBatchRenderer.

virtual IBatchRenderingResponse CSF.Zpt.BatchRendering.BatchRenderer.Render	(	IBatchRenderingOptions	batchOptions,
		IRenderingOptions	options = `null`
	)

inlinevirtual

Parse and render the documents found using the given batch rendering options.

Parameters

options	Rendering options.
batchOptions	Batch rendering options, indicating the source and destination files.

Returns: An object instance indicating the outcome of the rendering.

Implements CSF.Zpt.BatchRendering.IBatchRenderer.

virtual IBatchRenderingDocumentResponse CSF.Zpt.BatchRendering.BatchRenderer.Render	(	IRenderingJob	job,
		IRenderingSettings	options,
		IBatchRenderingOptions	batchOptions,
		Action< IModelValueContainer >	contextConfigurator
	)

inlineprotectedvirtual

Renders a single rendering job and returns a response.

Parameters

job	The job to render.
options	Rendering options.
batchOptions	Batch rendering options.
contextConfigurator	Context configurator.

virtual IBatchRenderingDocumentResponse CSF.Zpt.BatchRendering.BatchRenderer.Render	(	IZptDocument	doc,
		Stream	outputStream,
		IRenderingSettings	options,
		Action< IModelValueContainer >	contextConfigurator,
		string	outputInfo
	)

inlineprotectedvirtual

Renders a single ZPT document and returns a response.

Parameters

doc	The document to render.
outputStream	The output stream.
options	Rendering options.
contextConfigurator	Context configurator.
outputInfo	Output info.

Reimplemented in CSF.Zpt.BatchRendering.ErrorTolerantBatchRenderer.

virtual void CSF.Zpt.BatchRendering.BatchRenderer.ValidateBatchOptions ( IBatchRenderingOptions options )

inlineprotectedvirtual

Validates the batch rendering options.

Parameters

options Options.

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

/home/craig/Projects/CSF.Zpt/CSF.Zpt/BatchRendering/BatchRenderer.cs

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation