com.sample.module

Class SampleQueryRewriteTransformer

java.lang.Object

com.sample.module.SampleQueryRewriteTransformer

All Implemented Interfaces:

QueryTransformer, Stage

public class SampleQueryRewriteTransformer
extends Object
implements QueryTransformer

This query transformer shows an example of rewriting a simple table:field query into a complex join.

The example use case is to allow users to search for an author name but have that query get mapped to a first name or last name search. This could be accomplished with include fields in the schema but this method requires no configuration or ingestion changes. In addition, the rewriter will join in all the books for each author as child documents based on authorid.

User query

authors:mike

will be rewritten to

JOIN(AND(table:authors, OR(firstname:mike, lastname:mike)), INNER(table:books, on="authorid"))

Constructor Summary

Constructors

Constructor and Description
SampleQueryRewriteTransformer()

Method Summary

Modifier and Type	Method and Description
String	getChildTableName()
String	getJoinKey()
List<String>	getOrFields()
String	getPrimaryTableName()
List<QueryFeedback>	processQuery(QueryRequest queryRequest) Processes a query by modifying it in-place.
void	setChildTableName(String childTableName)
void	setJoinKey(String joinKey)
void	setOrFields(List<String> orFields)
void	setPrimaryTableName(String primaryTableName)

Methods inherited from class java.lang.Object

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

Constructor Detail

SampleQueryRewriteTransformer

public SampleQueryRewriteTransformer()

Method Detail

processQuery

public List<QueryFeedback> processQuery(QueryRequest queryRequest)
                                 throws AttivioException

Description copied from interface: QueryTransformer

Processes a query by modifying it in-place.

Specified by:

processQuery in interface QueryTransformer

Parameters:

queryRequest - the query request

Returns:

list of feedback or null if no feedback

Throws:

AttivioException

getPrimaryTableName

public String getPrimaryTableName()

setPrimaryTableName

public void setPrimaryTableName(String primaryTableName)

getChildTableName

public String getChildTableName()

setChildTableName

public void setChildTableName(String childTableName)

getJoinKey

public String getJoinKey()

setJoinKey

public void setJoinKey(String joinKey)

getOrFields

public List<String> getOrFields()

setOrFields

public void setOrFields(List<String> orFields)