eu.dnetlib.functionality.cql

Interface CqlTranslator

All Known Implementing Classes:

CqlTranslatorImpl

public interface CqlTranslator

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.
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) main translator method
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.

Method Detail

toLucene

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

main translator method

Parameters:

queryRoot - String representation of the cql query

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

toLucene

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

main translator method

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

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

main translator method

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

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

main translator method

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

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

main translator method

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

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

main translator method

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

toMongo

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

Translates a cql query in a mongodb query.

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