org.jostraca
Interface Template

All Known Implementing Classes:

BasicTemplate

public interface Template

Interface to template object. Constructor loads template source and parses out config data into a PropertySet.

Field Summary

static java.lang.String	CN
static java.lang.String	MN_setCodeWriter

Method Summary

TemplatePath[]	getAlsoGenerate() Get list of templates to which should also be generated.
BuildResource	getBuildResource() Get the set of build resources for this template
boolean	getCodeWriterChanged()
java.io.File	getCodeWriterExecutablePath()
java.lang.String	getCodeWriterLang() Get code writer lang if defined, else return empty String.
java.io.File	getCodeWriterPath()
java.lang.String	getCodeWriterSource()
java.lang.Object	getContext() Get context object for internal code writers.
long	getLastMod() Get last modified date of template source file
PropertySet	getMergedPropertySet()
java.io.File	getMetaFile()
PropertySet	getPropertySet(java.lang.String pConfName) Get template PropertySet.
java.lang.Object	getResult() Get result object from CodeWriter (may be null).
java.util.List	getSavedFiles()
SectionSet	getSectionSet() Get the data cotnainer for the insert section text of this template.
java.lang.String	getSource() Get template source.
TemplatePath	getTemplatePath() Get the TemplatePath to this template
boolean	hasMetaFile()
void	load(TemplatePath pTemplatePath) Load template and parse for PropertySet.
void	modifyForOldVersion()
void	setCodeWriterChanged(boolean pChanged)
void	setCodeWriterExecutablePath(java.io.File pCodeWriterExecutablePath)
void	setCodeWriterPath(java.io.File pCodeWriterPath) Set the code writer when known
void	setCodeWriterSource(java.lang.String pCodeWriterSource)
void	setContext(java.lang.Object pContext) Set context object for internal code writers.
void	setMetaFile(java.io.File pMetaFile)
void	setPropertySet(java.lang.String pConfName, PropertySet pPropertySet)
void	setResult(java.lang.Object pResult) Set result object from CodeWriter (optional).
void	setSavedFiles(java.util.List pSavedFiles)
void	setSectionSet(SectionSet pSectionSet) Set the data container for the insert section text of this template.
void	setSource(java.lang.String pSource) Set template source and parse for PropertySet.
java.lang.String	toString() Provide a user-friendly description of the template.
java.lang.String	traceProperty(java.lang.String pName)

Field Detail

CN

public static final java.lang.String CN

MN_setCodeWriter

public static final java.lang.String MN_setCodeWriter

See Also:

Constant Field Values

Method Detail

setSectionSet

public void setSectionSet(SectionSet pSectionSet)

Set the data container for the insert section text of this template.

Parameters:

pSectionSet - container for section text

getSectionSet

public SectionSet getSectionSet()

Get the data cotnainer for the insert section text of this template.

load

public void load(TemplatePath pTemplatePath)

Load template and parse for PropertySet.

Parameters:

pTemplatePath - Path to load template from.

getTemplatePath

public TemplatePath getTemplatePath()

Get the TemplatePath to this template

setContext

public void setContext(java.lang.Object pContext)

Set context object for internal code writers.

Parameters:

pContext - context object

getContext

public java.lang.Object getContext()

Get context object for internal code writers. NOTE: may be null.

setResult

public void setResult(java.lang.Object pResult)

Set result object from CodeWriter (optional).

getResult

public java.lang.Object getResult()

Get result object from CodeWriter (may be null).

setSource

public void setSource(java.lang.String pSource)

Set template source and parse for PropertySet.

getSource

public java.lang.String getSource()

Get template source.

getPropertySet

public PropertySet getPropertySet(java.lang.String pConfName)

Get template PropertySet.

setPropertySet

public void setPropertySet(java.lang.String pConfName,
                           PropertySet pPropertySet)

getMergedPropertySet

public PropertySet getMergedPropertySet()

traceProperty

public java.lang.String traceProperty(java.lang.String pName)

getAlsoGenerate

public TemplatePath[] getAlsoGenerate()

Get list of templates to which should also be generated.

getCodeWriterLang

public java.lang.String getCodeWriterLang()

Get code writer lang if defined, else return empty String.

getLastMod

public long getLastMod()

Get last modified date of template source file

getBuildResource

public BuildResource getBuildResource()

Get the set of build resources for this template

setCodeWriterPath

public void setCodeWriterPath(java.io.File pCodeWriterPath)

Set the code writer when known

getCodeWriterPath

public java.io.File getCodeWriterPath()

setCodeWriterSource

public void setCodeWriterSource(java.lang.String pCodeWriterSource)

getCodeWriterSource

public java.lang.String getCodeWriterSource()

setCodeWriterChanged

public void setCodeWriterChanged(boolean pChanged)

getCodeWriterChanged

public boolean getCodeWriterChanged()

setCodeWriterExecutablePath

public void setCodeWriterExecutablePath(java.io.File pCodeWriterExecutablePath)

getCodeWriterExecutablePath

public java.io.File getCodeWriterExecutablePath()

setSavedFiles

public void setSavedFiles(java.util.List pSavedFiles)

getSavedFiles

public java.util.List getSavedFiles()

setMetaFile

public void setMetaFile(java.io.File pMetaFile)

getMetaFile

public java.io.File getMetaFile()

hasMetaFile

public boolean hasMetaFile()

modifyForOldVersion

public void modifyForOldVersion()

toString

public java.lang.String toString()

Provide a user-friendly description of the template.