com.liferay.portal.kernel.templateparser
Class BaseTemplateParser

java.lang.Object
  extended by com.liferay.portal.kernel.templateparser.BaseTemplateParser
All Implemented Interfaces:
TemplateParser

public abstract class BaseTemplateParser
extends java.lang.Object
implements TemplateParser

Author:
Brian Wing Shun Chan, Marcellus Tavares

Constructor Summary
BaseTemplateParser()
           
 
Method Summary
protected  Company getCompany()
           
protected  long getCompanyId()
           
protected  long getGroupId()
           
 java.lang.String getLanguageId()
           
 java.lang.String getScript()
           
protected abstract  TemplateContext getTemplateContext()
           
protected  java.lang.String getTemplateId()
           
protected abstract  java.util.List<TemplateNode> getTemplateNodes(Element element)
           
 ThemeDisplay getThemeDisplay()
           
 java.util.Map<java.lang.String,java.lang.String> getTokens()
           
 java.lang.String getViewMode()
           
 java.lang.String getXML()
           
protected  java.util.Map<java.lang.String,java.lang.Object> insertRequestVariables(Element element)
           
protected abstract  boolean mergeTemplate(TemplateContext templateContext, UnsyncStringWriter unsyncStringWriter)
           
protected  void populateTemplateContext(TemplateContext templateContext)
           
 void setLanguageId(java.lang.String languageId)
           
 void setScript(java.lang.String script)
           
 void setThemeDisplay(ThemeDisplay themeDisplay)
           
 void setTokens(java.util.Map<java.lang.String,java.lang.String> tokens)
           
 void setViewMode(java.lang.String viewMode)
           
 void setXML(java.lang.String xml)
           
 java.lang.String transform()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BaseTemplateParser

public BaseTemplateParser()
Method Detail

getLanguageId

public java.lang.String getLanguageId()
Specified by:
getLanguageId in interface TemplateParser

getScript

public java.lang.String getScript()
Specified by:
getScript in interface TemplateParser

getThemeDisplay

public ThemeDisplay getThemeDisplay()
Specified by:
getThemeDisplay in interface TemplateParser

getTokens

public java.util.Map<java.lang.String,java.lang.String> getTokens()
Specified by:
getTokens in interface TemplateParser

getViewMode

public java.lang.String getViewMode()
Specified by:
getViewMode in interface TemplateParser

getXML

public java.lang.String getXML()
Specified by:
getXML in interface TemplateParser

setLanguageId

public void setLanguageId(java.lang.String languageId)
Specified by:
setLanguageId in interface TemplateParser

setScript

public void setScript(java.lang.String script)
Specified by:
setScript in interface TemplateParser

setThemeDisplay

public void setThemeDisplay(ThemeDisplay themeDisplay)
Specified by:
setThemeDisplay in interface TemplateParser

setTokens

public void setTokens(java.util.Map<java.lang.String,java.lang.String> tokens)
Specified by:
setTokens in interface TemplateParser

setViewMode

public void setViewMode(java.lang.String viewMode)
Specified by:
setViewMode in interface TemplateParser

setXML

public void setXML(java.lang.String xml)
Specified by:
setXML in interface TemplateParser

transform

public java.lang.String transform()
                           throws TransformException
Specified by:
transform in interface TemplateParser
Throws:
TransformException

getCompany

protected Company getCompany()
                      throws java.lang.Exception
Throws:
java.lang.Exception

getCompanyId

protected long getCompanyId()

getGroupId

protected long getGroupId()

getTemplateContext

protected abstract TemplateContext getTemplateContext()
                                               throws java.lang.Exception
Throws:
java.lang.Exception

getTemplateId

protected java.lang.String getTemplateId()

getTemplateNodes

protected abstract java.util.List<TemplateNode> getTemplateNodes(Element element)
                                                          throws java.lang.Exception
Throws:
java.lang.Exception

insertRequestVariables

protected java.util.Map<java.lang.String,java.lang.Object> insertRequestVariables(Element element)

mergeTemplate

protected abstract boolean mergeTemplate(TemplateContext templateContext,
                                         UnsyncStringWriter unsyncStringWriter)
                                  throws java.lang.Exception
Throws:
java.lang.Exception

populateTemplateContext

protected void populateTemplateContext(TemplateContext templateContext)
                                throws java.lang.Exception
Throws:
java.lang.Exception