Uses of Class
org.sakaiproject.entitybroker.util.TemplateParseUtil.Template

Packages that use TemplateParseUtil.Template
org.sakaiproject.entitybroker   
org.sakaiproject.entitybroker.entityprovider.capabilities   
org.sakaiproject.entitybroker.util   
 

Uses of TemplateParseUtil.Template in org.sakaiproject.entitybroker
 

Methods in org.sakaiproject.entitybroker that return types with arguments of type TemplateParseUtil.Template
 List<TemplateParseUtil.Template> EntityView.getParseTemplates()
           
 

Method parameters in org.sakaiproject.entitybroker with type arguments of type TemplateParseUtil.Template
 void EntityView.loadParseTemplates(List<TemplateParseUtil.Template> templates)
          Override this method if creating a custom EntityView object
 

Uses of TemplateParseUtil.Template in org.sakaiproject.entitybroker.entityprovider.capabilities
 

Methods in org.sakaiproject.entitybroker.entityprovider.capabilities that return types with arguments of type TemplateParseUtil.Template
 List<TemplateParseUtil.Template> EntityViewUrlCustomizable.getParseTemplates()
          Defines a set of parseable templates to use with entity url processing for this template (which is basically a key and the template string), the array which defines the set of template keys is TemplateParseUtil.PARSE_TEMPLATE_KEYS
Rules for parse templates:
1) "{","}", and #SEPARATOR are special characters and must be used as indicated only
2) Must begin with a #SEPARATOR, must not end with a #SEPARATOR
3) must begin with "/{prefix}" (use the #SEPARATOR and #PREFIX constants)
3) each {var} can only be used once in a template
4) {var} can never touch each other (i.e /{var1}{var2}/{id} is invalid)
5) each {var} can only have the chars from TemplateParseUtil.VALID_VAR_CHARS
6) parse templates can only have the chars from TemplateParseUtil.VALID_TEMPLATE_CHARS
7) Empty braces ({}) cannot appear in the template

You do not have to supply a template for all the keys in TemplateParseUtil.PARSE_TEMPLATE_KEYS, any that you do not include will simply use the default templates, be careful though, since they will be parsed in order you have to be careful about the order you place your templates in the list, check the default order as an example
 

Uses of TemplateParseUtil.Template in org.sakaiproject.entitybroker.util
 

Subclasses of TemplateParseUtil.Template in org.sakaiproject.entitybroker.util
static class TemplateParseUtil.PreProcessedTemplate
          Contains the data for templates, each template must have a template key and the template itself
static class TemplateParseUtil.ProcessedTemplate
          Contains the processed template with the values from the processed input string that was determined to be related to this template
 

Fields in org.sakaiproject.entitybroker.util with type parameters of type TemplateParseUtil.Template
static List<TemplateParseUtil.Template> TemplateParseUtil.defaultTemplates
          Stores the preloaded default templates
 

Methods in org.sakaiproject.entitybroker.util with parameters of type TemplateParseUtil.Template
static TemplateParseUtil.PreProcessedTemplate TemplateParseUtil.preprocessTemplate(TemplateParseUtil.Template t)
          process a template into a preprocessed template which can be cached
 

Method parameters in org.sakaiproject.entitybroker.util with type arguments of type TemplateParseUtil.Template
static List<TemplateParseUtil.PreProcessedTemplate> TemplateParseUtil.preprocessTemplates(List<TemplateParseUtil.Template> templates)
          Process the templates before attempting to match them, this is here so we can reduce the load of reprocessing the same templates over and over
 



Copyright © 2007-2012 Sakai Project. All Rights Reserved.