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

Interface JPAStructuredType

All Superinterfaces:

JPAElement

All Known Subinterfaces:

JPAEntityType

public interface JPAStructuredType
extends JPAElement

External view on an Intermediate Structured Type.

Author:

Oliver Grande

Method Summary

Modifier and Type	Method	Description
JPAAssociationAttribute	getAssociation(String internalName)
JPAAssociationPath	getAssociationPath(String externalName)	Searches for an AssociationPath defined by the name used in the OData metadata in all the navigation properties that are available for this type via the OData service.
List<JPAAssociationPath>	getAssociationPathList()	Searches in the navigation properties that are available for this type via the OData service.
JPAAttribute	getAttribute(String internalName)
JPAAttribute	getAttribute(org.apache.olingo.server.api.uri.UriResourceProperty uriResourceItem)
List<JPAAttribute>	getAttributes()
List<JPAPath>	getCollectionAttributesPath()	List of the path to all collection properties of this type.
JPAAssociationPath	getDeclaredAssociation(JPAAssociationPath associationPath)	In case the type is within the given association path, the sub-path is returned.
JPAAssociationPath	getDeclaredAssociation(String externalName)
List<JPAAssociationAttribute>	getDeclaredAssociations()	List of all associations that are declared at this type.
List<JPAAttribute>	getDeclaredAttributes()	List of all associations that are declared at this type.
List<JPACollectionAttribute>	getDeclaredCollectionAttributes()	List of all associations that are declared at this type.
JPAPath	getPath(String externalName)	List of all associations that are declared at this type.
List<JPAPath>	getPathList()	List of all attributes that are available for this type via the OData service.
List<JPAProtectionInfo>	getProtections()	List of all protected Attributes including protection/claim information.
Class<?>	getTypeClass()
boolean	isAbstract()

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

getExternalFQN, getExternalName, getInternalName

Method Details

getAssociation

JPAAssociationAttribute getAssociation(String internalName)
                                throws ODataJPAModelException

Throws:

ODataJPAModelException

getAssociationPath

JPAAssociationPath getAssociationPath(String externalName)
                               throws ODataJPAModelException

Searches for an AssociationPath defined by the name used in the OData metadata in all the navigation properties that are available for this type via the OData service. That is:

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

Parameters:

externalName -

Returns:

Throws:

ODataJPAModelException

getAssociationPathList

List<JPAAssociationPath> getAssociationPathList()
                                         throws ODataJPAModelException

Searches in the navigation properties that are available for this type via the OData service. That is:

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

Returns:

null if no navigation property found.

Throws:

ODataJPAModelException

getAttribute

@CheckForNull
JPAAttribute getAttribute(String internalName)
                   throws ODataJPAModelException

Throws:

ODataJPAModelException

getAttribute

JPAAttribute getAttribute(org.apache.olingo.server.api.uri.UriResourceProperty uriResourceItem)
                   throws ODataJPAModelException

Throws:

ODataJPAModelException

getAttributes

List<JPAAttribute> getAttributes()
                          throws ODataJPAModelException

Throws:

ODataJPAModelException

getCollectionAttributesPath

List<JPAPath> getCollectionAttributesPath()
                                   throws ODataJPAModelException

List of the path to all collection properties of this type. 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.

Returns:

Throws:

ODataJPAModelException

getDeclaredAssociation

JPAAssociationPath getDeclaredAssociation(JPAAssociationPath associationPath)
                                   throws ODataJPAModelException

In case the type is within the given association path, the sub-path is returned. E.g. structured type is AdministrativeInformation and associationPath = AdministrativeInformation/Created/User Created/User is returned.

Parameters:

associationPath -

Returns:

Throws:

ODataJPAModelException

getDeclaredAssociation

JPAAssociationPath getDeclaredAssociation(String externalName)
                                   throws ODataJPAModelException

Throws:

ODataJPAModelException

getDeclaredAssociations

List<JPAAssociationAttribute> getDeclaredAssociations()
                                               throws ODataJPAModelException

List of all associations that are declared at this type. That is:

• All navigation properties of this type.
• All navigation properties from super types.

Returns:

Throws:

ODataJPAModelException

getDeclaredAttributes

List<JPAAttribute> getDeclaredAttributes()
                                  throws ODataJPAModelException

List of all associations that are declared at this type. That is:

• All properties of this type.
• All properties from super types.

Returns:

Throws:

ODataJPAModelException

getDeclaredCollectionAttributes

List<JPACollectionAttribute> getDeclaredCollectionAttributes()
                                                      throws ODataJPAModelException

List of all associations that are declared at this type. That is:

• All collection properties of this type.
• All collection properties from super types.

Returns:

Throws:

ODataJPAModelException

getPath

JPAPath getPath(String externalName)
         throws ODataJPAModelException

List of all associations that are declared at this type. That is:

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

Returns:

Throws:

ODataJPAModelException

getPathList

List<JPAPath> getPathList()
                   throws ODataJPAModelException

List of all attributes that are available for this type via the OData service. That is:

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

Returns:

List of all attributes that are available via the OData service.

Throws:

ODataJPAModelException

getProtections

List<JPAProtectionInfo> getProtections()
                                throws ODataJPAModelException

List of all protected Attributes including protection/claim information. That is:

• All not ignored protected properties of the type.
• All not ignored protected properties from super types.
• All not ignored protected properties from embedded types.

Returns:

Throws:

ODataJPAModelException

getTypeClass

Class<?> getTypeClass()

isAbstract

boolean isAbstract()