Uses of Class
org.sakaiproject.entitybroker.util.TemplateParseUtil.Template
-
Packages that use TemplateParseUtil.Template Package Description 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 Modifier and Type Method Description List<TemplateParseUtil.Template>EntityView. getParseTemplates()Method parameters in org.sakaiproject.entitybroker with type arguments of type TemplateParseUtil.Template Modifier and Type Method Description voidEntityView. loadParseTemplates(List<TemplateParseUtil.Template> templates)Override this method if creating a customEntityViewobject -
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 Modifier and Type Method Description 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 isTemplateParseUtil.PARSE_TEMPLATE_KEYS
Rules for parse templates:
1) "{","}", and#SEPARATORare 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#SEPARATORand#PREFIXconstants)
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 fromTemplateParseUtil.VALID_VAR_CHARS
6) parse templates can only have the chars fromTemplateParseUtil.VALID_TEMPLATE_CHARS
7) Empty braces ({}) cannot appear in the template
You do not have to supply a template for all the keys inTemplateParseUtil.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 Modifier and Type Class Description static classTemplateParseUtil.PreProcessedTemplateContains the data for templates, each template must have a template key and the template itselfstatic classTemplateParseUtil.ProcessedTemplateContains the processed template with the values from the processed input string that was determined to be related to this templateFields in org.sakaiproject.entitybroker.util with type parameters of type TemplateParseUtil.Template Modifier and Type Field Description static List<TemplateParseUtil.Template>TemplateParseUtil. defaultTemplatesStores the preloaded default templatesMethods in org.sakaiproject.entitybroker.util with parameters of type TemplateParseUtil.Template Modifier and Type Method Description static TemplateParseUtil.PreProcessedTemplateTemplateParseUtil. preprocessTemplate(TemplateParseUtil.Template t)process a template into a preprocessed template which can be cachedMethod parameters in org.sakaiproject.entitybroker.util with type arguments of type TemplateParseUtil.Template Modifier and Type Method Description 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
-