Package com.hades.builder.sqlCommand.clauseBuilder.filter

Class FilterClause<E extends EntityType>

java.lang.Object

com.hades.builder.sqlCommand.clauseBuilder.ClauseElements

com.hades.builder.sqlCommand.clauseBuilder.filter.FilterClause<E>

All Implemented Interfaces:

SQLFilterClause<E>

public class FilterClause<E extends EntityType>
extends ClauseElements
implements SQLFilterClause<E>

there is 2 way to create an object of FilterClause

1. create object with constructor -> FilterClause(Class) in which developer must pass Class object of entity type
2. create Object with constructor -> FilterClause() ()} in which developer must create Class instance by calling createInstance(EntityType)

Author:

alireza_bayat created on 10/19/21

See Also:

• ClauseElements
• SQLFilterClause

Field Summary

Fields inherited from class com.hades.builder.sqlCommand.clauseBuilder.ClauseElements

clause

Constructor Summary

Constructors

Constructor	Description
FilterClause()
FilterClause(Class<?> clazz)	pass entity class object as param

Method Summary

Modifier and Type	Method	Description
FilterClause<E>	and()	to append `and` key word in where clause
SQLFilterClause<E>	and(String customQuery)	to append `and` key word and let some filter to be run in parentheses
SQLFilterClause<E>	between(String field, Object firstValue, Object secondValue)
FilterClause<E>	createInstance(E e)	create instance Class of given entity to be used in filter clauses
SQLFilterClause<E>	customClause(String customClause)	any customized filter that is not supported by main SQLFilterClause can be specifies by this function
FilterClause<E>	equal(Selection selection, Object filterPhrase)	equal operand in standard query language main purpose is to set equality operand between given field and filterPhrase
FilterClause<E>	equal(String field, Object filterPhrase)	equal operand in standard query language main purpose is to set equality operand between given field and filterPhrase
SQLFilterClause<E>	exists(String customQuery)	exists operand in standard language
SQLFilterClause<E>	in(String field, Object... items)	In operand in standard language
SQLFilterClause<E>	in(String field, String customQuery)	In operand in standard language
SQLFilterClause<E>	innerSelect()
SQLFilterClause<E>	like(String field, String matchString)	like operand in standard query language to generate like phrase in between given fields
SQLFilterClause<E>	not()	to append `not` key word in where clause
SQLFilterClause<E>	not(String customQuery)	to append `not` key word and let some filter to be run in parentheses
SQLFilterClause<E>	notEqual(Selection selection, Object filterPhrase)	equal operand in standard query language main purpose is to set equality operand between given field and filterPhrase
SQLFilterClause<E>	notEqual(String field, Object filterPhrase)	not equal operand in standard query language main purpose is to set not equality operand between given field and filterPhrase
SQLFilterClause<E>	notExists(String customQuery)	not exists operand in standard language
SQLFilterClause<E>	notIn(String field, Object... items)	notIn operand in standard language
SQLFilterClause<E>	notIn(String field, String customQuery)	notIn operand in standard language
FilterClause<E>	or()	to append `or` key word in where clause
SQLFilterClause<E>	or(String customQuery)	to append `or` key word and let some filter to be run in parentheses

Methods inherited from class com.hades.builder.sqlCommand.clauseBuilder.ClauseElements

getClause, setClause

Methods inherited from class java.lang.Object

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

Constructor Details

FilterClause

public FilterClause(Class<?> clazz)

pass entity class object as param

FilterClause

public FilterClause()

Method Details

createInstance

public FilterClause<E> createInstance(E e)

Description copied from interface: SQLFilterClause

create instance Class of given entity to be used in filter clauses

probably not needed in second approach

Specified by:

createInstance in interface SQLFilterClause<E extends EntityType>

Parameters:

e - passed entity object

Returns:

SQLFilterClause object

equal

public FilterClause<E> equal(String field,
 Object filterPhrase)

Description copied from interface: SQLFilterClause

equal operand in standard query language main purpose is to set equality operand between given field and filterPhrase

Specified by:

equal in interface SQLFilterClause<E extends EntityType>

Parameters:

field - field name which must be present as Column.name() in entity class

filterPhrase - filtered value in field

Returns:

SQLFilterClause object

equal

public FilterClause<E> equal(Selection selection,
 Object filterPhrase)

Description copied from interface: SQLFilterClause

equal operand in standard query language main purpose is to set equality operand between given field and filterPhrase

Specified by:

equal in interface SQLFilterClause<E extends EntityType>

Parameters:

selection - field name which must be present as Column.name() in entity class stored in Selection.fieldName

filterPhrase - filtered value in field

Returns:

SQLFilterClause object

notEqual

public SQLFilterClause<E> notEqual(String field,
 Object filterPhrase)

Description copied from interface: SQLFilterClause

not equal operand in standard query language main purpose is to set not equality operand between given field and filterPhrase

Specified by:

notEqual in interface SQLFilterClause<E extends EntityType>

Parameters:

field - field name which must be present as Column.name() in entity class

filterPhrase - filtered value in field

Returns:

SQLFilterClause object

notEqual

public SQLFilterClause<E> notEqual(Selection selection,
 Object filterPhrase)

Description copied from interface: SQLFilterClause

equal operand in standard query language main purpose is to set equality operand between given field and filterPhrase

Specified by:

notEqual in interface SQLFilterClause<E extends EntityType>

Parameters:

selection - field name which must be present as Column.name() in entity class stored in Selection.fieldName

filterPhrase - filtered value in field

Returns:

SQLFilterClause object

and

public FilterClause<E> and()

Description copied from interface: SQLFilterClause

to append `and` key word in where clause

Specified by:

and in interface SQLFilterClause<E extends EntityType>

and

public SQLFilterClause<E> and(String customQuery)

Description copied from interface: SQLFilterClause

to append `and` key word and let some filter to be run in parentheses

Specified by:

and in interface SQLFilterClause<E extends EntityType>

or

public FilterClause<E> or()

Description copied from interface: SQLFilterClause

to append `or` key word in where clause

Specified by:

or in interface SQLFilterClause<E extends EntityType>

or

public SQLFilterClause<E> or(String customQuery)

Description copied from interface: SQLFilterClause

to append `or` key word and let some filter to be run in parentheses

Specified by:

or in interface SQLFilterClause<E extends EntityType>

not

public SQLFilterClause<E> not()

Description copied from interface: SQLFilterClause

to append `not` key word in where clause

Specified by:

not in interface SQLFilterClause<E extends EntityType>

not

public SQLFilterClause<E> not(String customQuery)

Description copied from interface: SQLFilterClause

to append `not` key word and let some filter to be run in parentheses

Specified by:

not in interface SQLFilterClause<E extends EntityType>

like

public SQLFilterClause<E> like(String field,
 String matchString)

Description copied from interface: SQLFilterClause

like operand in standard query language to generate like phrase in between given fields

Specified by:

like in interface SQLFilterClause<E extends EntityType>

Parameters:

field - field name which must be present as Column.name()

matchString - filtered value in field

Returns:

SQLFilterClause object

between

public SQLFilterClause<E> between(String field,
 Object firstValue,
 Object secondValue)

Specified by:

between in interface SQLFilterClause<E extends EntityType>

in

public SQLFilterClause<E> in(String field,
 Object... items)

Description copied from interface: SQLFilterClause

In operand in standard language

Specified by:

in in interface SQLFilterClause<E extends EntityType>

Parameters:

field - field name which must be present as Column.name() in entity class

items - varargs of all the objects that will appear in final clause

Returns:

SQLFilterClause object

in

public SQLFilterClause<E> in(String field,
 String customQuery)

Description copied from interface: SQLFilterClause

In operand in standard language

Specified by:

in in interface SQLFilterClause<E extends EntityType>

Parameters:

field - field name which must be present as Column.name() in entity class

customQuery - custom objects that will appear in final clause

Returns:

SQLFilterClause object

notIn

public SQLFilterClause<E> notIn(String field,
 Object... items)

Description copied from interface: SQLFilterClause

notIn operand in standard language

Specified by:

notIn in interface SQLFilterClause<E extends EntityType>

Parameters:

field - field name which must be present as Column.name() in entity class

items - varargs of all the objects that will appear in final clause

Returns:

SQLFilterClause object

notIn

public SQLFilterClause<E> notIn(String field,
 String customQuery)

Description copied from interface: SQLFilterClause

notIn operand in standard language

Specified by:

notIn in interface SQLFilterClause<E extends EntityType>

Parameters:

field - field name which must be present as Column.name() in entity class

customQuery - custom objects that will appear in final clause

Returns:

SQLFilterClause object

exists

public SQLFilterClause<E> exists(String customQuery)

Description copied from interface: SQLFilterClause

exists operand in standard language

Specified by:

exists in interface SQLFilterClause<E extends EntityType>

Parameters:

customQuery - exact query will appear in final query

Returns:

SQLFilterClause object

notExists

public SQLFilterClause<E> notExists(String customQuery)

Description copied from interface: SQLFilterClause

not exists operand in standard language

Specified by:

notExists in interface SQLFilterClause<E extends EntityType>

Parameters:

customQuery - exact query will be appeared in final query

Returns:

SQLFilterClause object

innerSelect

public SQLFilterClause<E> innerSelect()

Specified by:

innerSelect in interface SQLFilterClause<E extends EntityType>

customClause

public SQLFilterClause<E> customClause(String customClause)

Description copied from interface: SQLFilterClause

any customized filter that is not supported by main SQLFilterClause can be specifies by this function

Specified by:

customClause in interface SQLFilterClause<E extends EntityType>

Parameters:

customClause - any customized filter clause

Returns:

SQLFilterClause object