topic Re: Asset collection query placeholders in Alfresco Archive

Asset collection query placeholders

aussen2 — Wed, 31 Aug 2011 12:07:46 GMT

The standard query definitions for the dynamic asset collections contain a placeholder for a section path. Is there any documentation available on what other placeholders could be used here? Or could you point me to the location in the code where these placeholders are processed?

Re: Asset collection query placeholders

bremmington — Wed, 31 Aug 2011 13:03:17 GMT

There are a couple of others provided: "siteid" and "sectionid".

However, as you might hope, this is a pluggable component, so you can add in as many more as you want. If you take a look in the file "context-parsers-context.xml" you will see all the provided placeholder processors (they are called "context parsers") along with an abstract bean definition named "wcmquickstartmodule_contextParser". To plug-in a new context parser, create a new class that extends the abstract class "org.alfresco.module.org_alfresco_module_wcmquickstart.util.contextparser.ContextParser" and register a bean for it using the abstract "wcmquickstartmodule_contextParser" bean as its parent.

To take the "section" parser as an example, this is defined by the class "SectionPathContextParser" and the bean "wcmquickstartmodule_sectionPathContextParser". The bean definition looks like this:


    <bean id="wcmquickstartmodule_sectionPathContextParser"
          parent="wcmquickstartmodule_contextParser"
          class="org.alfresco.module.org_alfresco_module_wcmquickstart.util.contextparser.SectionPathContextParser">
        <property name="name" value="section" />
    </bean>
‍‍‍‍‍‍‍

Note the reference to the parent bean: "wcmquickstartmodule_contextParser". Also note the value of the name property of this bean: "section" - by default this is used as the key that ties your parser to a particular placeholder (although this is overridden by this particular parser).

Hopefully that makes sense and gives you the starting point you need. Come back to me if you need more information.

Re: Asset collection query placeholders

aussen2 — Wed, 31 Aug 2011 15:37:25 GMT

Thanks you very much for the quick reply! Based on your explanation I could already implement what I needed using a copy of SectionIdContextParser.java and changing it to return the name of the section instead of the nodeRef.


package org.alfresco.module.org_alfresco_module_wcmquickstart.util.contextparser;

import org.alfresco.model.ContentModel;
import org.alfresco.service.cmr.repository.NodeRef;

public class SectionNameContextParser extends ContextParser
{   
   @Override
   public String execute(NodeRef context)
   {
      String result = null;
      NodeRef nodeRef = siteHelper.getRelevantSection(context);
      if (nodeRef != null)
      {
         String nodeName = (String) nodeService.getProperty(nodeRef, ContentModel.PROP_NAME);
         result = nodeName;
      }
      return result;
   }
}
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Asset collection query placeholders

bremmington — Wed, 31 Aug 2011 15:40:21 GMT

Great. Glad it helped.