* This class implements a parser for so called 'wrapper templates', which * in turn are WebObjects style templates composed of an HTML template plus * a .wod file. * *
* const - WOValueAssociation * jo - JoPathAssociation * label - WOLabelAssociation * ognl - WOOgnlAssociation * plist - parse value as plist, then create a WOValueAssociation * q - WOQualifierAssociation (evaluate the given qualifier) * regex - WORegExAssociation * rsrc - WOResourceURLAssociation (lookup URL for a given resource name) * var - WOKeyPathAssociation * varpat - WOKeyPathPatternAssociation* *
* <#a> - WOHyperlink * <#for> - WORepetition * <#get> - WOString * <#if> - WOConditional * <#put> - WOCopyValue * <#submit> - WOSubmitButton * <#table-for> - WOTableRepetition* *
* <#tag ... if="condition"> - WOConditional * <#tag ... ifnot="condition"> - WOConditional * <#tag ... foreach="list"> - WORepetition ** *
* The WOHTMLParser just parses the HTML and asks the WOWrapperTemplateBuilder * to build the actual WOElements. * *
* THREAD: this class is not threadsafe and uses ivars for temporary storage. *
* TODO: WOWrapperTemplateBuilder is not a good name for this class because it * has nothing to do with wrappers. The actual resolution of the wrapper * is done in the WOResourceManager / WOComponentDefinition. * This class receives the already-looked-up URLs for the .wod and .html * templates. * Possibly we could also move this class into the WOTemplateBuilder? **/ public class WOWrapperTemplateBuilder extends WOTemplateBuilder implements WODParserHandler, WOTemplateParserHandler { protected WOTemplate iTemplate; protected Map wodEntries; protected WOResourceManager resourceManager; // Note: we only use lookupDynamicElementClass() of the resource manager // TBD: consolidate that in an interface? /* builder */ @Override public WOTemplate buildTemplate (URL _template, URL _wod, WOResourceManager _resourceManager) { boolean isDebugOn = log.isDebugEnabled(); if (isDebugOn) log.debug("parsing wrapper template ..."); this.resourceManager = _resourceManager; /* parse wod file */ if (_wod != null) { WODParser wodParser = new WODParser(); wodParser.setHandler(this); this.wodEntries = (Map)wodParser.parse(_wod); if (this.wodEntries == null) { Exception e = wodParser.lastException(); if (e != null) log.error("could not parse WOD file: " + e.getMessage(), e); } wodParser.reset(); if (isDebugOn) log.debug(" parsed wod: " + this.wodEntries); } else if (isDebugOn) log.debug(" no wod to parse."); /* parse HTML file */ WOTemplateParser htmlParser = this.instantiateTemplateParser(_template); htmlParser.setHandler(this); this.iTemplate = new WOTemplate(null /* URL */, null /* root */); List
* Frame: MyFrame {
* title = "Welcome to Hola";
* }
* The parser stores the result of this method in a Map under the _cname
* (Frame). This Map is queried after the .wod has been
* parsed. The parser does not care about the type of the object being
* returned, it just stores it.
*
* @param _p - the parser
* @param _cname - the name of the element (Frame)
* @param _entry - the Map containing the bindings (String-WOAssociation)
* @param _clsname - the name of the component (MyFrame)
* @return a WODFileEntry object representing the WOD entry
*/
public Object makeDefinitionForComponentNamed
(WODParser _p, String _compname, Map _entry, String _clsname)
{
return new WODFileEntry(_compname, _clsname, _entry);
}
/* HTML parser callback */
/**
* This method builds a
* Map<String, WOAssociation>
* from a
* Map<String, String>.
*
* It scans the key for a colon (:). If it does not find one,
* it creates a value-association, if not, it calls the
* WOAssociation.associationForPrefix()
* to determine an appropriate WOAssociation for the prefix.
* * Example:
* {
* var:list = "persons";
* var:item = "person";
* count = 5;
* }
* is mapped to:
* {
* list = [WOKeyPathAssociation keypath="persons"];
* item = [WOKeyPathAssociation keypath="person"];
* count = [WOValueAssociation value=5];
* }
*
* We also support Project Wonder style value prefixes (~ and $). Those are
* only processed if the attribute has NO prefix. Eg if you want to have a
* regular, constant value, you can use the const: prefix.
*
*
* @param _attrs - a Map<String,String> as parsed from HTML
* @return a Map<String, WOAssociation>
*/
public static Map
* If the name represents a component, a WOChildComponentReference object
* will get constructed (not the component itself, components are allocated
* on demand).
*/
@SuppressWarnings("unchecked")
public WOElement dynamicElementWithName
(String _name, Map
* <#get var:value="label" if="label.isNotEmpty" />
*
* @param _element
* @param _assocs
* @return
*/
@SuppressWarnings("unchecked")
public WOElement hackNewElement(WOElement _element, Map _assocs) {
if (_element instanceof WOHTMLDynamicElement) {
/* if attribute, wraps the element in a WOConditional */
if (_assocs.containsKey("if")) {
Map assocs = new HashMap(1);
assocs.put("condition", _assocs.remove("if"));
_element = new WOConditional("if-attr", assocs, _element);
}
/* ifnot attribute, wraps the element in a WOConditional */
if (_assocs.containsKey("ifnot")) {
Map assocs = new HashMap(2);
assocs.put("condition", _assocs.remove("ifnot"));
assocs.put("negate", Boolean.TRUE);
_element = new WOConditional("ifnot-attr", assocs, _element);
}
/* foreach attribute, wraps the element in a WORepetition */
if (_assocs.containsKey("foreach")) {
Map assocs = new HashMap(2);
assocs.put("list", _assocs.remove("foreach"));
assocs.put("item", WOAssociation.associationWithKeyPath("item"));
_element = new WORepetition("foreach-attr", assocs, _element);
}
}
return _element;
}
public boolean willParseHTMLData(WOTemplateParser _p, char[] _data) {
return true;
}
public void failedParsingHTMLData
(WOTemplateParser _p, char[] _data, Exception _error)
{
}
public void finishedParsingHTMLData
(WOTemplateParser _p, char[] _data, List