org.odata4j.producer.edm
Class MetadataProducer

java.lang.Object
  org.odata4j.producer.edm.MetadataProducer

All Implemented Interfaces:

OExtensible<ODataProducer>, ODataProducer

public class MetadataProducer
extends Object
implements ODataProducer

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.

Nested Class Summary

protected class	MetadataProducer.Context
static class	MetadataProducer.CustomOptions

Field Summary

static Object

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

Constructor Summary

MetadataProducer(ODataProducer dataProducer, EdmDecorator edmDecorator)
Creates a new MetadataProducer.

Method Summary

protected void	addStructuralTypeProperties(MetadataProducer.Context c, EdmStructuralType st, ExpressionEvaluator ev)
BaseResponse	callFunction(EdmFunctionImport name, Map<String,OFunctionParameter> params, QueryInfo queryInfo) Calls 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.
void	dump()
<TExtension extends OExtension<ODataProducer>> TExtension	findExtension(Class<TExtension> clazz) Finds an extension instance given an interface, if one exists.
protected void	findSchema(MetadataProducer.Context c)
protected void	findStructuralType(MetadataProducer.Context c, boolean isEntity, boolean root)
protected void	getComplexTypes(MetadataProducer.Context c, boolean isRoot)
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.
protected void	getEntityTypes(MetadataProducer.Context c, boolean isRoot)
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.
protected void	getProperties(MetadataProducer.Context c)
protected OEntity	getSchema(MetadataProducer.Context c, EdmSchema schema)
protected void	getSchemas(MetadataProducer.Context c)
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.

Methods inherited from class java.lang.Object

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

Field Detail

REMOVE_ANNOTATION_OVERRIDE

public static final Object REMOVE_ANNOTATION_OVERRIDE

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

Constructor Detail

MetadataProducer

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

Method Detail

addStructuralTypeProperties

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

callFunction

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

Description copied from interface: ODataProducer

Calls a function (aka Service Operation).

Specified by:

callFunction in interface ODataProducer

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.

close

public void close()

Description copied from interface: ODataProducer

Releases any resources managed by this producer.

Specified by:

close in interface ODataProducer

createEntity

public EntityResponse createEntity(String entitySetName,
                                   OEntity entity)

Description copied from interface: ODataProducer

Creates a new OData entity.

Specified by:

createEntity in interface ODataProducer

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

See Also:

[odata.org] Creating new Entries

createEntity

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

Description copied from interface: ODataProducer

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

Specified by:

createEntity in interface ODataProducer

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

See Also:

[odata.org] Creating new Entries

createLink

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

Description copied from interface: ODataProducer

Creates a link between two entities.

Specified by:

createLink in interface ODataProducer

Parameters:

sourceEntity - an entity with at least one navigation property

targetNavProp - the navigation property

targetEntity - the link target entity

See Also:

[odata.org] Creating Links between Entries

deleteEntity

public void deleteEntity(String entitySetName,
                         OEntityKey entityKey)

Description copied from interface: ODataProducer

Deletes an existing entity.

Specified by:

deleteEntity in interface ODataProducer

Parameters:

entitySetName - the entity-set name of the entity

entityKey - the entity-key of the entity

See Also:

[odata.org] Deleting Entries

deleteLink

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

Description copied from interface: ODataProducer

Deletes an existing link between two entities.

Specified by:

deleteLink in interface ODataProducer

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

dump

public void dump()

findExtension

public <TExtension extends OExtension<ODataProducer>> TExtension findExtension(Class<TExtension> clazz)

Description copied from interface: OExtensible

Finds an extension instance given an interface, if one exists.

Specified by:

findExtension in interface OExtensible<ODataProducer>

Type Parameters:

TExtension - type of extension

Parameters:

clazz - the extension interface

Returns:

the extension instance, or null if no extension exists for this type

findSchema

protected void findSchema(MetadataProducer.Context c)

findStructuralType

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

getComplexTypes

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

getEntities

public EntitiesResponse getEntities(String entitySetName,
                                    QueryInfo queryInfo)

Description copied from interface: ODataProducer

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

Specified by:

getEntities in interface ODataProducer

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

getEntitiesCount

public CountResponse getEntitiesCount(String entitySetName,
                                      QueryInfo queryInfo)

Description copied from interface: ODataProducer

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

Specified by:

getEntitiesCount in interface ODataProducer

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

getEntity

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

Description copied from interface: ODataProducer

Obtains a single entity based on its type and key.

Specified by:

getEntity in interface ODataProducer

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

getEntityTypes

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

getLinks

public EntityIdResponse getLinks(OEntityId sourceEntity,
                                 String targetNavProp)

Description copied from interface: ODataProducer

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).

Specified by:

getLinks in interface ODataProducer

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)

getMetadata

public EdmDataServices getMetadata()

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

Specified by:

getMetadata in interface ODataProducer

Returns:

a fully-constructed metadata object

getMetadataProducer

public MetadataProducer getMetadataProducer()

Description copied from interface: ODataProducer

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

Specified by:

getMetadataProducer in interface ODataProducer

Returns:

the MetadataProducer object

getModel

public EdmDataServices getModel()

Get the EDM model that this producer exposes.

getNavProperty

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

Description copied from interface: ODataProducer

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

Specified by:

getNavProperty in interface ODataProducer

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

getNavPropertyCount

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

Description copied from interface: ODataProducer

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

Specified by:

getNavPropertyCount in interface ODataProducer

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

getProperties

protected void getProperties(MetadataProducer.Context c)

getSchema

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

getSchemas

protected void getSchemas(MetadataProducer.Context c)

mergeEntity

public void mergeEntity(String entitySetName,
                        OEntity entity)

Description copied from interface: ODataProducer

Modifies an existing entity using merge semantics.

Specified by:

mergeEntity in interface ODataProducer

Parameters:

entitySetName - the entity-set name

entity - the entity modifications sent from the client

See Also:

[odata.org] Updating Entries

updateEntity

public void updateEntity(String entitySetName,
                         OEntity entity)

Description copied from interface: ODataProducer

Modifies an existing entity using update semantics.

Specified by:

updateEntity in interface ODataProducer

Parameters:

entitySetName - the entity-set name

entity - the entity modifications sent from the client

See Also:

[odata.org] Updating Entries

updateLink

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

Description copied from interface: ODataProducer

Replaces an existing link between two entities.

Specified by:

updateLink in interface ODataProducer

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

See Also:

[odata.org] Replacing Links between Entries