com.sap.cloud.sdk.s4hana.datamodel.odata.helper

Class VdmObject<ObjectT>

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.helper.VdmObject<ObjectT>

Direct Known Subclasses:

VdmComplex, VdmEntity

public abstract class VdmObject<ObjectT>
extends Object

Superclass of all entities which contains common elements such as a generic representation of custom fields.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,Object>	changedOriginalFields

Constructor Summary

Constructors

Constructor and Description
VdmObject()

Method Summary

Modifier and Type	Method and Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
protected void	fromMap(Map<String,Object> values)
Map<String,Object>	getChangedFields() Returns map of all fields which have been changed on this entity along with their updated values.
<FieldT> FieldT	getCustomField(EntityField<ObjectT,FieldT> customField) This method allows for retrieval of custom fields that are added to the underlying OData services.
<FieldT> FieldT	getCustomField(String customFieldName) This method allows for retrieval of custom fields that are added to the underlying OData services.
Set<String>	getCustomFieldNames()
Map<String,Object>	getCustomFields()
protected Map<String,Object>	getKey()
protected Set<String>	getSetOfCustomFields()
protected Set<String>	getSetOfFields()
protected Set<String>	getSetOfNavigationProperties()
abstract Class<ObjectT>	getType()
boolean	hasCustomField(EntityField<ObjectT,?> customField)
boolean	hasCustomField(String customFieldName)
int	hashCode()
protected void	rememberChangedField(String fieldName, Object valueBeforeChange) Remembers the original value of a changed field.
void	resetChangedFields() Resets the map of all fields which have been changed on this entity.
<FieldT> void	setCustomField(EntityField<ObjectT,FieldT> customField, FieldT value) Sets the value of a single custom field.
void	setCustomField(String customFieldName, Object value) Sets the value of a single custom field.
protected Map<String,Object>	toMap()
protected Map<String,Object>	toMapOfCustomFields()
protected Map<String,Object>	toMapOfFields()
protected Map<String,Object>	toMapOfNavigationProperties()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

changedOriginalFields

@Nonnull
protected final transient Map<String,Object> changedOriginalFields

Constructor Detail

VdmObject

public VdmObject()

Method Detail

getCustomFieldNames

public Set<String> getCustomFieldNames()

Returns:

The names of the custom fields of this object.

getCustomFields

@Nonnull
public Map<String,Object> getCustomFields()

Returns:

All of the names & values of custom fields as a map.

setCustomField

public void setCustomField(@Nonnull
                           String customFieldName,
                           @Nullable
                           Object value)

Sets the value of a single custom field.

Parameters:

customFieldName - Name of the custom field.

value - Value of the custom field.

setCustomField

public <FieldT> void setCustomField(@Nonnull
                                    EntityField<ObjectT,FieldT> customField,
                                    @Nullable
                                    FieldT value)

Sets the value of a single custom field. If the EntityField passed as parameter holds a TypeConverter, the value will be converted before it's stored.

Parameters:

customField - Name of the custom field, represented as an EntityField object.

value - Value of the custom field.

hasCustomField

public boolean hasCustomField(@Nonnull
                              String customFieldName)

Parameters:

customFieldName - Name of the custom field to check for

Returns:

true if this entity has a custom field with the given name, false otherwise.

hasCustomField

public boolean hasCustomField(@Nonnull
                              EntityField<ObjectT,?> customField)

Parameters:

customField - Custom field to check for, represented as an EntityField object.

Returns:

true if this object has a custom field with the name of the given field, false otherwise.

getCustomField

@Nullable
public <FieldT> FieldT getCustomField(@Nonnull
                                                String customFieldName)
                                         throws NoSuchEntityFieldException

This method allows for retrieval of custom fields that are added to the underlying OData services.

Parameters:

customFieldName - Name of the field returned by the underlying OData service.

Returns:

The value of the custom field. Actual type will depend on the type configured in the underlying OData service.

Throws:

NoSuchEntityFieldException

getCustomField

@Nullable
public <FieldT> FieldT getCustomField(@Nonnull
                                                EntityField<ObjectT,FieldT> customField)
                                         throws NoSuchEntityFieldException

This method allows for retrieval of custom fields that are added to the underlying OData services. If the EntityField passed as parameter holds a TypeConverter, the value will be converted before it's returned.

Parameters:

customField - Field returned by the underlying OData service.

Returns:

The value of the custom field. Actual type will depend on the type configured in the underlying OData service.

Throws:

NoSuchEntityFieldException

getType

@Nonnull
public abstract Class<ObjectT> getType()

Returns:

The class of this object.

getKey

@Nonnull
protected Map<String,Object> getKey()

Returns:

The compound key of this object.

fromMap

protected void fromMap(Map<String,Object> values)

toMapOfCustomFields

@Nonnull
protected Map<String,Object> toMapOfCustomFields()

getSetOfCustomFields

@Nonnull
protected Set<String> getSetOfCustomFields()

toMapOfFields

@Nonnull
protected Map<String,Object> toMapOfFields()

getSetOfFields

@Nonnull
protected Set<String> getSetOfFields()

toMapOfNavigationProperties

@Nonnull
protected Map<String,Object> toMapOfNavigationProperties()

getSetOfNavigationProperties

@Nonnull
protected Set<String> getSetOfNavigationProperties()

toMap

@Nonnull
protected Map<String,Object> toMap()

getChangedFields

@Nonnull
public Map<String,Object> getChangedFields()

Returns map of all fields which have been changed on this entity along with their updated values.

Returns:

Map containing all changed fields with their current value.

rememberChangedField

protected void rememberChangedField(@Nonnull
                                    String fieldName,
                                    @Nullable
                                    Object valueBeforeChange)

Remembers the original value of a changed field.

Parameters:

fieldName - The name of the field that is changed.

valueBeforeChange - The original value before the change.

resetChangedFields

public void resetChangedFields()

Resets the map of all fields which have been changed on this entity.

After calling this method, no field is considered changed, until you change the value of fields on this entity afterwards.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object