com.exalead.search.query.prefix

Class DatePrefix

java.lang.Object

com.exalead.search.query.node.NodeVisitor

com.exalead.search.query.prefix.BaseNumericalPrefix

com.exalead.search.query.prefix.DatePrefix

All Implemented Interfaces:

PrefixHandler

Direct Known Subclasses:

DynamicDateFieldPrefix

public class DatePrefix
extends BaseNumericalPrefix

This handler replaces an untransformed PrefixNode containing date leaves by a branch with date nodes targeting a given index field.
The date nodes are Numerical nodes under the format used by the index.

Supports at least the three mandatory HTTP formats (RFC 822, RFC 850, asctime), ISO 8601 formats, and the nglib date format (YYYY/MM/DD-HH:MM:SS), and many other ones.

Nested Class Summary

Nested classes/interfaces inherited from interface com.exalead.search.query.prefix.PrefixHandler

PrefixHandler.ErrorBehaviour, PrefixHandler.NoHooks, PrefixHandler.Phase

Field Summary

Fields inherited from class com.exalead.search.query.prefix.BaseNumericalPrefix

defaultOperator, errorBehaviour, lsb, msb, numop, targetIndexField, useAttributes

Constructor Summary

Constructors

Constructor and Description
DatePrefix(java.lang.String targetIndexField, IndexOptions.NumericalOperator defaultOp, boolean time) Create a date or time prefix handler.
DatePrefix(java.lang.String targetIndexField, IndexOptions.NumericalOperator defaultOp, boolean time, java.lang.String format)

Method Summary

Modifier and Type	Method and Description
protected Node	buildNumericalValueNode(Node node, java.lang.String context, java.lang.String dateValue, IndexOptions indexOptions, IndexOptions.NumericalOperator operator)
Node	handlePrefix(PrefixHandler.Phase phase, PrefixNode node, NodeVisitor parentVisitor, QueryContext queryContext) Handle a given prefix node.
protected RangeNode	makeBoundariesInclusive(RangeNode node) Numerical ranges are for inclusive intervals.

Methods inherited from class com.exalead.search.query.prefix.BaseNumericalPrefix

onDeinit, onInit, onQuery, setErrorBehaviour, setParams

Methods inherited from class com.exalead.search.query.node.NodeVisitor

visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitNary, visitUnary

Methods inherited from class java.lang.Object

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

Constructor Detail

DatePrefix

public DatePrefix(java.lang.String targetIndexField,
                  IndexOptions.NumericalOperator defaultOp,
                  boolean time)

Create a date or time prefix handler.

Parameters:

targetIndexField - The index field to target

defaultOp - Overrides the operator if default ":" is used

time - True if the targeted index field is of type time, false otherwise (type date)

DatePrefix

public DatePrefix(java.lang.String targetIndexField,
                  IndexOptions.NumericalOperator defaultOp,
                  boolean time,
                  java.lang.String format)

Method Detail

buildNumericalValueNode

protected Node buildNumericalValueNode(Node node,
                                       java.lang.String context,
                                       java.lang.String dateValue,
                                       IndexOptions indexOptions,
                                       IndexOptions.NumericalOperator operator)
                                throws QueryProcessingException

Throws:

QueryProcessingException

makeBoundariesInclusive

protected RangeNode makeBoundariesInclusive(RangeNode node)

Numerical ranges are for inclusive intervals. This function transform exclusive operators into inclusive operator and set the value to the first included.

handlePrefix

public Node handlePrefix(PrefixHandler.Phase phase,
                         PrefixNode node,
                         NodeVisitor parentVisitor,
                         QueryContext queryContext)
                  throws QueryProcessingException

Description copied from interface: PrefixHandler

Handle a given prefix node.

Specified by:

handlePrefix in interface PrefixHandler

Overrides:

handlePrefix in class BaseNumericalPrefix

Parameters:

phase - the "Phase" of the prefix handler, indicating how far in the pipeline we are.In the standard chain, 4 phases are defined: PRE_LINGUISTIC, PRE_TRANSFORM, PRE_MAP, POST_MAP

node - The prefix node to handle

parentVisitor - If your handler is not "terminal", ie, if it supports nesting, it should call this visitor to visit the prefix node's content, additionally to performing its work. Warning: this can be null, in that case, you must not delegate.
For example, a "URL" node handler might be terminal (ie, it will "eat" all its content), whereas a "soundlike" handler will not be. It will only set the correct expansion options and pass control to lower prefixes, to support things like: soundslike:(foo OR bar OR text:coin)

queryContext - access to overridable query-related parameters

Throws:

QueryProcessingException