Skip to main content

Toolkit - Dynamic Content Queries

This post if part of a series about the File System Toolkit - a custom content delivery API for SDL Tridion.

This post presents the Dynamic Content Query capability. The requirements for the Toolkit API are that it should be able to provide CustomMeta queries, pagination, and sorting -- all on the file system, without the use third party tools (database, search engines, indexers, etc). Therefore I had to implement a simple database engine and indexer -- which is described in more detail in post Writing My Own Database Engine.

The querying logic does not make use of cache. This means the query logic is executed every time. When models are requested, the models are however retrieved using the ModelFactory and those are cached.

Query Class

This is the main class for dynamic content queries. It is the entry point into the execution logic of a query. The class takes as parameter a Criterion (presented below) which triggers the execution of query in all sub-criteria of a Criterion object.

Class Query provides three main method: executeQuery, executeComponentQuery and executePageQuery, presented below. Each of these method return a list of items, paginated and sorted against the given parameters.

Method executeQuery

This method returns an list of Strings representing the TcmUris of the result. In terms of sorting, this is the most inefficient method because it first has to retrieve Component and Page models for all TcmUris, then sort them, then apply pagination on them and return only the result.

public List<String> executeQuery() {
    List<String> uris = new ArrayList<>(criterion.executeQuery());

    totalItemCount = uris.size();
    uris = applyPagination(uris);

    return uris;
}

Method executeComponentQuery

The method returns a list of ComponentMeta models that match the specified criteria. The method delegates the executeQuery call to the given Criterion and applies filter to item types Components only.

public List<ComponentMeta> executeComponentQuery() {
    List<String> uris = new ArrayList<>(criterion.executeQuery(
        new FilterImpl(ItemTypes.COMPONENT)));
    List<ComponentMeta> result = new ArrayList<>(uris.size());
    for (String uri : uris) {
        TcmUri tcmUri = new TcmUri("tcm:" + uri);
        ComponentMeta componentMeta = modelFactory.getModel(tcmUri);
        if (componentMeta != null) {
            result.add(componentMeta);
        }
    }

    totalItemCount = result.size();
    Collections.sort(result, sorter);
    result = applyPagination(result);

    return result;
}

Method executePageQuery

The method returns a list of PageMeta models that match the specified criteria.

public List<PageMeta> executePageQuery() {
    List<String> uris = new ArrayList<>(criterion.executeQuery(
        new FilterImpl(ItemTypes.PAGE)));
    List<PageMeta> result = new ArrayList<>(uris.size());

    for (String uri : uris) {
        TcmUri tcmUri = new TcmUri("tcm:" + uri);
        PageMeta pageMeta = modelFactory.getModel(tcmUri);
        if (pageMeta != null) {
            result.add(pageMeta);
        }
    }
    totalItemCount = result.size();

    if (sorter != null) {
        Collections.sort(result, sorter);
    }

    result = applyPagination(result);
    return result;
}



Comments

Popular posts from this blog

A DD4T.net Implementation - Custom Binary Publisher

The default way to publish binaries in DD4T is implemented in class DD4T.Templates.Base.Utils.BinaryPublisher and uses method RenderedItem.AddBinary(Component) . This produces binaries that have their TCM URI as suffix in their filename. In my recent project, we had a requirement that binary file names should be clean (without the TCM URI suffix). Therefore, it was time to modify the way DD4T was publishing binaries. The method in charge with publishing binaries is called PublishItem and is defined in class BinaryPublisher . I therefore extended the BinaryPublisher and overrode method PublishItem. public class CustomBinaryPublisher : BinaryPublisher { private Template currentTemplate; private TcmUri structureGroupUri; In its simplest form, method PublishItem just takes the item and passes it to the AddBinary. In order to accomplish the requirement, we must specify a filename while publishing. This is the file name part of the binary path of Component.BinaryConten

Scaling Policies

This post is part of a bigger topic Autoscaling Publishers in AWS . In a previous post we talked about the Auto Scaling Groups , but we didn't go into details on the Scaling Policies. This is the purpose of this blog post. As defined earlier, the Scaling Policies define the rules according to which the group size is increased or decreased. These rules are based on instance metrics (e.g. CPU), CloudWatch custom metrics, or even CloudWatch alarms and their states and values. We defined a Scaling Policy with Steps, called 'increase_group_size', which is triggered first by the CloudWatch Alarm 'Publish_Alarm' defined earlier. Also depending on the size of the monitored CloudWatch custom metric 'Waiting for Publish', the Scaling Policy with Steps can add a difference number of instances to the group. The scaling policy sets the number of instances in group to 1 if there are between 1000 and 2000 items Waiting for Publish in the queue. It also sets the