com.neurosys.template.service

Class FileTemplateStoreService

java.lang.Object

com.neurosys.template.service.FileTemplateStoreService

All Implemented Interfaces:

TemplateStoreService<File>

public class FileTemplateStoreService
extends Object
implements TemplateStoreService<File>

File based implementation of TemplateStoreService

Author:

Arjun Dhar TODO: Add to Unit test cases

Constructor Summary

Constructors

Constructor and Description
FileTemplateStoreService()

Method Summary

Modifier and Type	Method and Description
File	commitTemplate(File template, String newContent) Will ensure the current saved template, creates also a rollback point for any future reverts.
Object	getDownloadableVersion(File template) Get a downloadable version of the Template as a File or some object that can be represented as a download option
org.apache.commons.collections.Transformer	getPostAction() Action transformers that take File as input pre and post updateTemplate(File, String)
org.apache.commons.collections.Transformer	getPreAction() Action transformers that take File as input pre and post updateTemplate(File, String)
String	getResourceContent(File template) Get the contents of the template
File	getTemplate(String id, String path) Get Template from id and/or path
String	getTemplateHistoryAsMarkup(File template) Get the history of the template edits (if possible) as Markup (HTML) or JSON
String	getTemplateId(File template) Get system id for the template
String	getTemplatePath(File template) Get the system path for the template
String	getTemplateType(File template) Get a type that the template represents.
List<String>	getVersionIds(File template) Get the version ids for all the templates.
List<File>	getVersions(File template) Get the versions for all the templates
boolean	isCommitPossible(File template) Any commit specific implementation available
boolean	isRevertPossible(File template) Is there a revert point to go back to for the given template
File	revertTemplate(File template, String version) Revert to a rollback (committed) point.
void	setPostAction(org.apache.commons.collections.Transformer postAction) Action transformers that take File as input pre and post updateTemplate(File, String)
void	setPreAction(org.apache.commons.collections.Transformer preAction) Action transformers that take File as input pre and post updateTemplate(File, String)
File	updateTemplate(File template, String newContent) Update template with latest content provided to the method Will make changes to the current template
String	updateTemplateHistory(File template, Map updates) Update Template History with details

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileTemplateStoreService

public FileTemplateStoreService()

Method Detail

getResourceContent

public String getResourceContent(File template)
                          throws Exception

Description copied from interface: TemplateStoreService

Get the contents of the template

Specified by:

getResourceContent in interface TemplateStoreService<File>

Throws:

Exception

updateTemplate

public File updateTemplate(File template,
                           String newContent)

Description copied from interface: TemplateStoreService

Update template with latest content provided to the method
Will make changes to the current template

Specified by:

updateTemplate in interface TemplateStoreService<File>

commitTemplate

public File commitTemplate(File template,
                           String newContent)

Description copied from interface: TemplateStoreService

Will ensure the current saved template, creates also a rollback point for any future reverts.
A commit does not necessary imply a save (Implementation specific).

Specified by:

commitTemplate in interface TemplateStoreService<File>

revertTemplate

public File revertTemplate(File template,
                           String version)

Description copied from interface: TemplateStoreService

Revert to a rollback (committed) point.

Specified by:

revertTemplate in interface TemplateStoreService<File>

isRevertPossible

public boolean isRevertPossible(File template)

Description copied from interface: TemplateStoreService

Is there a revert point to go back to for the given template

Specified by:

isRevertPossible in interface TemplateStoreService<File>

getVersions

public List<File> getVersions(File template)

Description copied from interface: TemplateStoreService

Get the versions for all the templates

Specified by:

getVersions in interface TemplateStoreService<File>

Returns:

List of the Templates. Order of the list is assumed to chronological by default.

getVersionIds

public List<String> getVersionIds(File template)

Description copied from interface: TemplateStoreService

Get the version ids for all the templates. Lighter version of TemplateStoreService.getVersions(Object), as it does not fetch the actual template.

Specified by:

getVersionIds in interface TemplateStoreService<File>

Returns:

List of version ids. Order of the list is assumed to chronological by default

getTemplateId

public String getTemplateId(File template)

Description copied from interface: TemplateStoreService

Get system id for the template

Specified by:

getTemplateId in interface TemplateStoreService<File>

getTemplatePath

public String getTemplatePath(File template)

Description copied from interface: TemplateStoreService

Get the system path for the template

Specified by:

getTemplatePath in interface TemplateStoreService<File>

getTemplateHistoryAsMarkup

public String getTemplateHistoryAsMarkup(File template)

Description copied from interface: TemplateStoreService

Get the history of the template edits (if possible) as Markup (HTML) or JSON

Specified by:

getTemplateHistoryAsMarkup in interface TemplateStoreService<File>

getTemplateType

public String getTemplateType(File template)

Description copied from interface: TemplateStoreService

Get a type that the template represents. This could be used to determined specific configurations for this type

Specified by:

getTemplateType in interface TemplateStoreService<File>

getTemplate

public File getTemplate(String id,
                        String path)

Description copied from interface: TemplateStoreService

Get Template from id and/or path

Specified by:

getTemplate in interface TemplateStoreService<File>

updateTemplateHistory

public String updateTemplateHistory(File template,
                                    Map updates)

Description copied from interface: TemplateStoreService

Update Template History with details

Specified by:

updateTemplateHistory in interface TemplateStoreService<File>

isCommitPossible

public boolean isCommitPossible(File template)

Description copied from interface: TemplateStoreService

Any commit specific implementation available

Specified by:

isCommitPossible in interface TemplateStoreService<File>

getDownloadableVersion

public Object getDownloadableVersion(File template)

Description copied from interface: TemplateStoreService

Get a downloadable version of the Template as a File or some object that can be represented as a download option

Specified by:

getDownloadableVersion in interface TemplateStoreService<File>

getPreAction

public org.apache.commons.collections.Transformer getPreAction()

Action transformers that take File as input pre and post updateTemplate(File, String)

setPreAction

public void setPreAction(org.apache.commons.collections.Transformer preAction)

Action transformers that take File as input pre and post updateTemplate(File, String)

getPostAction

public org.apache.commons.collections.Transformer getPostAction()

Action transformers that take File as input pre and post updateTemplate(File, String)

setPostAction

public void setPostAction(org.apache.commons.collections.Transformer postAction)

Action transformers that take File as input pre and post updateTemplate(File, String)