Package com.sap.cds.ql.impl

Class SelectBuilder<T extends StructuredType<?>>

java.lang.Object

com.sap.cds.ql.StatementBuilder<Select<T>>

com.sap.cds.ql.Select<T>

com.sap.cds.ql.impl.SelectBuilder<T>

All Implemented Interfaces:

JSONizable, CqnEntitySelector, CqnFilterableStatement, CqnSelect, CqnSource, CqnStatement, CqnToken, FilterableStatement<T,Select<T>>, Source<T>, Statement<Select<T>>

public class SelectBuilder<T extends StructuredType<?>>
extends Select<T>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COLLATING
static final String	COLLATING_OFF
static final String	IGNORE_DRAFT_SUBQUERIES
static final String	IGNORE_LOCALIZED_VIEWS

Fields inherited from class com.sap.cds.ql.StatementBuilder

hints

Method Summary

Modifier and Type	Method	Description
SelectBuilder<T>	addExclude(String sli)
SelectBuilder<T>	addItem(Selectable item)
final SelectBuilder<T>	addOrderBy(CqnSortSpecification sortSpec)
final SelectBuilder<T>	addTransformation(CqnTransformation t)
CqnSelect	build()
SelectBuilder<T>	byId(Object idValue)
Select<T>	byParams(Collection<String> elementRefs)
SelectBuilder<T>	columns(String... paths)
SelectBuilder<T>	columns(List<? extends Selectable> items)
SelectBuilder<T>	columns(Stream<? extends Selectable> items)
static SelectBuilder<StructuredType<?>>	copy(CqnSelect select)
static SelectBuilder<StructuredType<?>>	copy(CqnSelect select, Modifier modifier)
static SelectBuilder<StructuredType<?>>	copy(CqnSelect select, Modifier modifier, boolean deep)
static SelectBuilder	copyShallow(CqnSelect statement)
SelectBuilder<T>	count(boolean count)
SelectBuilder<T>	distinct()
SelectBuilder<T>	distinct(boolean distinct)
List<String>	excluding()
SelectBuilder<T>	excluding(Collection<String> slis)
SelectBuilder<T>	filter(CqnPredicate predicate)
SelectBuilder<T>	filter(Function<T,CqnPredicate> predicate)
SelectBuilder<T>	filterSource(CqnPredicate pred)
SelectBuilder<T>	filterSource(Function<T,CqnPredicate> pred)
Source<T>	from()
static SelectBuilder<StructuredType<?>>	from(CqnSelect select)
static SelectBuilder<StructuredTypeImpl>	from(CqnSource source)
static SelectBuilder<StructuredType<?>>	from(CqnStructuredTypeRef ref)
static SelectBuilder	from(Source<?> source, CqnSelect template)
static <E extends StructuredType<E>> SelectBuilder<E>	from(Source<E> source)
static <E extends StructuredType<E>> SelectBuilder<E>	from(Class<E> entity)
static <E extends StructuredType<E>, R extends StructuredType<R>> SelectBuilder<R>	from(Class<E> type, Function<E,R> path)
static SelectBuilder<StructuredType<?>>	from(String entityName)
static SelectBuilder<StructuredType<?>>	from(String entity, UnaryOperator<StructuredType<?>> path)
static <U> FunctionCall<U>	func(String functionName, CqnValue... args)
Optional<CqnLock>	getLock()
T	getType()
List<CqnValue>	groupBy()
SelectBuilder<T>	groupBy(String... refs)
SelectBuilder<T>	groupBy(List<? extends CqnValue> items)
SelectBuilder<T>	groupBy(Stream<? extends CqnValue> dimensions)
boolean	hasInlineCount()
Optional<CqnPredicate>	having()
SelectBuilder<T>	having(CqnPredicate pred)
SelectBuilder<T>	having(Function<T,CqnPredicate> pred)
SelectBuilder<T>	having(Optional<CqnPredicate> pred)
SelectBuilder<T>	inlineCount()
boolean	isDistinct()
List<CqnSelectListItem>	items()
SelectBuilder<T>	limit(long top, long skip)
static <U> Literal<U>	literal(U val)
Select<T>	lock(CqnLock.Mode mode)
Select<T>	lock(CqnLock.Mode mode, int timeout)
Select<T>	lockSelectedRows(CqnLock rowLock)
SelectBuilder<T>	matching(Map<String,?> values)
static Predicate	not(Predicate p)
List<CqnSortSpecification>	orderBy()
Select<T>	orderBy(String... paths)
final SelectBuilder<T>	orderBy(List<CqnSortSpecification> sortSpec)
static <U> Parameter<U>	param()
static <U> Parameter<U>	param(String name)
CqnStructuredTypeRef	ref()
Optional<CqnPredicate>	search()
SelectBuilder<T>	search(CqnPredicate predicate)
SelectBuilder<T>	search(String searchTerm)
SelectBuilder<T>	search(String searchTerm, Iterable<String> searchableElements)
SelectBuilder<T>	search(Function<Searchable,Predicate> pred)
SelectBuilder<T>	search(Function<Searchable,Predicate> pred, Iterable<String> searchableElements)
Collection<String>	searchableElements()
long	skip()
String	toJson()
long	top()
List<CqnTransformation>	transformations()
final SelectBuilder<T>	transformations(List<CqnTransformation> t)
Optional<CqnPredicate>	where()
SelectBuilder<T>	where(CqnPredicate pred)
SelectBuilder<T>	where(Function<T,CqnPredicate> pred)
SelectBuilder<T>	where(Optional<? extends CqnPredicate> optionalWhere)

Methods inherited from class com.sap.cds.ql.Select

accept, byParams, columns, columns, cqn, excluding, excluding, from, from, from, groupBy, groupBy, limit, lock, lock, orderBy, orderBy, toString

Methods inherited from class com.sap.cds.ql.StatementBuilder

hint, hints, hints, hints

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.cds.ql.cqn.CqnEntitySelector

hasLimit

Methods inherited from interface com.sap.cds.ql.cqn.CqnSelect

asSelect, columns, dispatch, isSelect

Methods inherited from interface com.sap.cds.ql.cqn.CqnSource

asJoin, asRef, asSelect, asTableFunction, isJoin, isRef, isSelect, isTableFunction

Methods inherited from interface com.sap.cds.ql.cqn.CqnStatement

asDelete, asInsert, asUpdate, asUpsert, hints, isDelete, isInsert, isUpdate, isUpsert

Methods inherited from interface com.sap.cds.ql.cqn.CqnToken

tokens

Methods inherited from interface com.sap.cds.ql.Statement

hint, hints

Field Details

COLLATING

public static final String COLLATING

See Also:

• Constant Field Values

COLLATING_OFF

public static final String COLLATING_OFF

See Also:

• Constant Field Values

IGNORE_LOCALIZED_VIEWS

public static final String IGNORE_LOCALIZED_VIEWS

See Also:

• Constant Field Values

IGNORE_DRAFT_SUBQUERIES

public static final String IGNORE_DRAFT_SUBQUERIES

See Also:

• Constant Field Values

Method Details

from

public static <E extends StructuredType<E>>
SelectBuilder<E> from(Class<E> entity)

from

public static SelectBuilder<StructuredType<?>> from(CqnStructuredTypeRef ref)

from

public static SelectBuilder<StructuredType<?>> from(CqnSelect select)

from

public static SelectBuilder<StructuredTypeImpl> from(CqnSource source)

from

public static <E extends StructuredType<E>,
R extends StructuredType<R>>
SelectBuilder<R> from(Class<E> type,
 Function<E,R> path)

from

public static <E extends StructuredType<E>>
SelectBuilder<E> from(Source<E> source)

from

public static SelectBuilder<StructuredType<?>> from(String entityName)

from

public static SelectBuilder<StructuredType<?>> from(String entity,
 UnaryOperator<StructuredType<?>> path)

copy

public static SelectBuilder<StructuredType<?>> copy(CqnSelect select)

copy

public static SelectBuilder<StructuredType<?>> copy(CqnSelect select,
 Modifier modifier)

copy

public static SelectBuilder<StructuredType<?>> copy(CqnSelect select,
 Modifier modifier,
 boolean deep)

copyShallow

public static SelectBuilder copyShallow(CqnSelect statement)

from

public static SelectBuilder from(Source<?> source,
 CqnSelect template)

from

public Source<T> from()

ref

public CqnStructuredTypeRef ref()

distinct

public SelectBuilder<T> distinct()

Specified by:

distinct in class Select<T extends StructuredType<?>>

distinct

public SelectBuilder<T> distinct(boolean distinct)

isDistinct

public boolean isDistinct()

inlineCount

public SelectBuilder<T> inlineCount()

Specified by:

inlineCount in class Select<T extends StructuredType<?>>

count

public SelectBuilder<T> count(boolean count)

hasInlineCount

public boolean hasInlineCount()

columns

public SelectBuilder<T> columns(List<? extends Selectable> items)

Specified by:

columns in class Select<T extends StructuredType<?>>

columns

public SelectBuilder<T> columns(Stream<? extends Selectable> items)

Specified by:

columns in class Select<T extends StructuredType<?>>

columns

public SelectBuilder<T> columns(String... paths)

Specified by:

columns in class Select<T extends StructuredType<?>>

addItem

public SelectBuilder<T> addItem(Selectable item)

items

public List<CqnSelectListItem> items()

excluding

public SelectBuilder<T> excluding(Collection<String> slis)

Specified by:

excluding in class Select<T extends StructuredType<?>>

addExclude

public SelectBuilder<T> addExclude(String sli)

excluding

public List<String> excluding()

where

public SelectBuilder<T> where(Function<T,CqnPredicate> pred)

Specified by:

where in interface FilterableStatement<T extends StructuredType<?>,Select<T extends StructuredType<?>>>

Specified by:

where in class Select<T extends StructuredType<?>>

where

public SelectBuilder<T> where(CqnPredicate pred)

Specified by:

where in interface FilterableStatement<T extends StructuredType<?>,Select<T extends StructuredType<?>>>

Specified by:

where in class Select<T extends StructuredType<?>>

filter

@Beta
public SelectBuilder<T> filter(Function<T,CqnPredicate> predicate)

filterSource

@Beta
public SelectBuilder<T> filterSource(CqnPredicate pred)

filterSource

@Beta
public SelectBuilder<T> filterSource(Function<T,CqnPredicate> pred)

filter

@Beta
public SelectBuilder<T> filter(CqnPredicate predicate)

where

public SelectBuilder<T> where(Optional<? extends CqnPredicate> optionalWhere)

top

public long top()

skip

public long skip()

byParams

public Select<T> byParams(Collection<String> elementRefs)

Specified by:

byParams in interface FilterableStatement<T extends StructuredType<?>,Select<T extends StructuredType<?>>>

Specified by:

byParams in class Select<T extends StructuredType<?>>

matching

public SelectBuilder<T> matching(Map<String,?> values)

Specified by:

matching in interface FilterableStatement<T extends StructuredType<?>,Select<T extends StructuredType<?>>>

Specified by:

matching in class Select<T extends StructuredType<?>>

byId

public SelectBuilder<T> byId(Object idValue)

Specified by:

byId in interface FilterableStatement<T extends StructuredType<?>,Select<T extends StructuredType<?>>>

Specified by:

byId in class Select<T extends StructuredType<?>>

search

public SelectBuilder<T> search(String searchTerm)

Specified by:

search in class Select<T extends StructuredType<?>>

search

public SelectBuilder<T> search(String searchTerm,
 Iterable<String> searchableElements)

Specified by:

search in class Select<T extends StructuredType<?>>

search

public SelectBuilder<T> search(Function<Searchable,Predicate> pred)

Specified by:

search in class Select<T extends StructuredType<?>>

search

public SelectBuilder<T> search(Function<Searchable,Predicate> pred,
 Iterable<String> searchableElements)

Specified by:

search in class Select<T extends StructuredType<?>>

search

public SelectBuilder<T> search(CqnPredicate predicate)

Specified by:

search in class Select<T extends StructuredType<?>>

searchableElements

public Collection<String> searchableElements()

where

public Optional<CqnPredicate> where()

search

public Optional<CqnPredicate> search()

lock

public Select<T> lock(CqnLock.Mode mode,
 int timeout)

Specified by:

lock in class Select<T extends StructuredType<?>>

lock

public Select<T> lock(CqnLock.Mode mode)

Specified by:

lock in class Select<T extends StructuredType<?>>

lockSelectedRows

public Select<T> lockSelectedRows(CqnLock rowLock)

getLock

public Optional<CqnLock> getLock()

groupBy

public SelectBuilder<T> groupBy(List<? extends CqnValue> items)

Specified by:

groupBy in class Select<T extends StructuredType<?>>

groupBy

public SelectBuilder<T> groupBy(String... refs)

Specified by:

groupBy in class Select<T extends StructuredType<?>>

groupBy

public SelectBuilder<T> groupBy(Stream<? extends CqnValue> dimensions)

Specified by:

groupBy in class Select<T extends StructuredType<?>>

groupBy

public List<CqnValue> groupBy()

having

public SelectBuilder<T> having(Function<T,CqnPredicate> pred)

Specified by:

having in class Select<T extends StructuredType<?>>

having

public SelectBuilder<T> having(CqnPredicate pred)

Specified by:

having in class Select<T extends StructuredType<?>>

having

public SelectBuilder<T> having(Optional<CqnPredicate> pred)

having

public Optional<CqnPredicate> having()

orderBy

public final SelectBuilder<T> orderBy(List<CqnSortSpecification> sortSpec)

Specified by:

orderBy in class Select<T extends StructuredType<?>>

addOrderBy

public final SelectBuilder<T> addOrderBy(CqnSortSpecification sortSpec)

orderBy

public List<CqnSortSpecification> orderBy()

orderBy

public Select<T> orderBy(String... paths)

Specified by:

orderBy in class Select<T extends StructuredType<?>>

limit

public SelectBuilder<T> limit(long top,
 long skip)

Specified by:

limit in class Select<T extends StructuredType<?>>

build

public CqnSelect build()

getType

public T getType()

param

public static <U> Parameter<U> param()

param

public static <U> Parameter<U> param(String name)

func

public static <U> FunctionCall<U> func(String functionName,
 CqnValue... args)

literal

public static <U> Literal<U> literal(U val)

not

public static Predicate not(Predicate p)

transformations

public List<CqnTransformation> transformations()

addTransformation

public final SelectBuilder<T> addTransformation(CqnTransformation t)

transformations

public final SelectBuilder<T> transformations(List<CqnTransformation> t)

toJson

public String toJson()