com.sap.cloud.server.odata

Class StructureType

java.lang.Object

com.sap.cloud.server.odata.DataType

com.sap.cloud.server.odata.StructureType

Direct Known Subclasses:

ComplexType, EntityType

public abstract class StructureType
extends DataType

Common base class for ComplexType and EntityType.

Field Summary

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

ANNOTATION_PATH, BINARY, BOOLEAN, BYTE, BYTE_STREAM, CHAR, CHAR_STREAM, CODE_UNKNOWN, COMPLEX_VALUE, COMPLEX_VALUE_LIST, DATA_VALUE_LIST, DAY_TIME_DURATION, DECIMAL, DELTA_STREAM, DOUBLE, DYNAMIC_PATH, EDM_PRIMITIVE, ENTITY_VALUE, ENTITY_VALUE_LIST, ENUM_VALUE, FLOAT, GEOGRAPHY_COLLECTION, GEOGRAPHY_LINE_STRING, GEOGRAPHY_MULTI_LINE_STRING, GEOGRAPHY_MULTI_POINT, GEOGRAPHY_MULTI_POLYGON, GEOGRAPHY_POINT, GEOGRAPHY_POLYGON, GEOGRAPHY_VALUE, GEOMETRY_COLLECTION, GEOMETRY_LINE_STRING, GEOMETRY_MULTI_LINE_STRING, GEOMETRY_MULTI_POINT, GEOMETRY_MULTI_POLYGON, GEOMETRY_POINT, GEOMETRY_POLYGON, GEOMETRY_VALUE, GLOBAL_DATE_TIME, GUID_VALUE, INT, INTEGER, LIST, LOCAL_DATE, LOCAL_DATE_TIME, LOCAL_TIME, LONG, NAVIGATION_PATH, OBJECT, PATH, PATH_EXPRESSION, PROPERTY_PATH, QUERY_ALIAS, QUERY_FILTER, QUERY_FUNCTION_CALL, QUERY_OPERATOR_CALL, SHORT, STREAM_LINK, STRING, STRUCTURAL_PATH, TARGET_PATH, unknown, UNSIGNED_BYTE, UNSIGNED_INT, UNSIGNED_LONG, UNSIGNED_SHORT, YEAR_MONTH_DURATION

Constructor Summary

Constructors

Constructor and Description
StructureType()

Method Summary

Modifier and Type	Method and Description
Annotation	getAnnotation(java.lang.String term) Lookup an existing annotation by term name, or throw an exception if the annotation is not found.
AnnotationMap	getAnnotations() Return map of annotations for this model element.
boolean	getCanBeRemoved() Return can this model element be removed by DataService.refreshMetadata.
PropertyList	getCollectionProperties() Return list of collection-typed properties for this type (both structural and navigation properties may be included).
PropertyList	getComplexProperties() Return list of complex properties for this type (a subset of StructureType.structuralProperties).
PropertyList	getExtensionProperties() Return list of extension properties for this type.
java.lang.String	getLocalName() Return the local name of this type within its owning DataSchema, e.g.
java.lang.String	getName() Return synonym for StructureType.qualifiedName.
PropertyList	getNavigationProperties() Return list of navigation properties for this type.
com.sap.cloud.server.odata.core.ObjectFactory	getObjectFactory() Return (nullable) Factory for creating custom (subclass) objects with this type.
Property	getProperty(java.lang.String name) Lookup an existing property by name.
PropertyList	getPropertyList() Return list of stream, structural and navigation properties for this type.
PropertyMap	getPropertyMap() Return map of stream, structural and navigation properties for this type.
java.lang.String	getQualifiedName() Return the name of this type qualified by its owning DataSchema name, e.g.
int	getSourceLine() Return source line number for this schema element within its defining schema.
PropertyList	getStreamProperties() Return list of stream properties for this type.
PropertyList	getStructuralProperties() Return list of structural properties for this type.
boolean	isAbstract() Return true if this is an abstract type.
boolean	isExtension() Return true if this type was added since metadata was originally loaded.
boolean	isHidden() Return indicates that the type is intended to be hidden for client side
boolean	isInferred() Return true if this structure type was inferred due to a missing term definition in the CSDL.
boolean	isOpenType() Return true if this is an open type.
boolean	isRemoved() Return has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
void	setAbstract(boolean value) Set true if this is an abstract type.
void	setCanBeRemoved(boolean value) Set can this model element be removed by DataService.refreshMetadata.
void	setCollectionProperties(PropertyList value) Set list of collection-typed properties for this type (both structural and navigation properties may be included).
void	setComplexProperties(PropertyList value) Set list of complex properties for this type (a subset of StructureType.structuralProperties).
void	setExtension(boolean value) Set true if this type was added since metadata was originally loaded.
void	setExtensionProperties(PropertyList value) Set list of extension properties for this type.
void	setHidden(boolean value) Set indicates that the type is intended to be hidden for client side
void	setInferred(boolean value) Set true if this structure type was inferred due to a missing term definition in the CSDL.
void	setLocalName(java.lang.String value) Set the local name of this type within its owning DataSchema, e.g.
void	setNavigationProperties(PropertyList value) Set list of navigation properties for this type.
void	setObjectFactory(com.sap.cloud.server.odata.core.ObjectFactory value) Set factory for creating custom (subclass) objects with this type.
void	setOpenType(boolean value) Set true if this is an open type.
void	setPropertyList(PropertyList value) Set list of stream, structural and navigation properties for this type.
void	setPropertyMap(PropertyMap value) Set map of stream, structural and navigation properties for this type.
void	setQualifiedName(java.lang.String value) Set the name of this type qualified by its owning DataSchema name, e.g.
void	setRemoved(boolean value) Set has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.
void	setSourceLine(int value) Set source line number for this schema element within its defining schema.
void	setStreamProperties(PropertyList value) Set list of stream properties for this type.
void	setStructuralProperties(PropertyList value) Set list of structural properties for this type.

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

forCode, forName, getBaseType, getCode, getItemType, isBasic, isBasicList, isCalendar, isComplex, isComplexList, isDerived, isEntity, isEntityList, isEnum, isEnumList, isGeography, isGeometry, isGeospatial, isGuid, isList, isNumber, isPath, isStream, isUnsigned, listOf, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

StructureType

public StructureType()

Method Detail

getAnnotation

public Annotation getAnnotation(java.lang.String term)

Lookup an existing annotation by term name, or throw an exception if the annotation is not found.

See Also:

StructureType.annotations and AnnotationMap.get, for looking up annotations that might not exist.

Parameters:

term - The term name.

Returns:

The annotation.

getAnnotations

public AnnotationMap getAnnotations()

Return map of annotations for this model element. For annotations without qualifiers, the entry key is the annotation term name. For annotations with qualifiers, the entry key is the annotation term name, then "#", then the annotation qualifier.

See Also:

Annotation, AnnotationTerm.

Returns:

Map of annotations for this model element.

getCanBeRemoved

public boolean getCanBeRemoved()

Return can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.

See Also:

StructureType.isRemoved.

Returns:

Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.

getCollectionProperties

public PropertyList getCollectionProperties()

Return list of collection-typed properties for this type (both structural and navigation properties may be included).

Returns:

List of collection-typed properties for this type (both structural and navigation properties may be included).

getComplexProperties

public PropertyList getComplexProperties()

Return list of complex properties for this type (a subset of StructureType.structuralProperties).

Returns:

List of complex properties for this type (a subset of StructureType.structuralProperties).

getExtensionProperties

public PropertyList getExtensionProperties()

Return list of extension properties for this type. Includes extension structural/navigation properties.

See Also:

Property.isExtension.

Returns:

List of extension properties for this type.

getLocalName

public java.lang.String getLocalName()

Return the local name of this type within its owning DataSchema, e.g. "MyType".

Returns:

The local name of this type within its owning DataSchema, e.g. "MyType".

getName

public java.lang.String getName()

Return synonym for StructureType.qualifiedName.

Overrides:

getName in class DataType

Returns:

Synonym for StructureType.qualifiedName.

getNavigationProperties

public PropertyList getNavigationProperties()

Return list of navigation properties for this type.

See Also:

Property.isNavigation.

Returns:

List of navigation properties for this type.

getObjectFactory

public com.sap.cloud.server.odata.core.ObjectFactory getObjectFactory()

Return (nullable) Factory for creating custom (subclass) objects with this type.

Returns:

(nullable) Factory for creating custom (subclass) objects with this type.

getProperty

public Property getProperty(java.lang.String name)

Lookup an existing property by name. If the property does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up propery before calling this method like in the following code snippet:

Example checking if a property exists:

 public void checkPropertyExistsExample() {
     DataService service = this.getService();
     EntitySet entitySet = service.getEntitySet("Employees");
     EntityType entityType = entitySet.getEntityType();
     PropertyMap propMap = entityType.getPropertyMap();
     if (propMap.keys().includes("BirthDate")) {
         Ignore.valueOf_any(entityType.getProperty("BirthDate"));
     } else {
     }
 }
 

See Also:

StructureType.propertyMap, for looking up properties that might not exist.

Parameters:

name - Name of the property.

Returns:

The property metadata, which MUST exists.

getPropertyList

public PropertyList getPropertyList()

Return list of stream, structural and navigation properties for this type.

Returns:

List of stream, structural and navigation properties for this type.

getPropertyMap

public PropertyMap getPropertyMap()

Return map of stream, structural and navigation properties for this type.

Returns:

Map of stream, structural and navigation properties for this type.

getQualifiedName

public java.lang.String getQualifiedName()

Return the name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".

Returns:

The name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".

getSourceLine

public int getSourceLine()

Return source line number for this schema element within its defining schema.

Returns:

Source line number for this schema element within its defining schema.

getStreamProperties

public PropertyList getStreamProperties()

Return list of stream properties for this type.

Returns:

List of stream properties for this type.

getStructuralProperties

public PropertyList getStructuralProperties()

Return list of structural properties for this type.

See Also:

Property.isStructural.

Returns:

List of structural properties for this type.

isAbstract

public boolean isAbstract()

Return true if this is an abstract type.

Returns:

true if this is an abstract type.

isExtension

public boolean isExtension()

Return true if this type was added since metadata was originally loaded.

Returns:

true if this type was added since metadata was originally loaded.

isHidden

public boolean isHidden()

Return indicates that the type is intended to be hidden for client side

Returns:

Indicates that the type is intended to be hidden for client side

isInferred

public boolean isInferred()

Return true if this structure type was inferred due to a missing term definition in the CSDL.

Returns:

true if this structure type was inferred due to a missing term definition in the CSDL.

isOpenType

public boolean isOpenType()

Return true if this is an open type. An open type can have dynamic properties.

Returns:

true if this is an open type. An open type can have dynamic properties.

isRemoved

public boolean isRemoved()

Return has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.

See Also:

StructureType.canBeRemoved.

Returns:

Has this model element been removed by a successful call to `DataService.refreshMetadata`?

setAbstract

public void setAbstract(boolean value)

Set true if this is an abstract type.

Parameters:

value - true if this is an abstract type.

setCanBeRemoved

public void setCanBeRemoved(boolean value)

Set can this model element be removed by DataService.refreshMetadata. Defaults to false. Set this to true to indicate that the application is coded to be able able to function correctly without this model element.

See Also:

StructureType.isRemoved.

Parameters:

value - Can this model element be removed by `DataService.refreshMetadata`. Defaults to `false`.

setCollectionProperties

public void setCollectionProperties(PropertyList value)

Set list of collection-typed properties for this type (both structural and navigation properties may be included).

Parameters:

value - List of collection-typed properties for this type (both structural and navigation properties may be included).

setComplexProperties

public void setComplexProperties(PropertyList value)

Set list of complex properties for this type (a subset of StructureType.structuralProperties).

Parameters:

value - List of complex properties for this type (a subset of StructureType.structuralProperties).

setExtension

public void setExtension(boolean value)

Set true if this type was added since metadata was originally loaded.

Parameters:

value - true if this type was added since metadata was originally loaded.

setExtensionProperties

public void setExtensionProperties(PropertyList value)

Set list of extension properties for this type. Includes extension structural/navigation properties.

See Also:

Property.isExtension.

Parameters:

value - List of extension properties for this type.

setHidden

public void setHidden(boolean value)

Set indicates that the type is intended to be hidden for client side

Parameters:

value - Indicates that the type is intended to be hidden for client side

setInferred

public void setInferred(boolean value)

Set true if this structure type was inferred due to a missing term definition in the CSDL.

Parameters:

value - true if this structure type was inferred due to a missing term definition in the CSDL.

setLocalName

public void setLocalName(java.lang.String value)

Set the local name of this type within its owning DataSchema, e.g. "MyType".

Parameters:

value - The local name of this type within its owning DataSchema, e.g. "MyType".

setNavigationProperties

public void setNavigationProperties(PropertyList value)

Set list of navigation properties for this type.

See Also:

Property.isNavigation.

Parameters:

value - List of navigation properties for this type.

setObjectFactory

public void setObjectFactory(com.sap.cloud.server.odata.core.ObjectFactory value)

Set factory for creating custom (subclass) objects with this type.

Parameters:

value - Factory for creating custom (subclass) objects with this type.

setOpenType

public void setOpenType(boolean value)

Set true if this is an open type. An open type can have dynamic properties.

Parameters:

value - true if this is an open type. An open type can have dynamic properties.

setPropertyList

public void setPropertyList(PropertyList value)

Set list of stream, structural and navigation properties for this type.

Parameters:

value - List of stream, structural and navigation properties for this type.

setPropertyMap

public void setPropertyMap(PropertyMap value)

Set map of stream, structural and navigation properties for this type.

Parameters:

value - Map of stream, structural and navigation properties for this type.

setQualifiedName

public void setQualifiedName(java.lang.String value)

Set the name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".

Parameters:

value - The name of this type qualified by its owning DataSchema name, e.g. "MySchema.MyType".

setRemoved

public void setRemoved(boolean value)

Set has this model element been removed by a successful call to DataService.refreshMetadata? If `isRemoved == true, that implies that the old metadata (before refreshMetadata was called) did include this model element, and that the new metadata (after refreshMetadata was called) does not include this model element.

See Also:

StructureType.canBeRemoved.

Parameters:

value - Has this model element been removed by a successful call to `DataService.refreshMetadata`?

setSourceLine

public void setSourceLine(int value)

Set source line number for this schema element within its defining schema.

Parameters:

value - Source line number for this schema element within its defining schema.

setStreamProperties

public void setStreamProperties(PropertyList value)

Set list of stream properties for this type.

Parameters:

value - List of stream properties for this type.

setStructuralProperties

public void setStructuralProperties(PropertyList value)

Set list of structural properties for this type.

See Also:

Property.isStructural.

Parameters:

value - List of structural properties for this type.