lux.query

Class SpanMatchAll

java.lang.Object

lux.query.ParseableQuery

lux.query.SpanMatchAll

public class SpanMatchAll
extends ParseableQuery

This query exists only to serve as a placeholder in an intermediate query compilation phase. It prints out a query designed to match all documents in surround query parser language; because there is no built-in match-all query in that dialect, it prints term query matching the start of a path in the lux_path field, which always begins with a fixed token: {}. TODO: determine how much efficiency is lost by using a SpanTerm query rather than a real MatchAllDocsQuery.

Constructor Summary

Constructors

Constructor and Description
SpanMatchAll()

Method Summary

Methods

Modifier and Type	Method and Description
static SpanMatchAll	getInstance()
boolean	isSpan()
String	toQueryString(String defaultField, IndexConfiguration config)
ElementConstructor	toXmlNode(String field, IndexConfiguration config)

Methods inherited from class lux.query.ParseableQuery

toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanMatchAll

public SpanMatchAll()

Method Detail

getInstance

public static final SpanMatchAll getInstance()

toXmlNode

public ElementConstructor toXmlNode(String field,
                           IndexConfiguration config)

Specified by:

toXmlNode in class ParseableQuery

Parameters:

field - the prevailing field in the query's surrounding context.

config - the index configuration

Returns:

an xml object representation of the query, in a format suitable for parsing by one the Lucene XML Query Parser

toQueryString

public String toQueryString(String defaultField,
                   IndexConfiguration config)

Specified by:

toQueryString in class ParseableQuery

Parameters:

defaultField - the prevailing field in the query's surrounding context.

config - the index configuration

Returns:

a String representation of the query, in the Surround Query Parser dialect

isSpan

public boolean isSpan()

Overrides:

isSpan in class ParseableQuery