com.jiowa.template.io

Class TemplateMapLoader

java.lang.Object

com.jiowa.template.io.TemplateMapLoader

public class TemplateMapLoader
extends java.lang.Object

This class has been implemented in order to load templates from a given template directory according to a given template notation and file name filter.

Author:

Robert Mencl

Copyright (C) 2012-2015 JIOWA Business Solutions GmbH, Bettinastr. 30 , 60325 Frankfurt am Main, Germany
Homepage: www.jiowa.de
All rights reserved.

Download: www.jiowa.de/download.html
License: www.jiowa.de/license.html

Field Summary

Fields

Modifier and Type	Field and Description
protected TemplateFileFilter	filter
protected TemplateNotation	notation
protected TemplateParser	parser
protected java.util.Set<java.lang.String>	progressSet
protected java.util.Collection<java.io.File>	templateDirs
protected java.util.jar.JarFile	templateJarFile
protected TemplateMap	templateMap
protected java.util.Map<java.lang.String,java.lang.String>	templateTextMap
protected java.util.Map<java.lang.String,RedefinitionTokenList>	templateTokenMap

Constructor Summary

Constructors

Constructor and Description
TemplateMapLoader(java.util.Collection<java.io.File> templateDirs, TemplateFileFilter filter, TemplateNotation notation) Creates a template map loader which loads all templates from a collection of template directories.
TemplateMapLoader(java.util.jar.JarFile templateJarFile, TemplateFileFilter filter, TemplateNotation notation) Creates a template map loader to laod a template map from jar file.

Method Summary

Modifier and Type	Method and Description
protected void	addToTextMap(java.lang.String filename, java.lang.String text) Adds a filename and its text contents to the template text map.
RedefinitionTokenList	getRedefTokenList(java.lang.String filename) Returns the redefintion token list for a given template file.
TemplateNotation	getTemplateNotation() Returns the template notation.
boolean	isAlreadyInProgress(java.lang.String filename) Returns true if this template filename is already being parsed.
TemplateMap	load() This methods returns the completely parsed templates within a template map.
protected void	loadFromJarFile(java.util.jar.JarFile jarfile) Loads all template files from a jar file.
protected void	loadRecursively(java.util.Collection<java.io.File> dirs) Loads recursively all template files within the collection of directories.
protected void	loadRecursively(java.io.File dir) Loads recursively all template files from a directory.
protected void	loadTemplate(java.lang.String filename) Parses the template with the given filename and returns the Template reference.
void	markTemplate(java.lang.String filename) Marks template as being parsed.
void	putRedefTokenList(java.lang.String filename, RedefinitionTokenList list) Stores the redefinition token list for a given template filename.
protected java.lang.String	readFile(java.io.File file) Reads a template file and returns its text contents as string.
void	removeMark(java.lang.String filename) Remove the mark for a template after it has been parsed correctly.

Methods inherited from class java.lang.Object

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

Field Detail

templateDirs

protected java.util.Collection<java.io.File> templateDirs

templateJarFile

protected java.util.jar.JarFile templateJarFile

filter

protected TemplateFileFilter filter

templateMap

protected TemplateMap templateMap

templateTextMap

protected java.util.Map<java.lang.String,java.lang.String> templateTextMap

templateTokenMap

protected java.util.Map<java.lang.String,RedefinitionTokenList> templateTokenMap

notation

protected TemplateNotation notation

parser

protected TemplateParser parser

progressSet

protected java.util.Set<java.lang.String> progressSet

Constructor Detail

TemplateMapLoader

public TemplateMapLoader(java.util.Collection<java.io.File> templateDirs,
                         TemplateFileFilter filter,
                         TemplateNotation notation)

Creates a template map loader which loads all templates from a collection of template directories.

Parameters:

templateDirs - template directories

filter - template file filter

notation - template notation

TemplateMapLoader

public TemplateMapLoader(java.util.jar.JarFile templateJarFile,
                         TemplateFileFilter filter,
                         TemplateNotation notation)

Creates a template map loader to laod a template map from jar file.

Parameters:

templateJarFile - jar file

filter - template file filter

notation - template notation

Method Detail

load

public TemplateMap load()
                 throws java.io.IOException

This methods returns the completely parsed templates within a template map.

Returns:

the TemplateMap

Throws:

java.io.IOException - in case of I/O errors

getTemplateNotation

public TemplateNotation getTemplateNotation()

Returns the template notation.

Returns:

the initial template notation

getRedefTokenList

public RedefinitionTokenList getRedefTokenList(java.lang.String filename)

Returns the redefintion token list for a given template file.

Parameters:

filename - the template filename

Returns:

the redefinition token list

putRedefTokenList

public void putRedefTokenList(java.lang.String filename,
                              RedefinitionTokenList list)

Stores the redefinition token list for a given template filename.

Parameters:

filename - the template filename

list - the list of redefinition tokens

isAlreadyInProgress

public boolean isAlreadyInProgress(java.lang.String filename)

Returns true if this template filename is already being parsed.

Parameters:

filename - template filename

Returns:

true/false if already being parsed

markTemplate

public void markTemplate(java.lang.String filename)

Marks template as being parsed.

Parameters:

filename - template filename

removeMark

public void removeMark(java.lang.String filename)

Remove the mark for a template after it has been parsed correctly.

Parameters:

filename - template file

loadTemplate

protected void loadTemplate(java.lang.String filename)

Parses the template with the given filename and returns the Template reference.

Parameters:

filename - the name of the file without path, i.e. Attribute.jgt for example.

loadRecursively

protected void loadRecursively(java.util.Collection<java.io.File> dirs)
                        throws java.io.IOException

Loads recursively all template files within the collection of directories.

Parameters:

dirs - list of directories

Throws:

java.io.IOException - if the files or directories could not been accessed

loadRecursively

protected void loadRecursively(java.io.File dir)
                        throws java.io.IOException

Loads recursively all template files from a directory.

Parameters:

dir - the directory

Throws:

java.io.IOException - if the files or directories were not accessable

loadFromJarFile

protected void loadFromJarFile(java.util.jar.JarFile jarfile)
                        throws java.io.IOException

Loads all template files from a jar file.

Parameters:

jarfile - the jar file

Throws:

java.io.IOException

addToTextMap

protected void addToTextMap(java.lang.String filename,
                            java.lang.String text)

Adds a filename and its text contents to the template text map.

Parameters:

filename - the filename

text - the text

readFile

protected java.lang.String readFile(java.io.File file)
                             throws java.io.IOException

Reads a template file and returns its text contents as string.

Parameters:

file - the file

Returns:

the text contents

Throws:

java.io.IOException