Skip to main content

DynamicContent REL Tag Addition to OData Query Extension

Image
By
The current post is a follow-up of the previous OData Query Extension I had developed for Tridion 2011 and 2013:
The code for this version is available in my GitHub project, distributable JAR (odata-query-extension-1.3.jar).

DynamicContent REL Tag

This tag queries for dynamic Component Presentations using the CD API Query and Criterias. It accepts the following attributes:

<tridion:dynamiContent var="name" filter="expr" orderby="expr" top="int" skip="int"
    componentTemplate="tcmuri" />

, where:
  • var - name of the TransformContext variable that would hold the result. If var is specified, the resulting array of ComponentPresentation objects is stored into the TransformContext; otherwise, the DCPs are output one after the oter;
  • filter - expression specifying the Criterias to query by. The format of this attribute is the same as the $filter query parameter presented in URL Syntax for OData Query Extension;
  • orderby - expression specifying the order to sort results by. The format of this attribute is the same as the $orderby query parameter presented in URL Syntax for OData Query Extension;
  • top - if specified, only returns the first top results;
  • skip - if specified, skip the first skip results;
  • componentTemplate - if specified, only return Component Presentations based on this Component Template;
Example:
<tridion:dynamicContent filter="ItemModificationDate gt '2013-05-01 13:24:56.999'"
    orderby="ItemTitle ItemModification asc" />

Configuration

  • Copy the JAR (odata-query-extension-1.3.jar) to your WEB-INF/lib folder (or /bin/lib for .NET installations);
  • Edit your cd_dynamic_conf.xml and add the following line just below the <TCDLEngine>:
    <TagBundle Resource="odata-query-extension.xml" />

Save the Good Part Last - The Code

DynamicContentTagRenderer Class

@Override
public int doStartTag(Tag tag, StringBuffer tagBody, TransformContext context, OutputDocument target)
        throws TCDLTransformerException {
    DynamicContent dynamicContent = new DynamicContent(parametersMap);
    dcps = dynamicContent.queryComponentPresentations();

    return dcps.length > 0 ? Tag.CONTINUE_TAG_EVALUATION : Tag.SKIP_TAG;
}

@Override
public String doEndTag(Tag tag, StringBuffer tagBody, TransformContext context, OutputDocument target)
        throws TCDLTransformerException {
    if (var == null) {
        int publicationId = dcps[0].getPublicationId();
        ComponentPresentationAssembler assembler = new ComponentPresentationAssembler(publicationId);
        for (ComponentPresentation dcp : dcps) {
            tagBody.append(assembler.getContent(dcp.getComponentId(), dcp.getComponentTemplateId()));
        }
    } else {
        context.set(var, dcps);
    }

    return tagBody.toString();
}

DynamicContent Class


public DynamicContent(Map<String, String> attributes) {
    setComponentTemplate(attributes.get(COMPONENT_TEMPLATE));
    QueryBuilder builder = new QueryBuilder(attributes);
    query = builder.getQuery();
}

public ComponentPresentation[] queryComponentPresentations() {
    List<ComponentPresentation> result = new ArrayList<ComponentPresentation>();

    try {
        String componentTcmUris[] = query.executeQuery();
        log.debug("Query found " + componentTcmUris.length + " Components");
        if (componentTcmUris.length == 0) {
            return new ComponentPresentation[0];
        }

        TCMURI tcmUri = new TCMURI(componentTcmUris[0]);
        int publicationId = tcmUri.getPublicationId();
        String templateTcmUri = getTemplateTcmUri(publicationId);

        ComponentPresentationFactory factory = new ComponentPresentationFactory(publicationId);
        ComponentPresentation componentPresentation;

        for (String componentTcmUri : componentTcmUris) {
            if (templateTcmUri == null) {
                componentPresentation = factory.getComponentPresentationWithHighestPriority(componentTcmUri);
            } else {
                componentPresentation = factory.getComponentPresentation(componentTcmUri, templateTcmUri);
            }
            if (componentPresentation != null) {
                result.add(componentPresentation);
            }
        }
    } catch (StorageException se) {
        log.error("StorageException occurred", se);
    } catch (ParseException pe) {
        log.error("ParseException occurred", pe);
    }

    return result.toArray(new ComponentPresentation[0]);
}


Labels:

Comments

Post a Comment

Popular posts from this blog

Running sp_updatestats on AWS RDS database

By
Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as...
2 comments
Read more

REL Standard Tag Library

By
The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...
2 comments
Read more

Publish Binaries to Mapped Structure Groups

By Unknown
Today's TBB of the Week comes from the high demand in the field to publish binary assets to different mapped Structure Groups. By default SDL Tridion offers two ways of publishing binaries: All binaries publish to a folder defined in your Publication properties; All binaries rendered by a given template publish to a folder corresponding to a given Structure Group; In my view, both cases are terrible, over-simplified and not representing a real use-case. Nobody in the field wants all binaries in one folder and nobody separates binary locations by template. Instead, everybody wants a mapping mechanism that takes a binary and publishes it to a given folder, defined by a Structure Group, and this mapping is done using some kind of metadata. More often than not, the metadata is the TCM Folder location of the Multimedia Component. I have seen this implemented numerous times. So the solution to publish binaries to a given location implies finding a mapping from a TCM Folder to a...
10 comments
Read more