public class

MetadataProducer

extends Object
implements ODataProducer
java.lang.Object
   ↳ org.odata4j.producer.edm.MetadataProducer

Class Overview

A producer for $metadata.

This is somewhat brute-forceish. There is maybe a world where an enhanced InMemoryProducer and the org.odata4j.edm pojos together are sufficient to implement much of this...I'm not sure.

Summary

Nested Classes
class MetadataProducer.Context  
class MetadataProducer.CustomOptions  
Fields
public static final Object REMOVE_ANNOTATION_OVERRIDE Return this from your decorators annotation override method and the annotation will be removed.
private final ODataProducer dataProducer
private final EdmDecorator decorator
private final EdmDataServices edm
Public Constructors
MetadataProducer(ODataProducer dataProducer, EdmDecorator edmDecorator)
Creates a new MetadataProducer.
Public Methods
BaseResponse callFunction(EdmFunctionImport name, Map<String, OFunctionParameter> params, QueryInfo queryInfo)
Call a function (aka Service Operation)
void close()
Releases any resources managed by this producer.
EntityResponse createEntity(String entitySetName, OEntity entity)
Creates a new OData entity.
EntityResponse createEntity(String entitySetName, OEntityKey entityKey, String navProp, OEntity entity)
Creates a new OData entity as a reference of an existing entity, implicitly linked to the existing entity by a navigation property.
void createLink(OEntityId sourceEntity, String targetNavProp, OEntityId targetEntity)
Creates a link between two entities.
void deleteEntity(String entitySetName, OEntityKey entityKey)
Deletes an existing entity.
void deleteLink(OEntityId sourceEntity, String targetNavProp, OEntityKey targetEntityKey)
Deletes an existing link between two entities.
EntitiesResponse getEntities(String entitySetName, QueryInfo queryInfo)
Gets all the entities for a given set matching the query information.
CountResponse getEntitiesCount(String entitySetName, QueryInfo queryInfo)
Gets the count of all the entities for a given set matching the query information.
EntityResponse getEntity(String entitySetName, OEntityKey entityKey, EntityQueryInfo queryInfo)
Obtains a single entity based on its type and key.
EntityIdResponse getLinks(OEntityId sourceEntity, String targetNavProp)
Returns the value of an entity's navigation property as a collection of entity links (or a single link if the association cardinality is 1).
EdmDataServices getMetadata()
Get the EDM that defines the queryable metadata, the meta-EDM
MetadataProducer getMetadataProducer()
Obtains the ODataProducer implementation that serves the metadata as OData EDM constructs.
EdmDataServices getModel()
Get the EDM model that this producer exposes.
BaseResponse getNavProperty(String entitySetName, OEntityKey entityKey, String navProp, QueryInfo queryInfo)
Given a specific entity, follow one of its navigation properties, applying constraints as appropriate.
CountResponse getNavPropertyCount(String entitySetName, OEntityKey entityKey, String navProp, QueryInfo queryInfo)
Given a specific entity, follow one of its navigation properties, applying constraints as appropriate.
void mergeEntity(String entitySetName, OEntity entity)
Modifies an existing entity using merge semantics.
void updateEntity(String entitySetName, OEntity entity)
Modifies an existing entity using update semantics.
void updateLink(OEntityId sourceEntity, String targetNavProp, OEntityKey oldTargetEntityKey, OEntityId newTargetEntity)
Replaces an existing link between two entities.
Protected Methods
void addStructuralTypeProperties(MetadataProducer.Context c, EdmStructuralType st, ExpressionEvaluator ev)
void findSchema(MetadataProducer.Context c)
void findStructuralType(MetadataProducer.Context c, boolean isEntity, boolean root)
void getComplexTypes(MetadataProducer.Context c, boolean isRoot)
void getEntityTypes(MetadataProducer.Context c, boolean isRoot)
void getProperties(MetadataProducer.Context c)
OEntity getSchema(MetadataProducer.Context c, EdmSchema schema)
void getSchemas(MetadataProducer.Context c)
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.odata4j.producer.ODataProducer

Fields

public static final Object REMOVE_ANNOTATION_OVERRIDE

Return this from your decorators annotation override method and the annotation will be removed.

private final ODataProducer dataProducer

private final EdmDecorator decorator

private final EdmDataServices edm

Public Constructors

public MetadataProducer (ODataProducer dataProducer, EdmDecorator edmDecorator)

Creates a new MetadataProducer.

Parameters
dataProducer The data producer who defines the $metadata we will expose
edmDecorator An optional decorator. the decorator provides context for evaluating $filter expressions, custom runtime overrides for annotation values and overrides for other metadata properties

Public Methods

public BaseResponse callFunction (EdmFunctionImport name, Map<String, OFunctionParameter> params, QueryInfo queryInfo)

Call a function (aka Service Operation)

Parameters
name The name of the function
params The parameters to the function
queryInfo Additional query parameters to apply to collection-valued results
Returns
  • a BaseResponse appropriately typed to hold the function results From the spec:
        The return type of <Function> MUST be one of the following:
        An EDMSimpleType or collection of EDMSimpleTypes.
        An entity type or collection of entity types.
        A complex type or collection of complex types.
        A row type or collection of row types.
        <ReturnType> can contain a maximum of one <CollectionType> element.
        <ReturnType> can contain a maximum of one <ReferenceType> element.
        <ReturnType> can contain a maximum of one <RowType> element.
        A ref type or collection of ref types.

public void close ()

Releases any resources managed by this producer.

public EntityResponse createEntity (String entitySetName, OEntity entity)

Creates a new OData entity.

Parameters
entitySetName The entity-set name
entity The request entity sent from the client
Returns
  • the newly-created entity, fully populated with the key and default properties

public EntityResponse createEntity (String entitySetName, OEntityKey entityKey, String navProp, OEntity entity)

Creates a new OData entity as a reference of an existing entity, implicitly linked to the existing entity by a navigation property.

Parameters
entitySetName The entity-set name of the existing entity
entityKey The entity-key of the existing entity
navProp The navigation property off of the existing entity
entity The request entity sent from the client
Returns
  • the newly-created entity, fully populated with the key and default properties, and linked to the existing entity

public void createLink (OEntityId sourceEntity, String targetNavProp, OEntityId targetEntity)

Creates a link between two entities.

Parameters
sourceEntity An entity with at least one navigation property
targetNavProp The navigation property
targetEntity The link target entity

public void deleteEntity (String entitySetName, OEntityKey entityKey)

Deletes an existing entity.

Parameters
entitySetName The entity-set name of the entity
entityKey The entity-key of the entity

public void deleteLink (OEntityId sourceEntity, String targetNavProp, OEntityKey targetEntityKey)

Deletes an existing link between two entities.

Parameters
sourceEntity An entity with at least one navigation property
targetNavProp The navigation property
targetEntityKey If the navigation property represents a set, the key identifying the target entity within the set, else n/a

public EntitiesResponse getEntities (String entitySetName, QueryInfo queryInfo)

Gets all the entities for a given set matching the query information.

Parameters
entitySetName The entity-set name for entities to return
queryInfo The additional constraints to apply to the entities
Returns
  • a packaged collection of entities to pass back to the client

public CountResponse getEntitiesCount (String entitySetName, QueryInfo queryInfo)

Gets the count of all the entities for a given set matching the query information.

Parameters
entitySetName The entity-set name for entities whose count is returned
queryInfo The additional constraints to apply to the entities
Returns
  • count of the entities

public EntityResponse getEntity (String entitySetName, OEntityKey entityKey, EntityQueryInfo queryInfo)

Obtains a single entity based on its type and key.

Parameters
entitySetName The entity-set name for entities to return
entityKey The unique entity-key of the entity to start with
queryInfo The additional constraints applicable to single-entity queries
Returns
  • the resulting entity

public EntityIdResponse getLinks (OEntityId sourceEntity, String targetNavProp)

Returns the value of an entity's navigation property as a collection of entity links (or a single link if the association cardinality is 1).

Parameters
sourceEntity An entity with at least one navigation property
targetNavProp The navigation property
Returns
  • a collection of entity links (or a single link if the association cardinality is 1)

public EdmDataServices getMetadata ()

Get the EDM that defines the queryable metadata, the meta-EDM

Returns
  • a fully-constructed metadata object

public MetadataProducer getMetadataProducer ()

Obtains the ODataProducer implementation that serves the metadata as OData EDM constructs.

Returns
  • the MetadataProducer object

public EdmDataServices getModel ()

Get the EDM model that this producer exposes.

public BaseResponse getNavProperty (String entitySetName, OEntityKey entityKey, String navProp, QueryInfo queryInfo)

Given a specific entity, follow one of its navigation properties, applying constraints as appropriate. Return the resulting entity, entities, or property value.

Parameters
entitySetName The entity-set of the entity to start with
entityKey The unique entity-key of the entity to start with
navProp The navigation property to follow
queryInfo Additional constraints to apply to the result
Returns
  • the resulting entity, entities, or property value

public CountResponse getNavPropertyCount (String entitySetName, OEntityKey entityKey, String navProp, QueryInfo queryInfo)

Given a specific entity, follow one of its navigation properties, applying constraints as appropriate. Return the count of the resulting entities.

Parameters
entitySetName The entity-set of the entity to start with
entityKey The unique entity-key of the entity to start with
navProp The navigation property to follow
queryInfo Additional constraints to apply to the result
Returns
  • the count of the resulting entities

public void mergeEntity (String entitySetName, OEntity entity)

Modifies an existing entity using merge semantics.

Parameters
entitySetName The entity-set name
entity The entity modifications sent from the client

public void updateEntity (String entitySetName, OEntity entity)

Modifies an existing entity using update semantics.

Parameters
entitySetName The entity-set name
entity The entity modifications sent from the client

public void updateLink (OEntityId sourceEntity, String targetNavProp, OEntityKey oldTargetEntityKey, OEntityId newTargetEntity)

Replaces an existing link between two entities.

Parameters
sourceEntity An entity with at least one navigation property
targetNavProp The navigation property
oldTargetEntityKey If the navigation property represents a set, the key identifying the old target entity within the set, else n/a
newTargetEntity The new link target entity

Protected Methods

protected void addStructuralTypeProperties (MetadataProducer.Context c, EdmStructuralType st, ExpressionEvaluator ev)

Parameters
c
st
ev

protected void findSchema (MetadataProducer.Context c)

Parameters
c

protected void findStructuralType (MetadataProducer.Context c, boolean isEntity, boolean root)

Parameters
c
isEntity
root

protected void getComplexTypes (MetadataProducer.Context c, boolean isRoot)

Parameters
c
isRoot

protected void getEntityTypes (MetadataProducer.Context c, boolean isRoot)

Parameters
c
isRoot

protected void getProperties (MetadataProducer.Context c)

Parameters
c

protected OEntity getSchema (MetadataProducer.Context c, EdmSchema schema)

Parameters
c
schema

protected void getSchemas (MetadataProducer.Context c)

Parameters
c