org.apache.olingo.server.api.serializer

Interface ODataSerializer

public interface ODataSerializer

OData serializer

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CHARSET The default character set is UTF-8.

Method Summary

Methods

Modifier and Type	Method and Description
InputStream	complex(EdmComplexType type, Property property, ComplexSerializerOptions options) Writes complex-type instance data into an InputStream.
InputStream	complexCollection(EdmComplexType type, Property property, ComplexSerializerOptions options) Writes data of a collection of complex-type instances into an InputStream.
InputStream	entity(EdmEntityType entityType, Entity entity, EntitySerializerOptions options) Writes entity data into an InputStream.
InputStream	entityCollection(EdmEntityType entityType, EntitySet entitySet, EntityCollectionSerializerOptions options) Writes entity-collection data into an InputStream.
InputStream	error(ODataServerError error) Writes an ODataError into an InputStream.
InputStream	metadataDocument(ServiceMetadata serviceMetadata) Writes the metadata document into an InputStream.
InputStream	primitive(EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options) Writes primitive-type instance data into an InputStream.
InputStream	primitiveCollection(EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options) Writes data of a collection of primitive-type instances into an InputStream.
InputStream	serviceDocument(Edm edm, String serviceRoot) Writes the service document into an InputStream.

Field Detail

DEFAULT_CHARSET

static final String DEFAULT_CHARSET

The default character set is UTF-8.

See Also:

Constant Field Values

Method Detail

serviceDocument

InputStream serviceDocument(Edm edm,
                          String serviceRoot)
                            throws SerializerException

Writes the service document into an InputStream.

Parameters:

edm - the Entity Data Model

serviceRoot - the service-root URI of this OData service

Throws:

SerializerException

metadataDocument

InputStream metadataDocument(ServiceMetadata serviceMetadata)
                             throws SerializerException

Writes the metadata document into an InputStream.

Parameters:

serviceMetadata - the metadata information for the service

Throws:

SerializerException

error

InputStream error(ODataServerError error)
                  throws SerializerException

Writes an ODataError into an InputStream.

Parameters:

error - the main error

Returns:

inputStream containing the OData-formatted error

Throws:

SerializerException

entityCollection

InputStream entityCollection(EdmEntityType entityType,
                           EntitySet entitySet,
                           EntityCollectionSerializerOptions options)
                             throws SerializerException

Writes entity-collection data into an InputStream.

Parameters:

entityType - the EdmEntityType

entitySet - the data of the entity set

options - options for the serializer

Throws:

SerializerException

entity

InputStream entity(EdmEntityType entityType,
                 Entity entity,
                 EntitySerializerOptions options)
                   throws SerializerException

Writes entity data into an InputStream.

Parameters:

entityType - the EdmEntityType

entity - the data of the entity

options - options for the serializer

Throws:

SerializerException

primitive

InputStream primitive(EdmPrimitiveType type,
                    Property property,
                    PrimitiveSerializerOptions options)
                      throws SerializerException

Writes primitive-type instance data into an InputStream.

Parameters:

type - primitive type

property - property value

options - options for the serializer

Throws:

SerializerException

complex

InputStream complex(EdmComplexType type,
                  Property property,
                  ComplexSerializerOptions options)
                    throws SerializerException

Writes complex-type instance data into an InputStream.

Parameters:

type - complex type

property - property value

options - options for the serializer

Throws:

SerializerException

primitiveCollection

InputStream primitiveCollection(EdmPrimitiveType type,
                              Property property,
                              PrimitiveSerializerOptions options)
                                throws SerializerException

Writes data of a collection of primitive-type instances into an InputStream.

Parameters:

type - primitive type

property - property value

options - options for the serializer

Throws:

SerializerException

complexCollection

InputStream complexCollection(EdmComplexType type,
                            Property property,
                            ComplexSerializerOptions options)
                              throws SerializerException

Writes data of a collection of complex-type instances into an InputStream.

Parameters:

type - complex type

property - property value

options - options for the serializer

Throws:

SerializerException