Skip to main content

Function Support for Queries in OData Extension

Image
By
In a previous post I was talking about the URL Syntax for OData Query Extension. In the current installment, I will present an enhancement to the URL $filter option parser that will allow us to use custom functions. These functions will give us even more possibilities to specify Criterias in RESTful URLs.

The new version is available as JAR distributable (odata-query-extension-1.2.jar) and also as source code.

One of the limitations in the previous OData Query Extension parser was the inability to specify the CustomMetaValue and CustomMetaKey criteria, as they pretty much need to appear nested in one-another:

CustomMetaValue(CustomMetaKey(theKey), theValue[, operator])

Another tricky point are the criterias that accept several parameters, such as

TaxonomyKeywordName(publicationId, taxonomyId, keywordName, includeBranches, operator)

Therefore, I enhanced the parser logic to allow functions in the following syntax:

function(parameter [, field_operator] [, parameter [, field_operator] ]

,where
  • function - a predefined name corresponding to one of the criterias described further down in this post;
  • parameter - a string, number, boolean or 'function name' denoting the value corresponding to a parameter in the function's arguments;
  • field_operator - optional FieldOperator to apply to the previous parameter. Can be one of eq, neq, gt, ge, lt, le, like.
The additional LL(1) grammar rules are:

and_term -> FUNCTION func_op
and_term -> argument
field_op -> FIELD_OPERATOR value
func_op -> OPEN_BRACKET parameter CLOSE_BRACKET

 parameter -> FUNCTION func_op param_op
parameter -> value param_op

 param_op -> SEPARATOR FIELD_OPERATOR param_op
param_op -> SEPARATOR parameter
param_op -> EPSILON

Using the new enhanced parser, I implemented the following functions:

CustomMetaKey

CustomMetaKey(keyName[, field_operator])

Specifies a CustomMetaKeyCriteria for a given custom meta key field, optionally with a field_operator.

Example: CustomMetaKey('doc%', like)

CustomMetaValue

CustomMetaValue(CustomMetaKey(keyName), value[, field_operator])

Specifies a combined CustomMetaKey / CustomMetaValue criteria where the keyName and value belong to the same item's custom meta.
The value can be one of string, float or date (for date, expected format is yyyy-MM-dd HH:mm:ss.SSS)

Example: CustomMetaValue(CustomMetaKey('color'), 'red')

CustomMetaDateRange

CustomMetaDateRange(beginRange, endRange)
CustomMetaDateRange(beginRange, endRange, includeRange)
CustomMetaDateRange(metaFieldName, beginRange, endRange, includeRange)

Specifies a date range for a metadata field. If metadataFieldName is specified, the date range criteria is applied to this field, otherwise to any field of type date. Date format is yyyy-MM-dd HH:mm:ss.SSS

Example: CustomMetaDateRange('expiredate', '2012-10-01 12:00:00.000', '2013-03-15 12:00:00.000', false)

CustomMetaStringRange

CustomMetaStringRange(beginRange, endRange)
CustomMetaStringRange(beginRange, endRange, includeRange)
CustomMetaStringRange(metaFieldName, beginRange, endRange, includeRange)

Specifies a string range for a metadata field. If metadataFieldName is specified, the string range criteria is applied to this field, otherwise to any field of type string.

Example: CustomMetaStringRange('author', 'Adam', 'John', false)

NumericalRange

NumericalRange(beginRange, endRange)
NumericalRange(beginRange, endRange, includeRange)
NumericalRange(metaFieldName, beginRange, endRange, includeRange)

Specifies a numeric range for a metadata field. If metadataFieldName is specified, the numeric range criteria is applied to this field, otherwise to any field of type numeric.

Example: NumericalRange('price', 1.25, 9.99, false)

StructureGroup

StructureGroup(sgUri)
StructureGroup(sgUri, includeChildSGs)

Specifies a Structure Group such that returned results are only Pages within that Structure Group. By specifying includeChildSGs boolean, it is possible to restrict results to an explicit SG or to an entire branch.

Example: StructureGroup('tcm:3-12-4', true)

StructureGroupDirectory

StructureGroupDirectory(directory)
StructureGroupDirectory(directory, field_operator)
StructureGroupDirectory(directory, field_operator, includeChildSGs)

Specifies a criteria such that returned Pages are only within a Structure Group whose property directory matches parameter directory. By specifying includeChildSGs boolean, it is possible to restrict results to the top matched SG or to the whole branch.

Example: StructureGroupDirectory('product%', like, true)

StructureGroupTitle

StructureGroupTitle(title)
StructureGroupTitle(title, field_operator)
StructureGroupTitle(title, field_operator, includeChildSGs)

Specifies a criteria such that returned Pages are only within a Structure Group whose title matches parameter title. By specifying includeChildSGs boolean, it is possible to restrict results to the top matched SG or to the whole branch.

Example: StructureGroupTitle('010 Home', eq, false)

TaxonomyKeyword

TaxonomyKeyword(taxonomyUri, keywordUri, includeKeywordBranches)
TaxonomyKeyword(publicationId, taxonomyId, keywordId, includeKeywordBranches)

Specifies a criteria that returns items classified against a keyword in a taxonomy, and where search is performed on the keyword id.

Example: TaxonomyKeyword(1, 3, 5, false)

TaxonomyKeywordDescription

TaxonomyKeywordDescription(publicationId, taxonomyId, keywordDescription[, field_operator], includeKeywordBranches)

Specifies a criteria that returns items classified against a keyword in a taxonomy, and where search is performed on the keyword description field.

Example: TaxonomyKeywordDescription(1, 3, 'Result%', like, false)

TaxonomyKeywordKey

TaxonomyKeywordKey(publicationId, taxonomyId, keywordKey[, field_operator], includeKeywordBranches)

Specifies a criteria that returns items classified against a keyword in a taxonomy, and where search is performed on the keyword key field.

Example: TaxonomyKeywordKey(1, 3, 'Result Q1', false)

TaxonomyKeywordName

TaxonomyKeywordName(publicationId, taxonomyId, keywordName[, field_operator], includeKeywordBranches)

Specifies a criteria that returns items classified against a keyword in a taxonomy, and where search is performed on the keyword name (a.k.a. title).

Example: TaxonomyKeywordName(1, 3, 'Press%', like, true)


Labels:

Comments

Post a Comment

Popular posts from this blog

Toolkit - Performance

By
This post if part of a series about the File System Toolkit  - a custom content delivery API for SDL Tridion. This post presents performance data that was captured for each major functionality with and without caching Linking, CP Assembler, Component Presentation Factory, Dynamic Content Queries, Model Factory. The data was captured on a 2014 Macbook Pro 15", 16 GB RAM, 2.6 GHz Intel Core i7 running OS X El Capitan. Test methodology: each test was run for 3 minutes and the total number of successful Toolkit API calls was measured. Then the number of calls per second was computed 'with cache' and 'without cache' test runs. Then a cache boost factor was calculated by diving (the number of API calls with cache) / (number of API calls without cache). Each cache test was executed 3 times, with different cache time-to-live values of 1 second, 5 seconds and 0 seconds (eternal cache, no expiration). The rationale is to see what impact different cache expiration/evi...
Post a Comment
Read more

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

A Core Service Java Client

By Unknown
I have seen many times the creation of a .NET client for SDL Tridion's Core Service, but not once a Java client. In .NET / Visual Studio is extremely easy to create the proxy classes based on the service's WSDL. So how hard can it be in Java? The entire code in this example is available in my Google Code project . Which Tool? Doing a bit of research on the multiple ways of creating Java proxy classes for web services left me quite confused as to which framework / utility to use. They are quite a few (AXIS, JAXB, Apache CXF, XFire, NetBeans plugin, IDEA plugin, Eclipse plugin, etc). They seemed to be cumbersome to use, too specific, limited, quirky, buggy, etc. What I wanted was a simple generic too that worked. Enter wsimport.exe ... Generating the Proxies Note: Check out the update post available here  http://yatb.mitza.net/2012/12/java-core-service-trouble-with-datetime.html Wsimport.exe is part of the JDK (mine is located in C:\Progrm Files\Java\jdk1.6.0_33\bin ),...
3 comments
Read more