com.sap.cloud.server.odata

Class StructureBase

java.lang.Object

com.sap.cloud.server.odata.DataValue

com.sap.cloud.server.odata.StructureBase

Direct Known Subclasses:

ComplexValue, EntityValue

public abstract class StructureBase
extends DataValue

The canonical path of this value relative to the service root URL. Common base class for ComplexValue and EntityValue.

Field Summary

Fields inherited from class com.sap.cloud.server.odata.DataValue

undefined

Constructor Summary

Constructors

Constructor and Description
StructureBase()

Method Summary

Modifier and Type	Method and Description
DataValue	getDataValue(PropertyPath path) Get the value of a specified property path.
DataValue	getDynamic(java.lang.String name) Return (nullable) The value of a dynamic property, or null if no such property exists.
DataValueMap	getDynamicProperties() Return holds dynamic property values, for which metadata is not known in advance.
java.lang.String	getNextLink(PropertyPath path) Get the next-link of a specified collection-typed property path.
DataValue	getOptionalValue(PropertyPath path) Get the optional value of a specified property path.
DataValue	getRequiredValue(PropertyPath path) Get the required value of a specified property path.
StreamLink	getStreamLink(Property property) Get the stream link for a specified stream property.
StructureType	getStructureType() Return the complex/entity type metadata for this value (StructureBase.dataType cast to StructureType).
java.lang.String	getValuePath() Return (nullable) The canonical path of this value relative to the service root URL.
boolean	hasDataType(DataType type) Return true if this structure has the specified data type (or a subtype).
boolean	hasDataValue(Property property) Return true if this structure contains an explicitly set value for the specified property (including null, if Property.isNullable).
boolean	hasDynamicProperties() Return true if the structure has dynamic properties set.
boolean	hasNextLink(Property property) Return true if this structure contains a next-link for the specified collection-typed property.
abstract boolean	isNewOrChanged(Property property) Return true if the value of property property is new or changed.
boolean	isNull(Property property) Return true if this structure contains an explicitly set null value for the specified property.
boolean	isProxy() Return is this structure an instance of a generated proxy class?
void	setDataValue(Property property, DataValue value) Set the value of a specified property.
void	setDefaultValues() See setDefaultValues(boolean, boolean, boolean, boolean, boolean).
void	setDefaultValues(boolean nestedComplex) See setDefaultValues(boolean, boolean, boolean, boolean, boolean).
void	setDefaultValues(boolean nestedComplex, boolean nestedEntity) See setDefaultValues(boolean, boolean, boolean, boolean, boolean).
void	setDefaultValues(boolean nestedComplex, boolean nestedEntity, boolean defaultOptional) See setDefaultValues(boolean, boolean, boolean, boolean, boolean).
void	setDefaultValues(boolean nestedComplex, boolean nestedEntity, boolean defaultOptional, boolean defaultRequired) See setDefaultValues(boolean, boolean, boolean, boolean, boolean).
void	setDefaultValues(boolean nestedComplex, boolean nestedEntity, boolean defaultOptional, boolean defaultRequired, boolean skipConstraints) Recursively apply default values to any unset properties of this structure.
void	setDynamic(java.lang.String name, DataValue value) Add or change the value of a dynamic property.
void	setDynamicProperties(DataValueMap value) Set holds dynamic property values, for which metadata is not known in advance.
void	setNull(Property property) Set the value of a specified nullable property to null.
void	setOptionalValue(Property property, DataValue value) Set the optional value of a specified property.
void	setRequiredValue(Property property, DataValue value) Set the required value of a specified property.
void	setValuePath(java.lang.String value) Set the canonical path of this value relative to the service root URL.
void	unsetDataValue(Property property) Unset the value of a specified property, so that StructureBase.hasDataValue(property) will return false.

Methods inherited from class com.sap.cloud.server.odata.DataValue

cloneMutable, equals, getDataType, getTypeCode, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureBase

public StructureBase()

Method Detail

getDataValue

public DataValue getDataValue(PropertyPath path)

Get the value of a specified property path.

Throws:

UndefinedException if the property value was not previously set.

See Also:

StructureBase.hasDataValue.

Parameters:

path - The specified property path.

Returns:

(nullable) The property value, as an instance of the appropriate subclass of DataValue, or `null` if the property value is `null`.

getDynamic

public DataValue getDynamic(java.lang.String name)

Return (nullable) The value of a dynamic property, or null if no such property exists.

See Also:

StructureBase.dynamicProperties.

Parameters:

name - Name of a dynamic property.

Returns:

(nullable) The value of a dynamic property, or `null` if no such property exists.

getDynamicProperties

public DataValueMap getDynamicProperties()

Return holds dynamic property values, for which metadata is not known in advance.

See Also:

ComplexType.isOpenType, EntityType.isOpenType.

Returns:

Holds *dynamic* property values, for which metadata is not known in advance.

getNextLink

public java.lang.String getNextLink(PropertyPath path)

Get the next-link of a specified collection-typed property path.

See Also:

StructureBase.hasNextLink.

Parameters:

path - The specified property path.

Returns:

(nullable) The next-link, or `null` if there is no next link for the specified path.

getOptionalValue

public DataValue getOptionalValue(PropertyPath path)

Get the optional value of a specified property path.

Parameters:

path - The specified property path.

Returns:

(nullable) The property value, as an instance of the appropriate subclass of DataValue, or null if the property value is null or if the property value was not previously set.

getRequiredValue

public DataValue getRequiredValue(PropertyPath path)

Get the required value of a specified property path.

Throws:

UndefinedException if the property value was not previously set (or is null), CastException if the property value is null.

Parameters:

path - The specified property path.

Returns:

The property value, using the appropriate subclass of DataValue.

getStreamLink

public StreamLink getStreamLink(Property property)

Get the stream link for a specified stream property.

Throws:

UsageException if the property is not a stream property.

Parameters:

property - The specified stream property.

Returns:

The stream link.

getStructureType

public StructureType getStructureType()

Return the complex/entity type metadata for this value (StructureBase.dataType cast to StructureType).

Returns:

The complex/entity type metadata for this value (StructureBase.dataType cast to StructureType).

getValuePath

public java.lang.String getValuePath()

Return (nullable) The canonical path of this value relative to the service root URL. Used internally in URL construction. Should not be set explicitly.

Returns:

(nullable) The canonical path of this value relative to the service root URL.

hasDataType

public boolean hasDataType(DataType type)

Return true if this structure has the specified data type (or a subtype).

Parameters:

type - Specified data type.

Returns:

true if this structure has the specified data type (or a subtype).

hasDataValue

public boolean hasDataValue(Property property)

Return true if this structure contains an explicitly set value for the specified property (including null, if Property.isNullable).

Parameters:

property - The specified property.

Returns:

true if this structure contains an explicitly set value for the specified property (including null, if Property.isNullable).

hasDynamicProperties

public boolean hasDynamicProperties()

Return true if the structure has dynamic properties set.

Returns:

True if the structure has dynamic properties set.

hasNextLink

public boolean hasNextLink(Property property)

Return true if this structure contains a next-link for the specified collection-typed property.

Parameters:

property - The specified property.

Returns:

true if this structure contains a next-link for the specified collection-typed property.

isNewOrChanged

public abstract boolean isNewOrChanged(Property property)

Return true if the value of property property is new or changed.

See Also:

ComplexValue.isNewOrChanged, EntityValue.isNewOrChanged.

Parameters:

property - Structural property.

Returns:

`true` if the value of property `property` is new or changed.

isNull

public boolean isNull(Property property)

Return true if this structure contains an explicitly set null value for the specified property.

Throws:

UndefinedException if the property value was not previously set.

See Also:

StructureBase.hasDataValue.

Parameters:

property - The specified property.

Returns:

`true` if this structure contains an explicitly set `null` value for the specified property.

isProxy

public boolean isProxy()

Return is this structure an instance of a generated proxy class?

Returns:

Is this structure an instance of a generated proxy class?

setDataValue

public void setDataValue(Property property,
                         DataValue value)

Set the value of a specified property.

Throws:

CastException if the property value does not have the expected type.

Parameters:

property - The specified property.

value - (nullable) The property value (or `null`), using the appropriate subclass of DataValue.

setDefaultValues

public final void setDefaultValues()

See setDefaultValues(boolean, boolean, boolean, boolean, boolean).

setDefaultValues

public final void setDefaultValues(boolean nestedComplex)

See setDefaultValues(boolean, boolean, boolean, boolean, boolean).

Parameters:

nestedComplex - NestedComplex parameter.

setDefaultValues

public final void setDefaultValues(boolean nestedComplex,
                                   boolean nestedEntity)

See setDefaultValues(boolean, boolean, boolean, boolean, boolean).

Parameters:

nestedComplex - NestedComplex parameter.

nestedEntity - NestedEntity parameter.

setDefaultValues

public final void setDefaultValues(boolean nestedComplex,
                                   boolean nestedEntity,
                                   boolean defaultOptional)

See setDefaultValues(boolean, boolean, boolean, boolean, boolean).

Parameters:

nestedComplex - NestedComplex parameter.

nestedEntity - NestedEntity parameter.

defaultOptional - DefaultOptional parameter.

setDefaultValues

public final void setDefaultValues(boolean nestedComplex,
                                   boolean nestedEntity,
                                   boolean defaultOptional,
                                   boolean defaultRequired)

See setDefaultValues(boolean, boolean, boolean, boolean, boolean).

Parameters:

nestedComplex - NestedComplex parameter.

nestedEntity - NestedEntity parameter.

defaultOptional - DefaultOptional parameter.

defaultRequired - DefaultRequired parameter.

setDefaultValues

public final void setDefaultValues(boolean nestedComplex,
                                   boolean nestedEntity,
                                   boolean defaultOptional,
                                   boolean defaultRequired,
                                   boolean skipConstraints)

Recursively apply default values to any unset properties of this structure. If a property has a model-defined default value, it will always be applied (since that default value is part of a server's contract with the client, it must always be valid to apply it). If the property doesn't have a model-defined default value, then null will be used for nullable properties, and false/empty/zero values will be applied otherwise as appropriate. Dates will default to 2000-01-01.

See Also:

StructureBase.hasDataValue, Property.defaultValue, StructureType.structuralProperties, StructureType.navigationProperties.

Parameters:

nestedComplex - Apply recursively to complex-typed (structural) properties of this structure? Defaults to true.

nestedEntity - Apply recursively to entity-typed (navigation) properties of this structure? Defaults to false.

defaultOptional - Apply non-model-defined default values to optional (nullable) properties?

defaultRequired - Apply non-model-defined default values to required (non-nullable) properties?

skipConstraints - Avoid applying default values to properties which have a database-level default constraint.

setDynamic

public void setDynamic(java.lang.String name,
                       DataValue value)

Add or change the value of a dynamic property.

See Also:

StructureBase.dynamicProperties.

Parameters:

name - Name of a dynamic property.

value - (nullable) Value for the dynamic property.

setDynamicProperties

public void setDynamicProperties(DataValueMap value)

Set holds dynamic property values, for which metadata is not known in advance.

See Also:

ComplexType.isOpenType, EntityType.isOpenType.

Parameters:

value - Holds *dynamic* property values, for which metadata is not known in advance.

setNull

public void setNull(Property property)

Set the value of a specified nullable property to null.

Throws:

CastException if the property does not accept null values.

Parameters:

property - The specified property.

setOptionalValue

public void setOptionalValue(Property property,
                             DataValue value)

Set the optional value of a specified property. If a null value is provided and the property does not permit null values (Property.isNullable is false), then this is equivalent to calling unsetDataValue, otherwise it is equivalent to calling setDataValue.

Throws:

CastException if the property value does not have the expected type.

Parameters:

property - The specified property.

value - (nullable) The property value (or `null`), using the appropriate subclass of DataValue.

setRequiredValue

public void setRequiredValue(Property property,
                             DataValue value)

Set the required value of a specified property.

Throws:

CastException if the property value does not have the expected type.

Parameters:

property - The specified property.

value - The property value, using the appropriate subclass of DataValue.

setValuePath

public void setValuePath(java.lang.String value)

Set the canonical path of this value relative to the service root URL. Used internally in URL construction. Should not be set explicitly.

Parameters:

value - The canonical path of this value relative to the service root URL.

unsetDataValue

public void unsetDataValue(Property property)

Unset the value of a specified property, so that StructureBase.hasDataValue(property) will return false.

Parameters:

property - The specified property.