com.sap.cloud.sdk.service.prov.api

Class EntityData

java.lang.Object

com.sap.cloud.sdk.service.prov.api.EntityData

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

DefaultEntityData

public abstract class EntityData
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
EntityData()

Method Summary

Modifier and Type	Method and Description
abstract <T> T	as(Class<T> t) Returns a POJO based on EntityData
abstract Map<String,Object>	asMap() Returns the map of all the properties of a given EntityData instance.
abstract boolean	contains(String name) Checks whether a particular element is present.
static EntityData	createFrom(Object data, String entityName) Returns an EntityData instance which is based on the POJO passed as parameter
static EntityData	createFromDeepMap(Map<String,Object> propertiesMap, Map<String,List<String>> keys, String entityName) Returns an EntityData instance which is based on a list of properties
static EntityData	createFromMap(Map<String,Object> propertiesMap, List<String> keys, String entityName) Returns an EntityData instance which is based on a list of properties
abstract Map<String,Object>	getAssociations() Returns the collection of all associations.
abstract Object	getAssociationValue(String name) Returns the value of a specific association If this method returns null, then it means that the association is not present.
static EntityDataBuilder	getBuilder() Returns an EntityDataBuilder instance which can be used to construct an entityData from scratch.
static EntityDataBuilder	getBuilder(EntityData entityData) Returns an EntityDataBuilder instance which is partially initialized based on the passed entityData.
Object	getElementValue(String name) Returns the value of a particular element.
abstract Map<String,Object>	getMap() Returns the properties of the entity.

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityData

public EntityData()

Method Detail

contains

public abstract boolean contains(String name)

Checks whether a particular element is present.

Parameters:

name - The name of element to check.

Returns:

true if the element is present, false otherwise.

getAssociationValue

public abstract Object getAssociationValue(String name)

Returns the value of a specific association If this method returns null, then it means that the association is not present.

Parameters:

name - Name of the association

Returns:

if association is 1:1 then the returned object is EntityData, else if association is 1:n then the returned object is a List

getAssociations

public abstract Map<String,Object> getAssociations()

Returns the collection of all associations. If this method returns null, it means that there are no associations for the entity.

Returns:

if association is 1:1 then the returned object is EntityData, else if association is 1:n then the returned object is a List

getElementValue

public Object getElementValue(String name)

Returns the value of a particular element. If this method returns null it can mean either of 2 things. 1) The element is not present. 2) The element is present but the value is explicitly set as null. Use the contains method to check whether an element exists in the entityData.

Parameters:

name - Name of the element.

Returns:

value of the element if the element is present, null otherwise.

getBuilder

public static EntityDataBuilder getBuilder()

Returns an EntityDataBuilder instance which can be used to construct an entityData from scratch.

Returns:

An instance of EntityDataBuilder.

getBuilder

public static EntityDataBuilder getBuilder(EntityData entityData)

Returns an EntityDataBuilder instance which is partially initialized based on the passed entityData. This method should be used if you need to construct an entityData starting from an existing entityData. For example:- You have an entityData for an entity Customer. But you would like to add an extra element to this entityData for the name of the Customer's company. The first step you have to do is to get a builder by passing the existing entitydata. EntityDataBuilder builder = EntityData.getBuilder(customerEntityData); Once you have the builder you can add the extra element, by calling the addElement method.

Parameters:

entityData - The entityData from which a new EntityData is to be constructed, for example by adding an extra element.

Returns:

An instance of EntityDataBuilder which is initialized based on the passed EntityData.

createFromMap

public static EntityData createFromMap(Map<String,Object> propertiesMap,
                                       List<String> keys,
                                       String entityName)

Returns an EntityData instance which is based on a list of properties

Parameters:

propertiesMap - List of properties used to construct a new instance of EntityData

keys - List of key names

entityName - Name of the newly created entity

Returns:

An instance of EntityData

createFromDeepMap

public static EntityData createFromDeepMap(Map<String,Object> propertiesMap,
                                           Map<String,List<String>> keys,
                                           String entityName)

Returns an EntityData instance which is based on a list of properties

Parameters:

propertiesMap - List of properties and associations used to construct a new instance of EntityData

keys - Map of List of key based on entity name

entityName - Fully qualified entityname along with service name

Returns:

An instance of EntityData

asMap

public abstract Map<String,Object> asMap()

Returns the map of all the properties of a given EntityData instance. *

Returns:

A map instance containing all the properties of an EntityData instance.

createFrom

public static EntityData createFrom(Object data,
                                    String entityName)

Returns an EntityData instance which is based on the POJO passed as parameter

Parameters:

data - A POJO instance

entityName - Name of the newly created entity

Returns:

An instance of EntityData

as

public abstract <T> T as(Class<T> t)
                  throws DataConversionException

Returns a POJO based on EntityData

Parameters:

T - A POJO class

Returns:

A POJO based on EntityData

Throws:

DataConversionException

getMap

public abstract Map<String,Object> getMap()

Returns the properties of the entity.

Returns:

A Map containing the property names and values of an entity