org.apache.olingo.odata2.api.edm.provider
Class EdmProvider

java.lang.Object
  extended by org.apache.olingo.odata2.api.edm.provider.EdmProvider
Direct Known Subclasses:
ScenarioEdmProvider

public abstract class EdmProvider
extends Object

Default EDM Provider which is to be extended by the application


Constructor Summary
EdmProvider()
           
 
Method Summary
 List<AliasInfo> getAliasInfos()
          This method should return a list of all defined aliases and their associated namespace.
 Association getAssociation(FullQualifiedName edmFQName)
          This method should return an Association or null if nothing is found
 AssociationSet getAssociationSet(String entityContainer, FullQualifiedName association, String sourceEntitySetName, String sourceEntitySetRole)
          This method should return an AssociationSet or null if nothing is found
 ComplexType getComplexType(FullQualifiedName edmFQName)
          This method should return a ComplexType or null if nothing is found
 EntityContainerInfo getEntityContainerInfo(String name)
          This method should return an EntityContainerInfo or null if nothing is found
 EntitySet getEntitySet(String entityContainer, String name)
          This method should return an EntitySet or null if nothing is found
 EntityType getEntityType(FullQualifiedName edmFQName)
          This method should return an EntityType or null if nothing is found
 FunctionImport getFunctionImport(String entityContainer, String name)
          This method should return a FunctionImport or null if nothing is found
 List<Schema> getSchemas()
          This method should return a collection of all Schema or null if nothing is found
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EdmProvider

public EdmProvider()
Method Detail

getEntityContainerInfo

public EntityContainerInfo getEntityContainerInfo(String name)
                                           throws ODataException
This method should return an EntityContainerInfo or null if nothing is found

Parameters:
name - (null for default container)
Returns:
EntityContainerInfo for the given name
Throws:
ODataException

getEntityType

public EntityType getEntityType(FullQualifiedName edmFQName)
                         throws ODataException
This method should return an EntityType or null if nothing is found

Parameters:
edmFQName -
Returns:
EntityType for the given name
Throws:
ODataException

getComplexType

public ComplexType getComplexType(FullQualifiedName edmFQName)
                           throws ODataException
This method should return a ComplexType or null if nothing is found

Parameters:
edmFQName -
Returns:
ComplexType for the given name
Throws:
ODataException

getAssociation

public Association getAssociation(FullQualifiedName edmFQName)
                           throws ODataException
This method should return an Association or null if nothing is found

Parameters:
edmFQName -
Returns:
Association for the given name
Throws:
ODataException

getEntitySet

public EntitySet getEntitySet(String entityContainer,
                              String name)
                       throws ODataException
This method should return an EntitySet or null if nothing is found

Parameters:
entityContainer -
name -
Returns:
EntitySet for the given container name and entity set name
Throws:
ODataException

getAssociationSet

public AssociationSet getAssociationSet(String entityContainer,
                                        FullQualifiedName association,
                                        String sourceEntitySetName,
                                        String sourceEntitySetRole)
                                 throws ODataException
This method should return an AssociationSet or null if nothing is found

Parameters:
entityContainer -
association -
sourceEntitySetName -
sourceEntitySetRole -
Returns:
AssociationSet for the given container name, association name, source entity set name and source entity set role
Throws:
ODataException

getFunctionImport

public FunctionImport getFunctionImport(String entityContainer,
                                        String name)
                                 throws ODataException
This method should return a FunctionImport or null if nothing is found

Parameters:
entityContainer -
name -
Returns:
FunctionImport for the given container name and function import name
Throws:
ODataException

getSchemas

public List<Schema> getSchemas()
                        throws ODataException
This method should return a collection of all Schema or null if nothing is found

Returns:
List<Schema>
Throws:
ODataException

getAliasInfos

public List<AliasInfo> getAliasInfos()
                              throws ODataException
This method should return a list of all defined aliases and their associated namespace. If not implemented aliases cannot be resolved

Returns:
List<AliasInfo>
Throws:
ODataException


Copyright © 2013-2015 The Apache Software Foundation. All Rights Reserved.