Package org.apache.olingo.server.core.serializer.xml

Class ODataXmlSerializer

java.lang.Object

org.apache.olingo.server.core.serializer.xml.ODataXmlSerializer

All Implemented Interfaces:

ODataSerializer

public class ODataXmlSerializer
extends Object
implements ODataSerializer

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ODataXmlSerializer()

Method Summary

Modifier and Type	Method	Description
SerializerResult	complex(ServiceMetadata metadata, EdmComplexType type, Property property, ComplexSerializerOptions options)	Writes complex-type instance data into an InputStream.
SerializerResult	complexCollection(ServiceMetadata metadata, EdmComplexType type, Property property, ComplexSerializerOptions options)	Writes data of a collection of complex-type instances into an InputStream.
SerializerResult	entity(ServiceMetadata metadata, EdmEntityType entityType, Entity entity, EntitySerializerOptions options)	Writes entity data into an InputStream.
SerializerResult	entityCollection(ServiceMetadata metadata, EdmEntityType entityType, AbstractEntityCollection entitySet, EntityCollectionSerializerOptions options)	Writes entity-collection data into an InputStream.
SerializerStreamResult	entityCollectionStreamed(ServiceMetadata metadata, EdmEntityType entityType, AbstractEntityCollectionObject entities, EntityCollectionSerializerOptions options)	Writes entity-collection data into an InputStream.
SerializerResult	error(ODataServerError error)	Writes an ODataError into an InputStream.
SerializerResult	metadataDocument(ServiceMetadata serviceMetadata)	Writes the metadata document into an InputStream.
SerializerResult	primitive(ServiceMetadata metadata, EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options)	Writes primitive-type instance data into an InputStream.
SerializerResult	primitiveCollection(ServiceMetadata metadata, EdmPrimitiveType type, Property property, PrimitiveSerializerOptions options)	Writes data of a collection of primitive-type instances into an InputStream.
SerializerResult	reference(ServiceMetadata metadata, EdmEntitySet edmEntitySet, Entity entity, ReferenceSerializerOptions options)	Writes a single entity reference into an InputStream.
SerializerResult	referenceCollection(ServiceMetadata metadata, EdmEntitySet edmEntitySet, AbstractEntityCollection entityCollection, ReferenceCollectionSerializerOptions options)	Writes entity-collection references into an InputStream.
SerializerResult	serviceDocument(ServiceMetadata metadata, String serviceRoot)	Writes the service document into an InputStream.

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

The default character set is UTF-8.

See Also:

• Constant Field Values

Constructor Details

ODataXmlSerializer

public ODataXmlSerializer()

Method Details

serviceDocument

public SerializerResult serviceDocument(ServiceMetadata metadata,
 String serviceRoot)
                                 throws SerializerException

Description copied from interface: ODataSerializer

Writes the service document into an InputStream.

Specified by:

serviceDocument in interface ODataSerializer

Parameters:

metadata - the metadata information for the service

serviceRoot - the service-root URI of this OData service

Throws:

SerializerException

metadataDocument

public SerializerResult metadataDocument(ServiceMetadata serviceMetadata)
                                  throws SerializerException

Description copied from interface: ODataSerializer

Writes the metadata document into an InputStream.

Specified by:

metadataDocument in interface ODataSerializer

Parameters:

serviceMetadata - the metadata information for the service

Throws:

SerializerException

error

public SerializerResult error(ODataServerError error)
                       throws SerializerException

Description copied from interface: ODataSerializer

Writes an ODataError into an InputStream.

Specified by:

error in interface ODataSerializer

Parameters:

error - the main error

Throws:

SerializerException

entityCollection

public SerializerResult entityCollection(ServiceMetadata metadata,
 EdmEntityType entityType,
 AbstractEntityCollection entitySet,
 EntityCollectionSerializerOptions options)
                                  throws SerializerException

Description copied from interface: ODataSerializer

Writes entity-collection data into an InputStream.

Specified by:

entityCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

entityType - the EdmEntityType

entitySet - the data of the entity set

options - options for the serializer

Throws:

SerializerException

entityCollectionStreamed

public SerializerStreamResult entityCollectionStreamed(ServiceMetadata metadata,
 EdmEntityType entityType,
 AbstractEntityCollectionObject entities,
 EntityCollectionSerializerOptions options)
                                                throws SerializerException

Description copied from interface: ODataSerializer

Writes entity-collection data into an InputStream.

Specified by:

entityCollectionStreamed in interface ODataSerializer

Parameters:

metadata - metadata for the service

entityType - the EdmEntityType

entities - the data of the entity set

options - options for the serializer

Throws:

SerializerException

entity

public SerializerResult entity(ServiceMetadata metadata,
 EdmEntityType entityType,
 Entity entity,
 EntitySerializerOptions options)
                        throws SerializerException

Description copied from interface: ODataSerializer

Writes entity data into an InputStream.

Specified by:

entity in interface ODataSerializer

Parameters:

metadata - metadata for the service

entityType - the EdmEntityType

entity - the data of the entity

options - options for the serializer

Throws:

SerializerException

primitive

public SerializerResult primitive(ServiceMetadata metadata,
 EdmPrimitiveType type,
 Property property,
 PrimitiveSerializerOptions options)
                           throws SerializerException

Description copied from interface: ODataSerializer

Writes primitive-type instance data into an InputStream.

Specified by:

primitive in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - primitive type

property - property value

options - options for the serializer

Throws:

SerializerException

complex

public SerializerResult complex(ServiceMetadata metadata,
 EdmComplexType type,
 Property property,
 ComplexSerializerOptions options)
                         throws SerializerException

Description copied from interface: ODataSerializer

Writes complex-type instance data into an InputStream.

Specified by:

complex in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - complex type

property - property value

options - options for the serializer

Throws:

SerializerException

primitiveCollection

public SerializerResult primitiveCollection(ServiceMetadata metadata,
 EdmPrimitiveType type,
 Property property,
 PrimitiveSerializerOptions options)
                                     throws SerializerException

Description copied from interface: ODataSerializer

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

Specified by:

primitiveCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - primitive type

property - property value

options - options for the serializer

Throws:

SerializerException

complexCollection

public SerializerResult complexCollection(ServiceMetadata metadata,
 EdmComplexType type,
 Property property,
 ComplexSerializerOptions options)
                                   throws SerializerException

Description copied from interface: ODataSerializer

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

Specified by:

complexCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

type - complex type

property - property value

options - options for the serializer

Throws:

SerializerException

reference

public SerializerResult reference(ServiceMetadata metadata,
 EdmEntitySet edmEntitySet,
 Entity entity,
 ReferenceSerializerOptions options)
                           throws SerializerException

Description copied from interface: ODataSerializer

Writes a single entity reference into an InputStream.

Specified by:

reference in interface ODataSerializer

Parameters:

metadata - metadata for the service

edmEntitySet - EdmEntitySet

entity - data of the entity

options - ReferenceSerializerOptions

Throws:

SerializerException

referenceCollection

public SerializerResult referenceCollection(ServiceMetadata metadata,
 EdmEntitySet edmEntitySet,
 AbstractEntityCollection entityCollection,
 ReferenceCollectionSerializerOptions options)
                                     throws SerializerException

Description copied from interface: ODataSerializer

Writes entity-collection references into an InputStream.

Specified by:

referenceCollection in interface ODataSerializer

Parameters:

metadata - metadata for the service

edmEntitySet - EdmEntitySet

entityCollection - data of the entity collection

options - ReferenceCollectionSerializerOptions

Throws:

SerializerException