org.apache.olingo.commons.core.edm

Class AbstractEdm

java.lang.Object

org.apache.olingo.commons.core.edm.AbstractEdm

All Implemented Interfaces:

Edm

Direct Known Subclasses:

EdmProviderImpl

public abstract class AbstractEdm
extends Object
implements Edm

Field Summary

Fields

Modifier and Type	Field and Description
protected List<EdmSchema>	schemaList
protected Map<String,EdmSchema>	schemas

Constructor Summary

Constructors

Constructor and Description
AbstractEdm()

Method Summary

Modifier and Type	Method and Description
void	cacheAction(FullQualifiedName actionName, EdmAction action)
void	cacheAliasNamespaceInfo(String alias, String namespace)
void	cacheAnnotationGroup(FullQualifiedName targetName, EdmAnnotations annotationsGroup)
void	cacheComplexType(FullQualifiedName compelxTypeName, EdmComplexType complexType)
void	cacheEntityContainer(FullQualifiedName containerFQN, EdmEntityContainer container)
void	cacheEntityType(FullQualifiedName entityTypeName, EdmEntityType entityType)
void	cacheEnumType(FullQualifiedName enumName, EdmEnumType enumType)
void	cacheFunction(FullQualifiedName functionName, EdmFunction function)
void	cacheTerm(FullQualifiedName termName, EdmTerm term)
void	cacheTypeDefinition(FullQualifiedName typeDefName, EdmTypeDefinition typeDef)
protected abstract Map<String,String>	createAliasToNamespaceInfo()
protected abstract EdmAnnotations	createAnnotationGroup(FullQualifiedName targetName, String qualifier)
protected abstract EdmAction	createBoundAction(FullQualifiedName actionName, FullQualifiedName bindingParameterTypeName, Boolean isBindingParameterCollection)
protected abstract EdmFunction	createBoundFunction(FullQualifiedName functionName, FullQualifiedName bindingParameterTypeName, Boolean isBindingParameterCollection, List<String> parameterNames)
protected abstract EdmComplexType	createComplexType(FullQualifiedName complexTypeName)
protected abstract EdmEntityContainer	createEntityContainer(FullQualifiedName containerName)
protected abstract EdmEntityType	createEntityType(FullQualifiedName entityTypeName)
protected abstract EdmEnumType	createEnumType(FullQualifiedName enumName)
protected abstract Map<String,EdmSchema>	createSchemas()
protected abstract EdmTerm	createTerm(FullQualifiedName termName)
protected abstract EdmTypeDefinition	createTypeDefinition(FullQualifiedName typeDefinitionName)
protected abstract EdmAction	createUnboundAction(FullQualifiedName actionName)
protected abstract EdmFunction	createUnboundFunction(FullQualifiedName functionName, List<String> parameterNames)
protected abstract List<EdmFunction>	createUnboundFunctions(FullQualifiedName functionName)
EdmAnnotations	getAnnotationGroup(FullQualifiedName targetName, String qualifier) Get EdmAnnotations by target.
protected Map<String,List<CsdlAnnotation>>	getAnnotationsMap()
EdmAction	getBoundAction(FullQualifiedName actionName, FullQualifiedName bindingParameterTypeName, Boolean isBindingParameterCollection) Get Action by full qualified name and binding parameter type.
EdmAction	getBoundActionWithBindingType(FullQualifiedName bindingParameterTypeName, Boolean isBindingParameterCollection) Get Action by full qualified name and binding parameter type.
EdmFunction	getBoundFunction(FullQualifiedName functionName, FullQualifiedName bindingParameterTypeName, Boolean isBindingParameterCollection, List<String> parameterNames) Get Function by full qualified name and binding parameter type and binding parameter names.
List<EdmFunction>	getBoundFunctionsWithBindingType(FullQualifiedName bindingParameterTypeName, Boolean isBindingParameterCollection) Get Function by binding parameter type
EdmComplexType	getComplexType(FullQualifiedName namespaceOrAliasFQN) Get complex type by full qualified name..
EdmComplexType	getComplexTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN) Get complex type with annotations by full qualified name..
protected EdmComplexType	getComplexTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN, boolean isComplexDerivedFromES)
EdmEntityContainer	getEntityContainer() Get main entity container.
EdmEntityContainer	getEntityContainer(FullQualifiedName namespaceOrAliasFQN) Get entity container by full qualified name.
EdmEntityType	getEntityType(FullQualifiedName namespaceOrAliasFQN) Get entity type by full qualified name.
EdmEntityType	getEntityTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN) Get entity type with annotations by full qualified name.
protected EdmEntityType	getEntityTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN, boolean isEntityDerivedFromES)
EdmEnumType	getEnumType(FullQualifiedName namespaceOrAliasFQN) Get enum type by full qualified name.
EdmSchema	getSchema(String namespace) Get schema by namespace.
List<EdmSchema>	getSchemas() This method DOES NOT support lazy loading.
EdmTerm	getTerm(FullQualifiedName termName) Get Term full by qualified name.
EdmTypeDefinition	getTypeDefinition(FullQualifiedName namespaceOrAliasFQN) Get a type definition by full qualified name.
EdmAction	getUnboundAction(FullQualifiedName actionName) Get unbound Action by full qualified name.
EdmFunction	getUnboundFunction(FullQualifiedName functionName, List<String> parameterNames) Get Function by full qualified name.
List<EdmFunction>	getUnboundFunctions(FullQualifiedName functionName) Get Function by full qualified name.
protected boolean	isComplexDerivedFromES()
protected boolean	isEntityDerivedFromES()
protected boolean	isPreviousES()
protected void	setIsPreviousES(boolean isPreviousES)

Methods inherited from class java.lang.Object

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

Field Detail

schemas

protected Map<String,EdmSchema> schemas

schemaList

protected List<EdmSchema> schemaList

Constructor Detail

AbstractEdm

public AbstractEdm()

Method Detail

getSchemas

public List<EdmSchema> getSchemas()

Description copied from interface: Edm

This method DOES NOT support lazy loading. All schemas are loaded completely!

Specified by:

getSchemas in interface Edm

Returns:

all schemas defined for this EDM

getSchema

public EdmSchema getSchema(String namespace)

Description copied from interface: Edm

Get schema by namespace.

Specified by:

getSchema in interface Edm

Parameters:

namespace - must not be null

Returns:

EdmSchema

getEntityContainer

public EdmEntityContainer getEntityContainer()

Description copied from interface: Edm

Get main entity container.
See EdmEntityContainer for more information.

Specified by:

getEntityContainer in interface Edm

Returns:

EdmEntityContainer

getEntityContainer

public EdmEntityContainer getEntityContainer(FullQualifiedName namespaceOrAliasFQN)

Description copied from interface: Edm

Get entity container by full qualified name.
See EdmEntityContainer for more information.

Specified by:

getEntityContainer in interface Edm

Parameters:

namespaceOrAliasFQN - full qualified name of entity container

Returns:

EdmEntityContainer

getEnumType

public EdmEnumType getEnumType(FullQualifiedName namespaceOrAliasFQN)

Description copied from interface: Edm

Get enum type by full qualified name.
See EdmEnumType for more information

Specified by:

getEnumType in interface Edm

Parameters:

namespaceOrAliasFQN - full qualified name of enum type

Returns:

EdmEnumType

getTypeDefinition

public EdmTypeDefinition getTypeDefinition(FullQualifiedName namespaceOrAliasFQN)

Description copied from interface: Edm

Get a type definition by full qualified name.
See EdmTypeDefinition for more information

Specified by:

getTypeDefinition in interface Edm

Parameters:

namespaceOrAliasFQN - full qualified name of type definition

Returns:

EdmTypeDefinition

getEntityType

public EdmEntityType getEntityType(FullQualifiedName namespaceOrAliasFQN)

Description copied from interface: Edm

Get entity type by full qualified name.
See EdmEntityType for more information.

Specified by:

getEntityType in interface Edm

Parameters:

namespaceOrAliasFQN - full qualified name of entity type

Returns:

EdmEntityType

getEntityTypeWithAnnotations

public EdmEntityType getEntityTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN)

Description copied from interface: Edm

Get entity type with annotations by full qualified name.
See EdmEntityType for more information.

Specified by:

getEntityTypeWithAnnotations in interface Edm

Parameters:

namespaceOrAliasFQN - full qualified name of entity type

Returns:

EdmEntityType

getEntityTypeWithAnnotations

protected EdmEntityType getEntityTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN,
                                                     boolean isEntityDerivedFromES)

getComplexTypeWithAnnotations

protected EdmComplexType getComplexTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN,
                                                       boolean isComplexDerivedFromES)

getComplexType

public EdmComplexType getComplexType(FullQualifiedName namespaceOrAliasFQN)

Description copied from interface: Edm

Get complex type by full qualified name..
See EdmComplexType for more information.

Specified by:

getComplexType in interface Edm

Parameters:

namespaceOrAliasFQN - full qualified name of complex type

Returns:

EdmComplexType

getComplexTypeWithAnnotations

public EdmComplexType getComplexTypeWithAnnotations(FullQualifiedName namespaceOrAliasFQN)

Description copied from interface: Edm

Get complex type with annotations by full qualified name..
See EdmComplexType for more information.

Specified by:

getComplexTypeWithAnnotations in interface Edm

Parameters:

namespaceOrAliasFQN - full qualified name of complex type

Returns:

EdmComplexType

getUnboundAction

public EdmAction getUnboundAction(FullQualifiedName actionName)

Description copied from interface: Edm

Get unbound Action by full qualified name.

Specified by:

getUnboundAction in interface Edm

Parameters:

actionName - must not be null

Returns:

EdmAction

getBoundAction

public EdmAction getBoundAction(FullQualifiedName actionName,
                                FullQualifiedName bindingParameterTypeName,
                                Boolean isBindingParameterCollection)

Description copied from interface: Edm

Get Action by full qualified name and binding parameter type.

Specified by:

getBoundAction in interface Edm

Parameters:

actionName - must not be null

bindingParameterTypeName - must not be null

isBindingParameterCollection - may be null

Returns:

EdmAction

getUnboundFunctions

public List<EdmFunction> getUnboundFunctions(FullQualifiedName functionName)

Description copied from interface: Edm

Get Function by full qualified name.

Specified by:

getUnboundFunctions in interface Edm

Parameters:

functionName - must not be null

Returns:

EdmFunction

getUnboundFunction

public EdmFunction getUnboundFunction(FullQualifiedName functionName,
                                      List<String> parameterNames)

Description copied from interface: Edm

Get Function by full qualified name.

Specified by:

getUnboundFunction in interface Edm

Parameters:

functionName - must not be null

parameterNames - may be null: in this case it is considered as empty

Returns:

EdmFunction

getBoundFunction

public EdmFunction getBoundFunction(FullQualifiedName functionName,
                                    FullQualifiedName bindingParameterTypeName,
                                    Boolean isBindingParameterCollection,
                                    List<String> parameterNames)

Description copied from interface: Edm

Get Function by full qualified name and binding parameter type and binding parameter names.

Specified by:

getBoundFunction in interface Edm

Parameters:

functionName - must not be null

bindingParameterTypeName - must not be null

isBindingParameterCollection - may be null

parameterNames - may be null: in this case it is considered as empty

Returns:

EdmFunction

getTerm

public EdmTerm getTerm(FullQualifiedName termName)

Description copied from interface: Edm

Get Term full by qualified name.

Specified by:

getTerm in interface Edm

Parameters:

termName - must not be null

Returns:

EdmTerm

getAnnotationGroup

public EdmAnnotations getAnnotationGroup(FullQualifiedName targetName,
                                         String qualifier)

Description copied from interface: Edm

Get EdmAnnotations by target.

Specified by:

getAnnotationGroup in interface Edm

Parameters:

targetName - edm:Annotations target

qualifier - for the target. Can be NULL

Returns:

EdmAnnotations

createSchemas

protected abstract Map<String,EdmSchema> createSchemas()

createAliasToNamespaceInfo

protected abstract Map<String,String> createAliasToNamespaceInfo()

cacheAliasNamespaceInfo

public void cacheAliasNamespaceInfo(String alias,
                                    String namespace)

createEntityContainer

protected abstract EdmEntityContainer createEntityContainer(FullQualifiedName containerName)

cacheEntityContainer

public void cacheEntityContainer(FullQualifiedName containerFQN,
                                 EdmEntityContainer container)

createEnumType

protected abstract EdmEnumType createEnumType(FullQualifiedName enumName)

cacheEnumType

public void cacheEnumType(FullQualifiedName enumName,
                          EdmEnumType enumType)

createTypeDefinition

protected abstract EdmTypeDefinition createTypeDefinition(FullQualifiedName typeDefinitionName)

cacheTypeDefinition

public void cacheTypeDefinition(FullQualifiedName typeDefName,
                                EdmTypeDefinition typeDef)

createEntityType

protected abstract EdmEntityType createEntityType(FullQualifiedName entityTypeName)

cacheEntityType

public void cacheEntityType(FullQualifiedName entityTypeName,
                            EdmEntityType entityType)

createComplexType

protected abstract EdmComplexType createComplexType(FullQualifiedName complexTypeName)

cacheComplexType

public void cacheComplexType(FullQualifiedName compelxTypeName,
                             EdmComplexType complexType)

createUnboundAction

protected abstract EdmAction createUnboundAction(FullQualifiedName actionName)

createUnboundFunctions

protected abstract List<EdmFunction> createUnboundFunctions(FullQualifiedName functionName)

createUnboundFunction

protected abstract EdmFunction createUnboundFunction(FullQualifiedName functionName,
                                                     List<String> parameterNames)

createBoundAction

protected abstract EdmAction createBoundAction(FullQualifiedName actionName,
                                               FullQualifiedName bindingParameterTypeName,
                                               Boolean isBindingParameterCollection)

createBoundFunction

protected abstract EdmFunction createBoundFunction(FullQualifiedName functionName,
                                                   FullQualifiedName bindingParameterTypeName,
                                                   Boolean isBindingParameterCollection,
                                                   List<String> parameterNames)

cacheFunction

public void cacheFunction(FullQualifiedName functionName,
                          EdmFunction function)

cacheAction

public void cacheAction(FullQualifiedName actionName,
                        EdmAction action)

createTerm

protected abstract EdmTerm createTerm(FullQualifiedName termName)

cacheTerm

public void cacheTerm(FullQualifiedName termName,
                      EdmTerm term)

createAnnotationGroup

protected abstract EdmAnnotations createAnnotationGroup(FullQualifiedName targetName,
                                                        String qualifier)

cacheAnnotationGroup

public void cacheAnnotationGroup(FullQualifiedName targetName,
                                 EdmAnnotations annotationsGroup)

getBoundActionWithBindingType

public EdmAction getBoundActionWithBindingType(FullQualifiedName bindingParameterTypeName,
                                               Boolean isBindingParameterCollection)

Description copied from interface: Edm

Get Action by full qualified name and binding parameter type. Note: action can not be overloaded on binding type

Specified by:

getBoundActionWithBindingType in interface Edm

Parameters:

bindingParameterTypeName - must not be null

isBindingParameterCollection - may be null

Returns:

EdmAction

getBoundFunctionsWithBindingType

public List<EdmFunction> getBoundFunctionsWithBindingType(FullQualifiedName bindingParameterTypeName,
                                                          Boolean isBindingParameterCollection)

Description copied from interface: Edm

Get Function by binding parameter type

Specified by:

getBoundFunctionsWithBindingType in interface Edm

Parameters:

bindingParameterTypeName - must not be null

isBindingParameterCollection - may be null

Returns:

EdmFunction

isEntityDerivedFromES

protected boolean isEntityDerivedFromES()

isComplexDerivedFromES

protected boolean isComplexDerivedFromES()

setIsPreviousES

protected void setIsPreviousES(boolean isPreviousES)

isPreviousES

protected boolean isPreviousES()

getAnnotationsMap

protected Map<String,List<CsdlAnnotation>> getAnnotationsMap()