com.endeca.portal.lql

Class DateLQLBuilder

java.lang.Object

com.endeca.portal.lql.DateLQLBuilder

public class DateLQLBuilder
extends java.lang.Object

Used to help in building the EQL when the attribute with date type involved especially when date dimension exists. Here is an example of function calls around the date attribute across the EQL interaction processes: Query Process: Fetch alias: String alias = DateLQLBuilder.getAliasForDateAttribute(semanticView, dateAttribute, dateParts); Make select: Select s = DateLQLBuilder.makeDateAttrSelect(request.getLocale(), semanticView, dateAttribute, alias, dateParts); Make group by: groupingSet.getGroupBys().add(LQLBuilder.makeGroupBy(alias)); Make sort by: OrderBy orderBy = LQLBuilder.makeOrderBy(alias, isAsending); obl.getOrderBys().add(orderBy); Result Process: DateFilterSpec dateFilterSpec = DateLQLBuilder.getDateFilterSpecFromStringIgnoreTimeZone(dateAttribute.getDatePartCombo(), rawValue); Note: Contract a DateFilterSpec object which is the unified interface for date refinement. Record Details Link(adding the additional having clause during Query Process): DateFilterSpec dateFilterSpec = jacksonMapper.readValue(dateFilterSpecStr, DateFilterSpec.class); ExpressionBase datetimeExpression = DateLQLBuilder.makeDateTimeExprFromDateFilterSpec(dateFilterSpec); havingFilter = LQLBuilder.makeEquals(alias, datetimeExpression, semanticView, request.getLocale());

Author:

Endeca Technologies, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DateLQLBuilder.DatePattern Enum detailing date pattern usable in the string connections

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONNECTOR_SEPARATOR
static java.lang.String	DATE_PATTERN_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
DateLQLBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	getAliasForDateAttribute(SemanticView semanticView, java.lang.String attributeName, java.util.List<DatePart> dateParts) Get the alias for the date time attribute.
static DateFilterSpec	getDateFilterSpecFromStringIgnoreTimeZone(java.util.List<DatePart> dateParts, java.lang.String rawValue) Generate a DateFilterSpec object by the given rawValue and the date parts settings
static com.endeca.mdex.eql_parser.types.Select	makeDateAttrSelect(java.util.Locale currentLocale, SemanticView semanticView, java.lang.String attributeName, java.lang.String alias, java.util.List<DatePart> dateParts) Convenience function to create a new LQL Select object that generate a TO_DATETIME function according to the date part settings on the attribute.
static com.endeca.mdex.eql_parser.types.ExpressionBase	makeDateTimeExpr(java.util.Locale currentLocale, SemanticView semanticView, java.lang.String attributeName, java.util.List<DatePart> dateParts) Convenience function to create a new LQL Expression object that generate a TO_DATETIME function according to the date part settings on the attribute.
static com.endeca.mdex.eql_parser.types.ExpressionBase	makeDateTimeExprFromDateFilterSpec(DateFilterSpec dateFilterSpec) Create a TO_DATETIME expression by the given DateFilterSpec object
static com.endeca.mdex.eql_parser.types.ExpressionBase	makeToDateTimeExpression(com.endeca.mdex.eql_parser.types.ExpressionBase year, com.endeca.mdex.eql_parser.types.ExpressionBase month, com.endeca.mdex.eql_parser.types.ExpressionBase dayOfMonth, com.endeca.mdex.eql_parser.types.ExpressionBase hour, com.endeca.mdex.eql_parser.types.ExpressionBase minute, com.endeca.mdex.eql_parser.types.ExpressionBase second, com.endeca.mdex.eql_parser.types.ExpressionBase millisecond) Create a EQL TO_DATETIME expression with the given date/time grains.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATE_PATTERN_SEPARATOR

public static final java.lang.String DATE_PATTERN_SEPARATOR

See Also:

Constant Field Values

CONNECTOR_SEPARATOR

public static final java.lang.String CONNECTOR_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

DateLQLBuilder

public DateLQLBuilder()

Method Detail

makeDateAttrSelect

public static com.endeca.mdex.eql_parser.types.Select makeDateAttrSelect(java.util.Locale currentLocale,
                                                         SemanticView semanticView,
                                                         java.lang.String attributeName,
                                                         java.lang.String alias,
                                                         java.util.List<DatePart> dateParts)

Convenience function to create a new LQL Select object that generate a TO_DATETIME function according to the date part settings on the attribute. The TO_DATETIME function will follow such interface signatures: TO_DATETIME(, , , , , , ) For the unspecified date part, a default int value will be used instead. (e.g. The date part settings is "Year-Month-Day" then the generated EQL function is like : "TO_DATETIME(EXTRACT(attribute, YEAR), EXTRACT(attribute, MONTH), EXTRACT(attribute, DAY), defaultValue, defaultValue, defaultValue, defaultValue)"

Parameters:

currentLocale - Locale

semanticView - SemanticView

attributeName - String

alias - String

dateParts - List

Returns:

LQL Select object can be added to an LQL Statement's select list

makeDateTimeExpr

public static com.endeca.mdex.eql_parser.types.ExpressionBase makeDateTimeExpr(java.util.Locale currentLocale,
                                                               SemanticView semanticView,
                                                               java.lang.String attributeName,
                                                               java.util.List<DatePart> dateParts)

Convenience function to create a new LQL Expression object that generate a TO_DATETIME function according to the date part settings on the attribute. The TO_DATETIME function will follow such interface signatures: TO_DATETIME(, , , , , , ) For the unspecified date part, a default int value will be used instead. (e.g. The date part settings is "Year-Month-Day" then the generated EQL function is like : "TO_DATETIME(EXTRACT(attribute, YEAR), EXTRACT(attribute, MONTH), EXTRACT(attribute, DAY), defaultValue, defaultValue, defaultValue, defaultValue)"

Parameters:

currentLocale - Locale

semanticView - SemanticView

attributeName - String

alias - String

dateParts - List

Returns:

LQL Expression object

makeToDateTimeExpression

public static com.endeca.mdex.eql_parser.types.ExpressionBase makeToDateTimeExpression(com.endeca.mdex.eql_parser.types.ExpressionBase year,
                                                                       com.endeca.mdex.eql_parser.types.ExpressionBase month,
                                                                       com.endeca.mdex.eql_parser.types.ExpressionBase dayOfMonth,
                                                                       com.endeca.mdex.eql_parser.types.ExpressionBase hour,
                                                                       com.endeca.mdex.eql_parser.types.ExpressionBase minute,
                                                                       com.endeca.mdex.eql_parser.types.ExpressionBase second,
                                                                       com.endeca.mdex.eql_parser.types.ExpressionBase millisecond)

Create a EQL TO_DATETIME expression with the given date/time grains. It will follow such interface signatures: TO_DATETIME(, , , , , , )

Parameters:

year -

month -

dayOfMonth -

hour -

minute -

second -

millisecond -

Returns:

TO_DATETIME expression

getAliasForDateAttribute

public static java.lang.String getAliasForDateAttribute(SemanticView semanticView,
                                        java.lang.String attributeName,
                                        java.util.List<DatePart> dateParts)

Get the alias for the date time attribute. The alias will be used in group by, sorting, and the match key for in result process.

Parameters:

semanticView - SemanticView

attributeName - String

dateParts - List

Returns:

String

getDateFilterSpecFromStringIgnoreTimeZone

public static DateFilterSpec getDateFilterSpecFromStringIgnoreTimeZone(java.util.List<DatePart> dateParts,
                                                       java.lang.String rawValue)

Generate a DateFilterSpec object by the given rawValue and the date parts settings

Parameters:

dateParts - List

rawValue - String

Returns:

DateFilterSpec

makeDateTimeExprFromDateFilterSpec

public static com.endeca.mdex.eql_parser.types.ExpressionBase makeDateTimeExprFromDateFilterSpec(DateFilterSpec dateFilterSpec)

Create a TO_DATETIME expression by the given DateFilterSpec object

Parameters:

dateFilterSpec - DateFilterSpec

Returns:

TO_DATETIME expression