com.neurosys.domain

Class Query<T>

java.lang.Object

com.neurosys.domain.Query<T>

Type Parameters:

T -

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExternalQuery

public class Query<T>
extends Object
implements Serializable

Allow generic queries to represent their corresponding entities.

 The attributes of the object and related object become Query attributes; which can then be used
 for querying their respective entities.
 

Author:

Arjun Dhar

See Also:

Queryable, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Query()
Query(String json)
Query(String json, Class<T> entityClass)
Query(String json, Class<T> entityClass, Map<String,?> paramsTypeMap)
Query(String json, String entityClassName, Map<String,?> paramsTypeMap)
Query(T entity) The Query represents the entity
Query(T entity, PageInfo pageInfo)

Method Summary

Modifier and Type	Method and Description
void	appendWhereExtension(String whereExtension) {setWhereExtension(String) Additionally ; if a whereExtension exists already, this will Append it via an AND
T	getEntity()
Set<String>	getExcludedFields() Set of names of fields whose values will not be included in ResultSet.
String	getFromExtension() Special Strings; if Not null is Appended after the last default entity in FROM clause
List<String>	getIncludedFields() List of field Names that will only be included in the Result Set. Note: included and excluded fields are mutually exclusive (Optional)
Set<String>	getNullSet() Set of names of fields which if null will still be compared against
String	getOrderString() ORDER BY clause without the words 'ORDER BY '
PageInfo	getPageInfo()
Map<String,Object>	getParams() Using Where extension we can put parameters that can be set as objects instead of hard coded strings.
Object	getRelatedAttribute(String attributeName) Deprecated.
Map<String,Object>	getRelatedAttributes() Deprecated.
String	getSelectOverride() If we are using Joins via whereExtension; and say we want the Select to get only data from the Join.
String	getWhereExtension() Special Strings; if Not null is Appended after WHERE or last Query statement. Example(s): "OR ent.fieldName = :fieldValue" "ent.fieldName = :fieldValue" Note: if no conjunction is provided, AND is assumed by default and if there is no Conditions already then its prepended by WHERE in the final SQL
boolean	isIgnoreEntityFieldsInWhere() If true will Not add the Query entity fields to the WHERE clause
void	setEntity(T entity)
void	setExcludedFields(Set<String> excludedFields) Set of names of fields whose values will not be included in ResultSet.
void	setFromExtension(String fromExtension) Special Strings; if Not null is Appended after the last default entity in FROM clause
void	setIgnoreEntityFieldsInWhere(boolean ignoreEntityFields) If true will Not add the Query entity fields to the WHERE clause
void	setIncludedFields(List<String> includedFields) List of field Names that will only be included in the Result Set. Note: included and excluded fields are mutually exclusive (Optional)
void	setNullSet(Set<String> nullSet) Set of names of fields which if null will still be compared against
void	setOrderString(String orderString) ORDER BY clause without the words 'ORDER BY '
void	setPageInfo(PageInfo pageInfo)
void	setParam(String name, Object value) Using Where extension we can put parameters that can be set as objects instead of hard coded strings.
void	setParams(Map<String,Object> params) Using Where extension we can put parameters that can be set as objects instead of hard coded strings.
Query<T>	setRelatedAttribute(String attributeName, Object value) Deprecated.
void	setRelatedAttributes(Map<String,Object> relatedAttributes) Deprecated.
void	setSelectOverride(String selectOverride) If we are using Joins via whereExtension; and say we want the Select to get only data from the Join.
void	setWhereExtension(String whereExtension) Special Strings; if Not null is Appended after WHERE or last Query statement. Example(s): "OR ent.fieldName = :fieldValue" "ent.fieldName = :fieldValue" Note: if no conjunction is provided, AND is assumed by default and if there is no Conditions already then its prepended by WHERE in the final SQL
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Query

public Query()

Query

public Query(String json,
             String entityClassName,
             Map<String,?> paramsTypeMap)

Parameters:

json - as String

entityClassName - as name of the entity type class

paramsTypeMap - as map String, JsonConfig or String. Where key is params and the value is the class name OR JsonConfig

Query

public Query(String json,
             Class<T> entityClass,
             Map<String,?> paramsTypeMap)

Parameters:

json - as String

entityClass - as Class of the main entity type

paramsTypeMap - as map String, JsonConfig or String. Where key is params and the value is the class name OR JsonConfig

Query

public Query(String json,
             Class<T> entityClass)

Query

public Query(String json)

Query

public Query(T entity)

The Query represents the entity

Parameters:

entity -

Query

public Query(T entity,
             PageInfo pageInfo)

Parameters:

entity - as T

pageInfo - as PageInfo

Method Detail

getEntity

public T getEntity()

setEntity

public void setEntity(T entity)

getPageInfo

public PageInfo getPageInfo()

setPageInfo

public void setPageInfo(PageInfo pageInfo)

getOrderString

public String getOrderString()

ORDER BY clause without the words 'ORDER BY '

setOrderString

public void setOrderString(String orderString)

ORDER BY clause without the words 'ORDER BY '

getRelatedAttributes

@Deprecated
public Map<String,Object> getRelatedAttributes()

Deprecated.

setRelatedAttributes

@Deprecated
public void setRelatedAttributes(Map<String,Object> relatedAttributes)

Deprecated.

getExcludedFields

public Set<String> getExcludedFields()

Set of names of fields whose values will not be included in ResultSet. They will be set to null.
Note: The field name is defined strictly by the bean field name and not by any name in Column annotation, if provided.
When Using Excluded Fields, the DAO results maybe sub-optimal as they go through a filter-mapping process usually to produce the desired type of result set from the raw input set.
Note: included and excluded fields are mutually exclusive

setExcludedFields

public void setExcludedFields(Set<String> excludedFields)

Set of names of fields whose values will not be included in ResultSet. They will be set to null.
Note: The field name is defined strictly by the bean field name and not by any name in Column annotation, if provided.
When Using Excluded Fields, the DAO results maybe sub-optimal as they go through a filter-mapping process usually to produce the desired type of result set from the raw input set.
Note: included and excluded fields are mutually exclusive

getIncludedFields

public List<String> getIncludedFields()

List of field Names that will only be included in the Result Set.

Note: included and excluded fields are mutually exclusive (Optional)

setIncludedFields

public void setIncludedFields(List<String> includedFields)

List of field Names that will only be included in the Result Set.

Note: included and excluded fields are mutually exclusive (Optional)

getNullSet

public Set<String> getNullSet()

Set of names of fields which if null will still be compared against

setNullSet

public void setNullSet(Set<String> nullSet)

Set of names of fields which if null will still be compared against

getRelatedAttribute

@Deprecated
public Object getRelatedAttribute(String attributeName)

Deprecated.

setRelatedAttribute

@Deprecated
public Query<T> setRelatedAttribute(String attributeName,
                                                Object value)

Deprecated.

getWhereExtension

public String getWhereExtension()

Special Strings; if Not null is Appended after WHERE or last Query statement.
Example(s): "OR ent.fieldName = :fieldValue"
"ent.fieldName = :fieldValue"
Note: if no conjunction is provided, AND is assumed by default and if there is no Conditions already then its prepended by WHERE in the final SQL

setWhereExtension

public void setWhereExtension(String whereExtension)

Special Strings; if Not null is Appended after WHERE or last Query statement.
Example(s): "OR ent.fieldName = :fieldValue"
"ent.fieldName = :fieldValue"
Note: if no conjunction is provided, AND is assumed by default and if there is no Conditions already then its prepended by WHERE in the final SQL

appendWhereExtension

public void appendWhereExtension(String whereExtension)

{setWhereExtension(String)
Additionally ; if a whereExtension exists already, this will Append it via an AND

getFromExtension

public String getFromExtension()

Special Strings; if Not null is Appended after the last default entity in FROM clause

setFromExtension

public void setFromExtension(String fromExtension)

Special Strings; if Not null is Appended after the last default entity in FROM clause

getParams

public Map<String,Object> getParams()

Using Where extension we can put parameters that can be set as objects instead of hard coded strings.

setParams

public void setParams(Map<String,Object> params)

Using Where extension we can put parameters that can be set as objects instead of hard coded strings.

setParam

public void setParam(String name,
                     Object value)

Using Where extension we can put parameters that can be set as objects instead of hard coded strings.

isIgnoreEntityFieldsInWhere

public boolean isIgnoreEntityFieldsInWhere()

If true will Not add the Query entity fields to the WHERE clause

Default value:

false

setIgnoreEntityFieldsInWhere

public void setIgnoreEntityFieldsInWhere(boolean ignoreEntityFields)

If true will Not add the Query entity fields to the WHERE clause

Default value:

false

getSelectOverride

public String getSelectOverride()

If we are using Joins via whereExtension; and say we want the Select to get only data from the Join.
This excludes the 'SELECT' statement.

Can be null:

true

setSelectOverride

public void setSelectOverride(String selectOverride)

If we are using Joins via whereExtension; and say we want the Select to get only data from the Join.
This excludes the 'SELECT' statement.

Can be null:

true

toString

public String toString()

Overrides:

toString in class Object