org.apache.olingo.client.api.serialization

Interface CommonODataReader

All Known Subinterfaces:

ODataReader, ODataReader

public interface CommonODataReader

OData reader.
Use this class to de-serialize an OData response body.
This class provides method helpers to de-serialize an entire entity set, a set of entities or a single entity.

Method Summary

Methods

Modifier and Type	Method and Description
<T> ResWrap<T>	read(InputStream src, String format, Class<T> reference) Parses a stream into the object type specified by the given reference.
CommonODataEntity	readEntity(InputStream input, ODataFormat format) Parses a stream taking care to de-serializes the first OData entity found.
CommonODataEntitySet	readEntitySet(InputStream input, ODataFormat format) De-Serializes a stream into an OData entity set.
ODataError	readError(InputStream inputStream, ODataFormat format) Parses a stream into an OData error.
Edm	readMetadata(InputStream input) Parses a stream into metadata representation.
Edm	readMetadata(Map<String,Schema> xmlSchemas) Parses a stream into metadata representation, including referenced metadata documents.
CommonODataProperty	readProperty(InputStream input, ODataFormat format) Parses a stream taking care to de-serialize the first OData entity property found.
ODataServiceDocument	readServiceDocument(InputStream input, ODataFormat format) Parses an OData service document.

Method Detail

readMetadata

Edm readMetadata(InputStream input)

Parses a stream into metadata representation.

Parameters:

input - stream to de-serialize.

Returns:

metadata representation.

readMetadata

Edm readMetadata(Map<String,Schema> xmlSchemas)

Parses a stream into metadata representation, including referenced metadata documents.

Parameters:

xmlSchemas - XML representation of the requested metadata document + any other referenced (via <edmx:Reference/>) metadata document

Returns:

metadata representation.

readServiceDocument

ODataServiceDocument readServiceDocument(InputStream input,
                                       ODataFormat format)
                                         throws ODataDeserializerException

Parses an OData service document.

Parameters:

input - stream to de-serialize.

format - de-serialize as XML or JSON

Returns:

List of URIs.

Throws:

ODataDeserializerException

readEntitySet

CommonODataEntitySet readEntitySet(InputStream input,
                                 ODataFormat format)
                                   throws ODataDeserializerException

De-Serializes a stream into an OData entity set.

Parameters:

input - stream to de-serialize.

format - de-serialize format

Returns:

de-serialized entity set.

Throws:

ODataDeserializerException

readEntity

CommonODataEntity readEntity(InputStream input,
                           ODataFormat format)
                             throws ODataDeserializerException

Parses a stream taking care to de-serializes the first OData entity found.

Parameters:

input - stream to de-serialize.

format - de-serialize format

Returns:

entity de-serialized.

Throws:

ODataDeserializerException

readProperty

CommonODataProperty readProperty(InputStream input,
                               ODataFormat format)
                                 throws ODataDeserializerException

Parses a stream taking care to de-serialize the first OData entity property found.

Parameters:

input - stream to de-serialize.

format - de-serialize as XML or JSON

Returns:

OData entity property de-serialized.

Throws:

ODataDeserializerException

readError

ODataError readError(InputStream inputStream,
                   ODataFormat format)
                     throws ODataDeserializerException

Parses a stream into an OData error.

Parameters:

inputStream - stream to de-serialize.

format - format

Returns:

OData error.

Throws:

ODataDeserializerException

read

<T> ResWrap<T> read(InputStream src,
                  String format,
                  Class<T> reference)
                throws ODataDeserializerException

Parses a stream into the object type specified by the given reference.

Type Parameters:

T - expected object type.

Parameters:

src - input stream.

format - format

reference - reference.

Returns:

read object.

Throws:

ODataDeserializerException