Package eu.clarin.sru.server

Class CQLQueryParser

java.lang.Object

eu.clarin.sru.server.CQLQueryParser

All Implemented Interfaces:

SRUQueryParser<org.z3950.zing.cql.CQLNode>

public final class CQLQueryParser
extends Object
implements SRUQueryParser<org.z3950.zing.cql.CQLNode>

Default query parser to parse CQL.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CQLQueryParser.CQLQuery

Constructor Summary

Constructors

Constructor	Description
CQLQueryParser()

Method Summary

Modifier and Type	Method	Description
List<String>	getQueryParameterNames()	Get the list of query parameters.
String	getQueryType()	Get the short name for supported query, e.g.
String	getQueryTypeDefintion()	The URI for the for the query type’s definition.
SRUQuery<org.z3950.zing.cql.CQLNode>	parseQuery(SRUVersion version, Map<String,String> parameters, SRUDiagnosticList diagnostics)	Parse a query into an abstract syntax tree
boolean	supportsVersion(SRUVersion version)	Check if query is supported by a specific version of SRU/CQL

Methods inherited from class java.lang.Object

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

Constructor Detail

CQLQueryParser

public CQLQueryParser()

Method Detail

getQueryType

public String getQueryType()

Description copied from interface: SRUQueryParser

Get the short name for supported query, e.g. "cql".

Specified by:

getQueryType in interface SRUQueryParser<org.z3950.zing.cql.CQLNode>

Returns:

the query short name

supportsVersion

public boolean supportsVersion(SRUVersion version)

Description copied from interface: SRUQueryParser

Check if query is supported by a specific version of SRU/CQL

Specified by:

supportsVersion in interface SRUQueryParser<org.z3950.zing.cql.CQLNode>

Parameters:

version - the version

Returns:

true if version is supported, false otherwise

getQueryTypeDefintion

public String getQueryTypeDefintion()

Description copied from interface: SRUQueryParser

The URI for the for the query type’s definition.

Specified by:

getQueryTypeDefintion in interface SRUQueryParser<org.z3950.zing.cql.CQLNode>

Returns:

the URI for the for the query type’s definition.

getQueryParameterNames

public List<String> getQueryParameterNames()

Description copied from interface: SRUQueryParser

Get the list of query parameters.

Specified by:

getQueryParameterNames in interface SRUQueryParser<org.z3950.zing.cql.CQLNode>

Returns:

the list of query parameters names.

parseQuery

public SRUQuery<org.z3950.zing.cql.CQLNode> parseQuery(SRUVersion version,
                                                       Map<String,String> parameters,
                                                       SRUDiagnosticList diagnostics)

Description copied from interface: SRUQueryParser

Parse a query into an abstract syntax tree

Specified by:

parseQuery in interface SRUQueryParser<org.z3950.zing.cql.CQLNode>

Parameters:

version - the SRU version the request was made

parameters - the request parameters containing the query (@see SRUQueryParser.getQueryParameterNames()

diagnostics - a SRUDiagnosticList for storing fatal and non-fatal diagnostics

Returns:

the parsed query or null if the query could not be parsed