Package com.sap.olingo.jpa.metadata.core.edm.mapper.api

Interface JPAEntityType

All Superinterfaces:

JPAElement, JPAStructuredType

public interface JPAEntityType
extends JPAStructuredType

Method Summary

Modifier and Type	Method	Description
JPACollectionAttribute	getCollectionAttribute(String externalName)	Searches for a Collection Property defined by the name used in the OData metadata in all the collection properties that are available for this type via the OData service.
String	getContentType()
JPAPath	getContentTypeAttributePath()
JPAPath	getEtagPath()
List<JPAAttribute>	getKey()	Returns a resolved list of all attributes that are marked as Id, so the attributes of an EmbeddedId are returned as separate entries.
List<JPAPath>	getKeyPath()	Returns a list of path of all attributes annotated as Id.
Class<?>	getKeyType()	Returns the class of the Key.
List<JPAPath>	getSearchablePath()
JPAPath	getStreamAttributePath()
String	getTableName()
boolean	hasCompoundKey()	True in case the entity type has a compound key, so an EmbeddedId or multiple id properties
boolean	hasEtag()
boolean	hasStream()
List<JPAPath>	searchChildPath(JPAPath selectItemPath)

Methods inherited from interface com.sap.olingo.jpa.metadata.core.edm.mapper.api.JPAElement

getExternalFQN, getExternalName, getInternalName

Methods inherited from interface com.sap.olingo.jpa.metadata.core.edm.mapper.api.JPAStructuredType

getAssociation, getAssociationPath, getAssociationPathList, getAttribute, getAttribute, getAttributes, getCollectionAttributesPath, getDeclaredAssociation, getDeclaredAssociation, getDeclaredAssociations, getDeclaredAttributes, getDeclaredCollectionAttributes, getPath, getPathList, getProtections, getTypeClass, isAbstract

Method Details

getCollectionAttribute

JPACollectionAttribute getCollectionAttribute(String externalName)
                                       throws ODataJPAModelException

Searches for a Collection Property defined by the name used in the OData metadata in all the collection properties that are available for this type via the OData service. That is:

• All not ignored collection properties of this type.
• All not ignored collection properties from super types.
• All not ignored collection properties from embedded types.

Parameters:

externalName -

Returns:

Throws:

ODataJPAModelException

getContentType

String getContentType()
               throws ODataJPAModelException

Returns:

Mime type of streaming content

Throws:

ODataJPAModelException

getContentTypeAttributePath

JPAPath getContentTypeAttributePath()
                             throws ODataJPAModelException

Throws:

ODataJPAModelException

getEtagPath

JPAPath getEtagPath()
             throws ODataJPAModelException

Throws:

ODataJPAModelException

getKey

List<JPAAttribute> getKey()
                   throws ODataJPAModelException

Returns a resolved list of all attributes that are marked as Id, so the attributes of an EmbeddedId are returned as separate entries. For compound keys has the opposite order of the attributes in the entity or embedded id respectively.

Returns:

Throws:

ODataJPAModelException

getKeyPath

List<JPAPath> getKeyPath()
                  throws ODataJPAModelException

Returns a list of path of all attributes annotated as Id. EmbeddedId are not resolved

Returns:

Throws:

ODataJPAModelException

getKeyType

Class<?> getKeyType()

Returns the class of the Key. This could by either a primitive type, the IdClass or the Embeddable of an EmbeddedId

Returns:

hasCompoundKey

boolean hasCompoundKey()

True in case the entity type has a compound key, so an EmbeddedId or multiple id properties

Returns:

getSearchablePath

List<JPAPath> getSearchablePath()
                         throws ODataJPAModelException

Returns:

Throws:

ODataJPAModelException

getStreamAttributePath

JPAPath getStreamAttributePath()
                        throws ODataJPAModelException

Throws:

ODataJPAModelException

getTableName

String getTableName()

Returns:

Name of the database table

hasEtag

boolean hasEtag()
         throws ODataJPAModelException

Throws:

ODataJPAModelException

hasStream

boolean hasStream()
           throws ODataJPAModelException

Throws:

ODataJPAModelException

searchChildPath

List<JPAPath> searchChildPath(JPAPath selectItemPath)