eu.dnetlib.functionality.cql

Class CqlTranslatorImpl

java.lang.Object

eu.dnetlib.functionality.cql.CqlTranslatorImpl

All Implemented Interfaces:

CqlTranslator

public class CqlTranslatorImpl
extends Object
implements CqlTranslator

This class provides a simple cql-to-lucene translator TODO implement translation distinguishing org.apache.lucene.search.TermRangeQuery and org.apache.lucene.search.NumericRangeQuery

Author:

claudio

Constructor Summary

Constructors

Constructor and Description
CqlTranslatorImpl()

Method Summary

Modifier and Type	Method and Description
TranslatedQuery	getTranslatedQuery(org.z3950.zing.cql.CQLNode queryRoot, CqlValueTransformerMap valueTransformerMap) method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.
TranslatedQuery	getTranslatedQuery(org.z3950.zing.cql.CQLNode queryRoot, CqlValueTransformerMap valueTransformerMap, Map<String,List<String>> options, com.google.common.collect.BiMap<String,String> aliases, Map<String,String> weights) method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.
TranslatedQuery	getTranslatedQuery(String cqlQuery) method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.
TranslatedQuery	getTranslatedQuery(String cqlQuery, CqlValueTransformerMap valueTransformerMap) method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.
TranslatedQuery	getTranslatedQuery(String cqlQuery, CqlValueTransformerMap valueTransformerMap, Map<String,List<String>> options) method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.
TranslatedQuery	getTranslatedQuery(String cqlQuery, Map<String,List<String>> options) method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.
protected static org.z3950.zing.cql.CQLNode	parse(String query) helper parsing method
String	toLucene(org.z3950.zing.cql.CQLNode queryRoot) main translator method
String	toLucene(org.z3950.zing.cql.CQLNode queryRoot, CqlValueTransformerMap valueTransformerMap) main translator method
String	toLucene(org.z3950.zing.cql.CQLNode queryRoot, CqlValueTransformerMap valueTransformerMap, Map<String,List<String>> options) main translator method
String	toLucene(String queryRoot) CqlTranslator.toLucene(String)
String	toLucene(String queryRoot, CqlValueTransformerMap valueTransformerMap) main translator method
String	toLucene(String queryRoot, Map<String,List<String>> options) main translator method
org.bson.conversions.Bson	toMongo(String cqlQuery) Translates a cql query in a mongodb query.

Methods inherited from class java.lang.Object

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

Constructor Detail

CqlTranslatorImpl

public CqlTranslatorImpl()

Method Detail

toLucene

public String toLucene(String queryRoot)
                throws org.z3950.zing.cql.CQLParseException,
                       IOException

CqlTranslator.toLucene(String)

Specified by:

toLucene in interface CqlTranslator

Parameters:

queryRoot - String representation of the cql query

Returns:

String representing the query in the lucene syntax

Throws:

org.z3950.zing.cql.CQLParseException

IOException

toLucene

public String toLucene(String queryRoot,
                       Map<String,List<String>> options)
                throws org.z3950.zing.cql.CQLParseException,
                       IOException

Description copied from interface: CqlTranslator

main translator method

Specified by:

toLucene in interface CqlTranslator

Parameters:

queryRoot - String representation of the cql query

Returns:

String representing the query in the lucene syntax

Throws:

org.z3950.zing.cql.CQLParseException

IOException

toLucene

public String toLucene(String queryRoot,
                       CqlValueTransformerMap valueTransformerMap)
                throws org.z3950.zing.cql.CQLParseException,
                       IOException

Description copied from interface: CqlTranslator

main translator method

Specified by:

toLucene in interface CqlTranslator

Parameters:

queryRoot - String representation of the cql query

valueTransformerMap - callbacks which allow us to normalize field values when we know about them

Returns:

String representing the query in the lucene syntax

Throws:

org.z3950.zing.cql.CQLParseException

IOException

toLucene

public String toLucene(org.z3950.zing.cql.CQLNode queryRoot)
                throws org.z3950.zing.cql.CQLParseException,
                       IOException

Description copied from interface: CqlTranslator

main translator method

Specified by:

toLucene in interface CqlTranslator

Parameters:

queryRoot - Pre-parsed representation of the cql query

Returns:

String representing the query in the lucene syntax

Throws:

org.z3950.zing.cql.CQLParseException

IOException

toLucene

public String toLucene(org.z3950.zing.cql.CQLNode queryRoot,
                       CqlValueTransformerMap valueTransformerMap)
                throws org.z3950.zing.cql.CQLParseException,
                       IOException

Description copied from interface: CqlTranslator

main translator method

Specified by:

toLucene in interface CqlTranslator

Parameters:

queryRoot - Pre-parsed representation of the cql query

valueTransformerMap - callbacks which allow us to normalize field values when we know about them

Returns:

String representing the query in the lucene syntax

Throws:

org.z3950.zing.cql.CQLParseException

IOException

toLucene

public String toLucene(org.z3950.zing.cql.CQLNode queryRoot,
                       CqlValueTransformerMap valueTransformerMap,
                       Map<String,List<String>> options)
                throws org.z3950.zing.cql.CQLParseException,
                       IOException

Description copied from interface: CqlTranslator

main translator method

Specified by:

toLucene in interface CqlTranslator

Parameters:

queryRoot - Pre-parsed representation of the cql query

valueTransformerMap - callbacks which allow us to normalize field values when we know about them

options - options that modify the behavior of cql parsing

Returns:

String representing the query in the lucene syntax

Throws:

org.z3950.zing.cql.CQLParseException

IOException

getTranslatedQuery

public TranslatedQuery getTranslatedQuery(org.z3950.zing.cql.CQLNode queryRoot,
                                          CqlValueTransformerMap valueTransformerMap)
                                   throws org.z3950.zing.cql.CQLParseException,
                                          IOException

Description copied from interface: CqlTranslator

method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.

Specified by:

getTranslatedQuery in interface CqlTranslator

Parameters:

queryRoot - Pre-parsed representation of the cql query

valueTransformerMap - callbacks which allow us to normalize field values when we know about them

Returns:

TranslatedQuery object which contains the translated query and the cql-related options

Throws:

org.z3950.zing.cql.CQLParseException

IOException

getTranslatedQuery

public TranslatedQuery getTranslatedQuery(org.z3950.zing.cql.CQLNode queryRoot,
                                          CqlValueTransformerMap valueTransformerMap,
                                          Map<String,List<String>> options,
                                          com.google.common.collect.BiMap<String,String> aliases,
                                          Map<String,String> weights)
                                   throws org.z3950.zing.cql.CQLParseException,
                                          IOException

Description copied from interface: CqlTranslator

method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.

Specified by:

getTranslatedQuery in interface CqlTranslator

Parameters:

queryRoot - Pre-parsed representation of the cql query

valueTransformerMap - callbacks which allow us to normalize field values when we know about them

options - options that modify the behavior of cql parsing

Returns:

TranslatedQuery object which contains the translated query and the cql-related options

Throws:

org.z3950.zing.cql.CQLParseException

IOException

getTranslatedQuery

public TranslatedQuery getTranslatedQuery(String cqlQuery)
                                   throws org.z3950.zing.cql.CQLParseException,
                                          IOException

Description copied from interface: CqlTranslator

method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.

Specified by:

getTranslatedQuery in interface CqlTranslator

Returns:

TranslatedQuery object which contains the translated query and the cql-related options

Throws:

org.z3950.zing.cql.CQLParseException

IOException

getTranslatedQuery

public TranslatedQuery getTranslatedQuery(String cqlQuery,
                                          Map<String,List<String>> options)
                                   throws org.z3950.zing.cql.CQLParseException,
                                          IOException

Description copied from interface: CqlTranslator

method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.

Specified by:

getTranslatedQuery in interface CqlTranslator

options - options that modify the behavior of cql parsing

Returns:

TranslatedQuery object which contains the translated query and the cql-related options

Throws:

org.z3950.zing.cql.CQLParseException

IOException

getTranslatedQuery

public TranslatedQuery getTranslatedQuery(String cqlQuery,
                                          CqlValueTransformerMap valueTransformerMap)
                                   throws org.z3950.zing.cql.CQLParseException,
                                          IOException

Description copied from interface: CqlTranslator

method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.

Specified by:

getTranslatedQuery in interface CqlTranslator

valueTransformerMap - callbacks which allow us to normalize field values when we know about them

Returns:

TranslatedQuery object which contains the translated query and the cql-related options

Throws:

org.z3950.zing.cql.CQLParseException

IOException

getTranslatedQuery

public TranslatedQuery getTranslatedQuery(String cqlQuery,
                                          CqlValueTransformerMap valueTransformerMap,
                                          Map<String,List<String>> options)
                                   throws org.z3950.zing.cql.CQLParseException,
                                          IOException

Description copied from interface: CqlTranslator

method performs the translation and returns a TranslatedQuery object which contains the translated query and the cql-related options.

Specified by:

getTranslatedQuery in interface CqlTranslator

valueTransformerMap - callbacks which allow us to normalize field values when we know about them

options - options that modify the behavior of cql parsing

Returns:

TranslatedQuery object which contains the translated query and the cql-related options

Throws:

org.z3950.zing.cql.CQLParseException

IOException

toMongo

public org.bson.conversions.Bson toMongo(String cqlQuery)
                                  throws IOException,
                                         org.z3950.zing.cql.CQLParseException

Description copied from interface: CqlTranslator

Translates a cql query in a mongodb query.

Specified by:

toMongo in interface CqlTranslator

Parameters:

cqlQuery - the query to be translated.

Returns:

a mongodb query expressed as org.bson.conversions.Bson object.

Throws:

IOException

org.z3950.zing.cql.CQLParseException

parse

protected static org.z3950.zing.cql.CQLNode parse(String query)
                                           throws org.z3950.zing.cql.CQLParseException,
                                                  IOException

helper parsing method

Parameters:

query -

Returns:

Throws:

org.z3950.zing.cql.CQLParseException

IOException