org.gecko.emf.repository.query

Interface IQueryBuilder

All Known Implementing Classes:

AbstractQueryBuilder

public interface IQueryBuilder

Builder interface to create queries.

Since:

26.07.2017

Field Summary

Fields

Modifier and Type	Field and Description
static int	QUERY_TYPE_ALL
static int	QUERY_TYPE_AND
static int	QUERY_TYPE_IN
static int	QUERY_TYPE_KEY_VALUE
static int	QUERY_TYPE_OR
static int	QUERY_TYPE_RANGE

Method Summary

Modifier and Type	Method and Description
IQueryBuilder	allQuery() Create a get all query
IQueryBuilder	and(IQuery... queries) Sets an AND between two queries
IQuery	build() Builds the IQuery from the given parameters
IQueryBuilder	column(EAttribute attribute) Sets the name of the column as EAttribute
IQueryBuilder	endValue(java.lang.Object endValue) Sets the end index
IQueryBuilder	endValue(java.lang.Object endValue, boolean include) Sets the end index
IQueryBuilder	in(java.util.List<java.lang.Object> valueList) Creates a in-query
IQueryBuilder	in(java.lang.Object... values) Creates a in-query
IQueryBuilder	limit(long maxEntries) Limits the result set to the given values.
IQueryBuilder	or(IQuery... queries) Sets an OR between two queries
IQueryBuilder	projectionPath(EStructuralFeature... referencePath) Sets a reference path for the projection
IQueryBuilder	rangeQuery() Create a range query
IQueryBuilder	simpleValue(java.lang.Object value) Sets the value
IQueryBuilder	skip(long skipEntries) Limits the result set to start with given skip'th element.
IQueryBuilder	sort(EAttribute field, SortType sortType) Provides sorting for the given attribute
IQueryBuilder	startValue(java.lang.Object startValue) Sets the start index
IQueryBuilder	startValue(java.lang.Object startValue, boolean include) Sets the start index

Field Detail

QUERY_TYPE_ALL

static final int QUERY_TYPE_ALL

See Also:

Constant Field Values

QUERY_TYPE_RANGE

static final int QUERY_TYPE_RANGE

See Also:

Constant Field Values

QUERY_TYPE_AND

static final int QUERY_TYPE_AND

See Also:

Constant Field Values

QUERY_TYPE_OR

static final int QUERY_TYPE_OR

See Also:

Constant Field Values

QUERY_TYPE_KEY_VALUE

static final int QUERY_TYPE_KEY_VALUE

See Also:

Constant Field Values

QUERY_TYPE_IN

static final int QUERY_TYPE_IN

See Also:

Constant Field Values

Method Detail

build

IQuery build()

Builds the IQuery from the given parameters

Returns:

the IQuery from the given parameters

limit

IQueryBuilder limit(long maxEntries)

Limits the result set to the given values. For values <= 0 the limit means all entries

Parameters:

maxEntries - the number of entries

Returns:

the IQueryBuilder instance

skip

IQueryBuilder skip(long skipEntries)

Limits the result set to start with given skip'th element. For values <= 0 the skip means all entries from index 0

Parameters:

skipEntries - the number of entries to skip

Returns:

the IQueryBuilder instance

sort

IQueryBuilder sort(EAttribute field,
                   SortType sortType)

Provides sorting for the given attribute

Parameters:

field - the attribute to be sorted

sortType - ASCENDING or DESCENDING

Returns:

the IQueryBuilder instance

rangeQuery

IQueryBuilder rangeQuery()

Create a range query

Returns:

the IQueryBuilder instance

allQuery

IQueryBuilder allQuery()

Create a get all query

Returns:

the IQueryBuilder instance

column

IQueryBuilder column(EAttribute attribute)

Sets the name of the column as EAttribute

Parameters:

attribute - the column name to set

Returns:

the IQueryBuilder instance

startValue

IQueryBuilder startValue(java.lang.Object startValue)

Sets the start index

Parameters:

startValue - the start index

Returns:

the IQueryBuilder instance

startValue

IQueryBuilder startValue(java.lang.Object startValue,
                         boolean include)

Sets the start index

Parameters:

startValue - the start index

include - should the value also be part of the range

Returns:

the IQueryBuilder instance

endValue

IQueryBuilder endValue(java.lang.Object endValue)

Sets the end index

Parameters:

endValue - the end index

Returns:

the IQueryBuilder instance

endValue

IQueryBuilder endValue(java.lang.Object endValue,
                       boolean include)

Sets the end index

Parameters:

endValue - the end index

include - should the value also be part of the range

Returns:

the IQueryBuilder instance

simpleValue

IQueryBuilder simpleValue(java.lang.Object value)

Sets the value

Parameters:

value - the value of this attribute

Returns:

the IQueryBuilder instance

and

IQueryBuilder and(IQuery... queries)

Sets an AND between two queries

Parameters:

queries - the IQuery instances

Returns:

the IQueryBuilder instance

or

IQueryBuilder or(IQuery... queries)

Sets an OR between two queries

Parameters:

queries - the IQuery instances

Returns:

the IQueryBuilder instance

in

IQueryBuilder in(java.util.List<java.lang.Object> valueList)

Creates a in-query

Parameters:

valueList - list with values

Returns:

the IQueryBuilder instance

in

IQueryBuilder in(java.lang.Object... values)

Creates a in-query

Parameters:

values - array with values

Returns:

the IQueryBuilder instance

projectionPath

IQueryBuilder projectionPath(EStructuralFeature... referencePath)

Sets a reference path for the projection

Parameters:

queries - the IQuery instances

Returns:

the IQueryBuilder instance