com.sap.client.odata.v4

Class EntityType

java.lang.Object

com.sap.client.odata.v4.DataType

com.sap.client.odata.v4.StructureType

com.sap.client.odata.v4.EntityType

public class EntityType
extends StructureType

Encapsulates the metadata of an OData entity type.

Field Summary

Fields

Modifier and Type	Field and Description
static EntityType	abstractBase
static EntityType	undefined

Fields inherited from class com.sap.client.odata.v4.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
EntityType()

Method Summary

Modifier and Type	Method and Description
int	getCode() DataType.ENTITY_VALUE
CustomPathList	getCustomPaths() For internal use only.
PropertyList	getKeyProperties() List of key properties for this type.
Property	getKeyProperty(java.lang.String name) Lookup a key property by name.
EntityTypeList	getSubtypes() (nullable) If EntityType.hasSubtypes is true, then the list of subtypes.
EntityType	getSupertype() (nullable) If EntityType.hasSupertype is true, then the parent entity type.
boolean	hasSubtypes() true if this entity type is a parent of one or more derived entity types.
boolean	hasSupertype() true if this entity type is a subtype of a parent entity type.
boolean	isMedia() true if this entity type is a media resource (has stream content).
void	registerFactory(ObjectFactory factory) Set the EntityType.objectFactory for this entity type.
void	setCustomPaths(CustomPathList value) For internal use only.
void	setKeyProperties(PropertyList value) List of key properties for this type.
void	setMedia(boolean value) true if this entity type is a media resource (has stream content).
void	setObjectFactoryWithClass(java.lang.Class<? extends EntityValue> cls)
void	setSubtypes(EntityTypeList value) If EntityType.hasSubtypes is true, then the list of subtypes.
void	setSupertype(EntityType value) If EntityType.hasSupertype is true, then the parent entity type.
java.lang.String	toString() Return the name of this data type.
EntityType	withFactory(ObjectFactory factory) Set the EntityType.objectFactory for this entity type.

Methods inherited from class com.sap.client.odata.v4.StructureType

getAnnotation, getAnnotationList, getAnnotationMap, getCanBeRemoved, getComplexProperties, getExtensionProperties, getLocalName, getName, getNavigationProperties, getObjectFactory, getProperty, getPropertyList, getPropertyMap, getQualifiedName, getStreamProperties, getStructuralProperties, isAbstract, isExtension, isInferred, isOpenType, isRemoved, setAbstract, setCanBeRemoved, setComplexProperties, setExtension, setExtensionProperties, setInferred, setLocalName, setNavigationProperties, setObjectFactory, setOpenType, setPropertyList, setPropertyMap, setQualifiedName, setRemoved, setStreamProperties, setStructuralProperties

Methods inherited from class com.sap.client.odata.v4.DataType

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

Methods inherited from class java.lang.Object

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

Field Detail

undefined

public static final EntityType undefined

abstractBase

public static final EntityType abstractBase

Constructor Detail

EntityType

public EntityType()

Method Detail

setObjectFactoryWithClass

public void setObjectFactoryWithClass(java.lang.Class<? extends EntityValue> cls)

getCode

public int getCode()

DataType.ENTITY_VALUE

Overrides:

getCode in class DataType

getCustomPaths

public CustomPathList getCustomPaths()

For internal use only.

getKeyProperties

public PropertyList getKeyProperties()

List of key properties for this type.

getKeyProperty

public Property getKeyProperty(java.lang.String name)

Lookup a key property by name.

See Also:

EntityType.keyProperties.

Parameters:

name - Name of the property.

Returns:

The property metadata. A DataException is thrown if the property does not exist in this type.

getSubtypes

public EntityTypeList getSubtypes()

(nullable) If EntityType.hasSubtypes is true, then the list of subtypes. Otherwise null.

getSupertype

public EntityType getSupertype()

(nullable) If EntityType.hasSupertype is true, then the parent entity type. Otherwise null.

hasSubtypes

public boolean hasSubtypes()

true if this entity type is a parent of one or more derived entity types.

hasSupertype

public boolean hasSupertype()

true if this entity type is a subtype of a parent entity type.

isMedia

public boolean isMedia()

true if this entity type is a media resource (has stream content).

registerFactory

public void registerFactory(ObjectFactory factory)

Set the EntityType.objectFactory for this entity type.

Parameters:

factory - Custom factory to produce EntityValue instances of this type.

setCustomPaths

public void setCustomPaths(CustomPathList value)

For internal use only.

setKeyProperties

public void setKeyProperties(PropertyList value)

List of key properties for this type.

setMedia

public void setMedia(boolean value)

true if this entity type is a media resource (has stream content).

setSubtypes

public void setSubtypes(EntityTypeList value)

If EntityType.hasSubtypes is true, then the list of subtypes. Otherwise null.

setSupertype

public void setSupertype(EntityType value)

If EntityType.hasSupertype is true, then the parent entity type. Otherwise null.

toString

public java.lang.String toString()

Return the name of this data type.

Overrides:

toString in class DataType

Returns:

The name of this data type.

withFactory

public EntityType withFactory(ObjectFactory factory)

Set the EntityType.objectFactory for this entity type.

Parameters:

factory - Custom factory to produce EntityValue instances of this type.

Returns:

This entity type.