com.neurosys.modules.etl

Class SearchJPAQueryBuilderTransformer

java.lang.Object

com.neurosys.modules.etl.SearchJPAQueryBuilderTransformer

All Implemented Interfaces:

Serializable, org.apache.commons.collections.Transformer

public class SearchJPAQueryBuilderTransformer
extends Object
implements org.apache.commons.collections.Transformer, Serializable

A Search Query Transformer to map Input in a panel to query terms to construct the database JPA search query. The output of transform(Object) is an Object array of query, params which is a Map of name to value. It accepts a map of FacetMeta or Identifiable or Strings to query input value for the field (FacetMeta). A FacetMeta or Identifiable or String, where multiple DB fields map to the same input, can be comma separated in the FacetMeta.getName() or meta name
Default implementation for RDBMS. TODO: Add unit test case

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	AND_CLAUSE If the input Map has a meta Name with this constant, it will append it with the Join Clause This key maps to the ADN clause raw JPA String
static String	AND_CLAUSE_PARAMS For an And Clause if there are any Params. This key maps to List of Map.Entrys

Constructor Summary

Constructors

Constructor and Description
SearchJPAQueryBuilderTransformer(String entityNameAliasMapping)
SearchJPAQueryBuilderTransformer(String entityNameAliasMapping, String defaultEntityAlias)

Method Summary

Modifier and Type	Method and Description
String	getDefaultEntityAlias() If the field names in FacetMeta dont contain any alias; the defaultEntityAlias will be prefixed.
String	getEntityNameAliasMapping() Example "Product e" and all the FacetMeta.getName()s would use the field name directly or can use p.fieldName If defining a single entity and an alias, check defaultEntityAlias.
String	getJoinClauses() Example: e1.name = e2.name OR e1.id = e2.id
void	setDefaultEntityAlias(String defaultEntityAlias) If the field names in FacetMeta dont contain any alias; the defaultEntityAlias will be prefixed.
void	setEntityNameAliasMapping(String entityNameAliasMapping) Example "Product e" and all the FacetMeta.getName()s would use the field name directly or can use p.fieldName If defining a single entity and an alias, check defaultEntityAlias.
void	setJoinClauses(String joinClauses) Example: e1.name = e2.name OR e1.id = e2.id
Object	transform(Object input)

Methods inherited from class java.lang.Object

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

Field Detail

AND_CLAUSE

public static final String AND_CLAUSE

If the input Map has a meta Name with this constant, it will append it with the Join Clause
This key maps to the ADN clause raw JPA String

See Also:

Constant Field Values

AND_CLAUSE_PARAMS

public static final String AND_CLAUSE_PARAMS

For an And Clause if there are any Params.
This key maps to List of Map.Entrys

See Also:

Constant Field Values

Constructor Detail

SearchJPAQueryBuilderTransformer

public SearchJPAQueryBuilderTransformer(String entityNameAliasMapping)

SearchJPAQueryBuilderTransformer

public SearchJPAQueryBuilderTransformer(String entityNameAliasMapping,
                                        String defaultEntityAlias)

Method Detail

transform

public Object transform(Object input)

Specified by:

transform in interface org.apache.commons.collections.Transformer

getEntityNameAliasMapping

public String getEntityNameAliasMapping()

Example "Product e" and all the FacetMeta.getName()s would use the field name directly or can use p.fieldName If defining a single entity and an alias, check defaultEntityAlias.

setEntityNameAliasMapping

public void setEntityNameAliasMapping(String entityNameAliasMapping)

Example "Product e" and all the FacetMeta.getName()s would use the field name directly or can use p.fieldName If defining a single entity and an alias, check defaultEntityAlias.

getDefaultEntityAlias

public String getDefaultEntityAlias()

If the field names in FacetMeta dont contain any alias; the defaultEntityAlias will be prefixed.

Default value:

is e

setDefaultEntityAlias

public void setDefaultEntityAlias(String defaultEntityAlias)

If the field names in FacetMeta dont contain any alias; the defaultEntityAlias will be prefixed.

Default value:

is e

getJoinClauses

public String getJoinClauses()

Example: e1.name = e2.name OR e1.id = e2.id

setJoinClauses

public void setJoinClauses(String joinClauses)

Example: e1.name = e2.name OR e1.id = e2.id