Skip to main content

Toolkit - Criteria for Dynamic Queries

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

In the previous post Dynamic Content Queries, I presented a Query class that performs CustomMeta queries on JSON models published to the file system. This post presents the logic that actually queries for results and applies different boolean operators for different Criteria.

The base class for each criteria is Criterion, which defines the base methods each criteria must implement:

public abstract class Criterion {
    public Set<String> executeQuery() {
        return executeQuery(FilterImpl.EMPTY_FILTER);
    }

    public abstract Set<String> executeQuery(Filter filter);
}

The Filter class contains a set of allowed Publication ids, the item type and whether to include the range boundaries or not. The Filter is used in modifying the results retrieved for each criteria from the indexes.

Each criteria uses an index to lookup values associated to a given key. For example, a CustomMetaCriterion uses a key and value to retrieve all ComponentMeta or PageMeta that have a CustomMeta on that key with the specified value.

In order to do this lookup in a performant manner, there is an index where all keys and values are available (in ascending order) and by simply looking up an key-value tuple, we can retrieve the associated TcmUris of all items that have such key-value as CustomMeta. More information about these indexes is available in post Writing My Own Database Engine.

The CustomMetaCriterion uses the DateIndex, NumericIndex or StringIndex to lookup custom meta keys, depending on the type of the custom meta value (date, numeric or string).

In its simplest form, for a Key-StringValue CustomMeta, the executeQuery method builds an index key on the CustomMeta key and StringValue, then performs the StringIndex lookup for such key.

The result is a set of Strings representing the TcmUris that correspond to that index key in the StringIndex.

public Set<String> executeQuery(Filter filter) {
    String indexKey = stringIndex.buildKey(key, valueString);
    return new TreeSet<>(stringIndex.get(indexKey, filter));
}

The logical criteria (AndCriteria, OrCriteria) delegate their executeQuery to all sub-criteria and perform a logical intersection or union on the result sets. For example below, the AndCriteria below contains a list of sub-criteria that it needs to perform a logical AND between the result sets of each sub-criteria. As such, AndCriteria loops over the sub-criteria and then intersects their result sets:

public Set<String> executeQuery(Filter filter) {
    Set<String> result = null;
    boolean first = true;

    for (Criterion criterion : criteria) {
        Set<String> criterionResult = criterion.executeQuery(filter);

        if (first) {
            first = false;
            result = new TreeSet<>(criterionResult);
        } else {
            result.retainAll(criterionResult);
        }
    }

    return result;
}



Comments

Popular posts from this blog

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 Criterio

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