com.sap.cds.reflect

Interface CdsEntity

All Superinterfaces:

CdsAnnotatable, CdsDefinition, CdsStructuredType, CdsType

public interface CdsEntity
extends CdsStructuredType

Method Summary

Modifier and Type	Method and Description
default void	accept(CdsVisitor visitor) Accepts a CdsVisitor visiting the elements of this definition (depth-first)
Stream<CdsAction>	actions() Returns a sequential Stream over the bounded CdsAction(s) of this CdsEntity.
Optional<CdsAction>	findAction(String name) Returns an Optional wrapping a bounded CdsAction.
Optional<CdsFunction>	findFunction(String name) Returns an Optional wrapping a bounded CdsFunction.
Stream<CdsFunction>	functions() Returns a sequential Stream over the bounded CdsFunction(s) of this CdsEntity.
CdsAction	getAction(String name) Get a bounded CdsAction via its name.
CdsFunction	getFunction(String name) Get a CdsFunction via its name.
default CdsEntity	getTargetOf(String association) Returns the target CdsEntity of the association element with the given name.
boolean	isAbstract() Returns true if this entity is abstract.
boolean	isProjection() Returns true if this entity is a projection.
boolean	isView() Returns true if this entity is a view.
Stream<CdsParameter>	params() Returns a sequential Stream over the CdsParameter(s) of this CdsEntity.
Optional<CqnSelect>	query() Returns the query of this CdsEntity.

Methods inherited from interface com.sap.cds.reflect.CdsStructuredType

associations, compositions, concreteElements, concreteNonAssociationElements, elements, elementsOfType, findAssociation, findElement, getAssociation, getElement, isInlineDefined, isStructured, keyElements, nonAssociationElements, virtualElements

Methods inherited from interface com.sap.cds.reflect.CdsType

as, isArrayed, isAssociation, isEnum, isSimple

Methods inherited from interface com.sap.cds.reflect.CdsDefinition

byNamespace, getName, getQualifiedName, getQualifier

Methods inherited from interface com.sap.cds.reflect.CdsAnnotatable

annotations, byAnnotation, findAnnotation

Method Detail

isAbstract

boolean isAbstract()

Returns true if this entity is abstract.

Returns:

true if this entity is abstract, otherwise false

isView

boolean isView()

Returns true if this entity is a view.

Returns:

true if this entity is a view, otherwise false

isProjection

boolean isProjection()

Returns true if this entity is a projection.

Returns:

true if this entity is a projection, otherwise false

query

Optional<CqnSelect> query()

Returns the query of this CdsEntity.

Returns:

an Optional describing the query, or an empty Optional if there is no query

See Also:

CqnSelect

params

Stream<CdsParameter> params()

Returns a sequential Stream over the CdsParameter(s) of this CdsEntity.

Returns:

a sequential Stream over the CdsParameter(s)

actions

Stream<CdsAction> actions()

Returns a sequential Stream over the bounded CdsAction(s) of this CdsEntity.

Returns:

a sequential Stream over the CdsAction(s)

getAction

CdsAction getAction(String name)

Get a bounded CdsAction via its name.

Parameters:

name - the name of the CdsAction

Returns:

the CdsAction with the given name

Throws:

CdsElementNotFoundException - if there is no CdsAction with the given name

findAction

Optional<CdsAction> findAction(String name)

Returns an Optional wrapping a bounded CdsAction.

Parameters:

name - the name of the CdsAction

Returns:

an Optional describing the CdsAction with the given name, or an empty Optional if there is no CdsAction with this name

functions

Stream<CdsFunction> functions()

Returns a sequential Stream over the bounded CdsFunction(s) of this CdsEntity.

Returns:

a sequential Stream over the CdsFunction(s)

getFunction

CdsFunction getFunction(String name)

Get a CdsFunction via its name.

Parameters:

name - the name of the CdsFunction

Returns:

the CdsFunction with the given name

Throws:

CdsElementNotFoundException - if there is no CdsFunction with the given name

findFunction

Optional<CdsFunction> findFunction(String name)

Returns an Optional wrapping a bounded CdsFunction.

Parameters:

name - the name of the CdsFunction

Returns:

an Optional describing the CdsFunction with the given name, or an empty Optional if there is no CdsFunction with this name

getTargetOf

default CdsEntity getTargetOf(String association)

Returns the target CdsEntity of the association element with the given name.

Parameters:

association - the name of the association element

Returns:

the target CdsEntity of the CdsAssociation

Throws:

CdsElementNotFoundException - if there is no association with the given name

accept

default void accept(CdsVisitor visitor)

Description copied from interface: CdsDefinition

Accepts a CdsVisitor visiting the elements of this definition (depth-first)

Specified by:

accept in interface CdsDefinition

Specified by:

accept in interface CdsStructuredType

Parameters:

visitor - the CdsVisitor