com.sap.cds.services.impl.utils

Class CdsModelUtils

java.lang.Object

com.sap.cds.services.impl.utils.CdsModelUtils

public class CdsModelUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CdsModelUtils.EntityDataVisitor Functional interface for entity data visitors.
static interface	CdsModelUtils.EntitySingleDataVisitor Functional interface for entity data visitors.

Method Summary

Modifier and Type	Method and Description
static boolean	eventIsGranted(String event, String grant)
static Optional<com.sap.cds.reflect.CdsAction>	getAction(com.sap.cds.reflect.CdsModel model, String entityName, String actionName) Tries to resolve the CDS action with the given full-qualified name in the given CDS model.
static List<com.sap.cds.reflect.CdsElement>	getAssociationKeys(com.sap.cds.reflect.CdsElement element) Returns the elements of the association target, that represent the keys of this association.
static com.sap.cds.reflect.CdsEntity	getAssociationTarget(String field, com.sap.cds.reflect.CdsEntity entity) Returns the target of an association.
static com.sap.cds.reflect.CdsEntity	getEntityOrThrow(com.sap.cds.reflect.CdsModel model, String entityName) Tries to resolve the CDS entity with the given full-qualified name in the given CDS model.
static com.sap.cds.ql.cqn.AnalysisResult	getEntityPath(com.sap.cds.ql.cqn.CqnStatement statement, com.sap.cds.reflect.CdsModel model)
static com.sap.cds.ql.cqn.AnalysisResult	getEntityPath(com.sap.cds.ql.cqn.CqnStructuredTypeRef ref, com.sap.cds.reflect.CdsModel model)
static Optional<com.sap.cds.reflect.CdsFunction>	getFunction(com.sap.cds.reflect.CdsModel model, String entityName, String functionName) Tries to resolve the CDS function with the given full-qualified name in the given CDS model.
static String	getNameOrEmpty(com.sap.cds.reflect.CdsEntity entity) Returns the qualified name of the entity or an empty string, if no entity is provided
static com.sap.cds.reflect.CdsService	getServiceOrThrow(com.sap.cds.reflect.CdsModel model, String serviceName) Tries to resolve the service with the given full-qualified name in the given CDS model.
static com.sap.cds.reflect.CdsEntity	getTargetEntity(com.sap.cds.ql.cqn.CqnStatement statement, com.sap.cds.reflect.CdsModel model)
static boolean	isAssociationToParent(String field, com.sap.cds.reflect.CdsEntity entity)
static boolean	isAssociationToParentOrChild(String field, com.sap.cds.reflect.CdsEntity entity) Checks if the field is a composition or an association to a parent entity
static boolean	isComposition(String field, com.sap.cds.reflect.CdsEntity entity)
static boolean	isStandardCdsEvent(String event)
static boolean	isWriteEvent(String event)
static com.sap.cds.reflect.CdsModel	loadCdsModel(String resourcePathToCSN) Loads the CDS model from current classloader's resource at the given location.
static Map<com.sap.cds.reflect.CdsElement,com.sap.cds.reflect.CdsElement>	reduceAssociationElements(com.sap.cds.reflect.CdsStructuredType struct) Reduces the elements of the entity, to map elements associations with their corresponding key element.
static void	visitDeep(com.sap.cds.reflect.CdsEntity entity, List<? extends Map<String,Object>> data, CdsModelUtils.EntityDataVisitor visitor) Traverses the given entity data together with the entity metadata.
static void	visitDeep(com.sap.cds.reflect.CdsEntity entity, Map<String,Object> data, CdsModelUtils.EntitySingleDataVisitor visitor) Traverses the given entity data together with the entity metadata.

Methods inherited from class java.lang.Object

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

Method Detail

loadCdsModel

public static com.sap.cds.reflect.CdsModel loadCdsModel(String resourcePathToCSN)

Loads the CDS model from current classloader's resource at the given location.

Parameters:

resourcePathToCSN - The resource path of the CDS model file within the current classloader

Returns:

The loaded model

getNameOrEmpty

public static String getNameOrEmpty(com.sap.cds.reflect.CdsEntity entity)

Returns the qualified name of the entity or an empty string, if no entity is provided

Parameters:

entity - the entity

Returns:

the qualified name of the entity or an empty string

getEntityOrThrow

public static com.sap.cds.reflect.CdsEntity getEntityOrThrow(com.sap.cds.reflect.CdsModel model,
                                                             String entityName)

Tries to resolve the CDS entity with the given full-qualified name in the given CDS model.

Parameters:

entityName - The name of the CDS entity to be resolved

model - The model to search

Returns:

The CdsEntity object representing the entity in the CDS model

Throws:

ServiceException - In case the name can't be resolved (error code 404)

getServiceOrThrow

public static com.sap.cds.reflect.CdsService getServiceOrThrow(com.sap.cds.reflect.CdsModel model,
                                                               String serviceName)

Tries to resolve the service with the given full-qualified name in the given CDS model.

Parameters:

serviceName - The name of the service to be resolved

model - The model to search

Returns:

The CdsService object representing the service in the CDS model

Throws:

ServiceException - In case the name can't be resolved (error code 404)

getAction

public static Optional<com.sap.cds.reflect.CdsAction> getAction(com.sap.cds.reflect.CdsModel model,
                                                                String entityName,
                                                                String actionName)

Tries to resolve the CDS action with the given full-qualified name in the given CDS model.

Parameters:

actionName - The name of the CDS action to be resolved

model - The model to search

entityName - The entity name

Returns:

The CdsAction object representing the entity in the CDS model

Throws:

ServiceException - In case the name can't be resolved (error code 404)

getFunction

public static Optional<com.sap.cds.reflect.CdsFunction> getFunction(com.sap.cds.reflect.CdsModel model,
                                                                    String entityName,
                                                                    String functionName)

Tries to resolve the CDS function with the given full-qualified name in the given CDS model.

Parameters:

functionName - The name of the CDS function to be resolved

model - The model to search

entityName - The entity name

Returns:

The CdsFunction object representing the function in the CDS model

Throws:

ServiceException - In case the name can't be resolved (error code 404)

reduceAssociationElements

public static Map<com.sap.cds.reflect.CdsElement,com.sap.cds.reflect.CdsElement> reduceAssociationElements(com.sap.cds.reflect.CdsStructuredType struct)

Reduces the elements of the entity, to map elements associations with their corresponding key element. For example, for an element "parent : Association to Parent" another element "parent_ID" is added to the entity, when doing an OData transformation. The stream of elements returned by this method would return the parent_ID element (key) paired with the parent element (value)

Parameters:

struct - the structured type to reduce the association elements for

Returns:

a map with the paired association elements, still contains all non-association and non-paired elements with a value of null

getAssociationKeys

public static List<com.sap.cds.reflect.CdsElement> getAssociationKeys(com.sap.cds.reflect.CdsElement element)

Returns the elements of the association target, that represent the keys of this association. This can be either the keys of the association target (in case of managed associations). In cases of unmanaged associations these are the elements of the association target, mentioned in the ON condition of the association. The elements returned by this method can be assumed to be auto-filled in by CDS4J as they can be inferred from the association parent.

Parameters:

element - the association element to analyze

Returns:

the keys of the association, or an empty list of the element is null or not an association

isAssociationToParentOrChild

public static boolean isAssociationToParentOrChild(String field,
                                                   com.sap.cds.reflect.CdsEntity entity)

Checks if the field is a composition or an association to a parent entity

Parameters:

field - the field name

entity - the entity

Returns:

true if the field is a composition or an association to a parent entity

isAssociationToParent

public static boolean isAssociationToParent(String field,
                                            com.sap.cds.reflect.CdsEntity entity)

isComposition

public static boolean isComposition(String field,
                                    com.sap.cds.reflect.CdsEntity entity)

getAssociationTarget

public static com.sap.cds.reflect.CdsEntity getAssociationTarget(String field,
                                                                 com.sap.cds.reflect.CdsEntity entity)

Returns the target of an association.

Parameters:

field - the field name

entity - the entity

Returns:

the target of the association or null if the field is no association or does not exist

visitDeep

public static void visitDeep(com.sap.cds.reflect.CdsEntity entity,
                             List<? extends Map<String,Object>> data,
                             CdsModelUtils.EntityDataVisitor visitor)

Traverses the given entity data together with the entity metadata. The CdsModelUtils.EntityDataVisitor is called for the given data and entity and then for each association with the respective entity data of the association. This happens recursively until either no further associations can be found, or no more nested data is available

Parameters:

entity - the root entity

data - the list of entity data sets for the root entity

visitor - the visitor to use to visit the data together with the entity metadata

visitDeep

public static void visitDeep(com.sap.cds.reflect.CdsEntity entity,
                             Map<String,Object> data,
                             CdsModelUtils.EntitySingleDataVisitor visitor)

Traverses the given entity data together with the entity metadata. The CdsModelUtils.EntitySingleDataVisitor is called for the given data and entity and then for each association with the respective entity data of the association. For "to many" associations, the visitor is called for each element. This happens recursively until either no further associations can be found, or no more nested data is available

Parameters:

entity - the root entity

data - the of the root entity

visitor - the visitor to use to visit the data together with the entity metadata

getEntityPath

public static com.sap.cds.ql.cqn.AnalysisResult getEntityPath(com.sap.cds.ql.cqn.CqnStatement statement,
                                                              com.sap.cds.reflect.CdsModel model)

getTargetEntity

public static com.sap.cds.reflect.CdsEntity getTargetEntity(com.sap.cds.ql.cqn.CqnStatement statement,
                                                            com.sap.cds.reflect.CdsModel model)

getEntityPath

public static com.sap.cds.ql.cqn.AnalysisResult getEntityPath(com.sap.cds.ql.cqn.CqnStructuredTypeRef ref,
                                                              com.sap.cds.reflect.CdsModel model)

isStandardCdsEvent

public static boolean isStandardCdsEvent(String event)

isWriteEvent

public static boolean isWriteEvent(String event)

eventIsGranted

public static boolean eventIsGranted(String event,
                                     String grant)