com.neurosys.content.service.publishers

Interface Publisher<T,CONTEXT>

Type Parameters:

T - as Template Type

All Known Implementing Classes:

VelocityContentPublisher

public interface Publisher<T,CONTEXT>

Publish/Print input content into an output medium, given a template. The Publisher is a service that can produce files or artifacts based on input and template.
Each such service relies on the following:

• Core Content to be published as ContentDescriber or ContentFacet or any content
• Template location/path
• Published Content Output location/path

The Publisher is not responsible for any filter or formatting of data; refer to IPublisherAdapter that normally calls the Publisher.

Author:

Arjun Dhar

Method Summary

Modifier and Type	Method and Description
void	addContext(Map objectMap) Deprecated. @see setContext(Object)
void	clearContext() Clear DataMap & Data Context added by this#addContext(Map)
void	publish(String outputPath) Publish to implementation specific Output and also send a copy back via Writer.
void	publish(Writer writer) Publish output to Writer
void	setContext(CONTEXT context) Supply a Context to the Publisher Note: This will replace any existing context map.
void	setTemplate(String path)
void	setTemplate(T template)

Method Detail

setTemplate

void setTemplate(T template)

Parameters:

template - as T

template -

setTemplate

void setTemplate(String path)
          throws Exception

Parameters:

url/filePath - of Template

template -

Throws:

Exception - (like path not found, Parsing exceptions, etc.

addContext

@Deprecated
void addContext(Map objectMap)

Deprecated. @see setContext(Object)

Add Context to the Publisher.
Note: This will replace any existing context map.

Parameters:

objectMap - as Map of Name as String, corresponding Object to insert into Context

setContext

void setContext(CONTEXT context)

Supply a Context to the Publisher
Note: This will replace any existing context map.

Parameters:

context -

clearContext

void clearContext()

Clear DataMap & Data Context added by this#addContext(Map)

publish

void publish(String outputPath)
      throws Exception

Publish to implementation specific Output and also send a copy back via Writer.
The outputPath is specified will result in a resource created from the merge of the context into the template.

Parameters:

outputPath - as String output path

Throws:

{@link - IOException}, Exception

Exception

publish

void publish(Writer writer)
      throws Exception

Publish output to Writer

Parameters:

writer - as Writer

Throws:

Exception