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

Class ODataXmlSerializer

java.lang.Object

org.apache.olingo.server.core.serializer.AbstractODataSerializer

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

All Implemented Interfaces:

org.apache.olingo.server.api.serializer.ODataSerializer

public class ODataXmlSerializer
extends AbstractODataSerializer

Field Summary

Fields

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

Fields inherited from class org.apache.olingo.server.core.serializer.AbstractODataSerializer

IO_EXCEPTION_TEXT

Constructor Summary

Constructors

Constructor and Description
ODataXmlSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.olingo.server.api.serializer.SerializerResult	complex(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmComplexType type, org.apache.olingo.commons.api.data.Property property, org.apache.olingo.server.api.serializer.ComplexSerializerOptions options)
org.apache.olingo.server.api.serializer.SerializerResult	complexCollection(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmComplexType type, org.apache.olingo.commons.api.data.Property property, org.apache.olingo.server.api.serializer.ComplexSerializerOptions options)
org.apache.olingo.server.api.serializer.SerializerResult	entity(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmEntityType entityType, org.apache.olingo.commons.api.data.Entity entity, org.apache.olingo.server.api.serializer.EntitySerializerOptions options)
org.apache.olingo.server.api.serializer.SerializerResult	entityCollection(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmEntityType entityType, org.apache.olingo.commons.api.data.EntityCollection entitySet, org.apache.olingo.server.api.serializer.EntityCollectionSerializerOptions options)
protected org.apache.olingo.server.api.serializer.SerializerResult	entityReference(org.apache.olingo.commons.api.data.Entity entity, org.apache.olingo.server.api.serializer.ReferenceSerializerOptions options)
protected org.apache.olingo.server.api.serializer.SerializerResult	entityReferenceCollection(org.apache.olingo.commons.api.data.EntityCollection entitySet, org.apache.olingo.server.api.serializer.ReferenceCollectionSerializerOptions options)
org.apache.olingo.server.api.serializer.SerializerResult	error(org.apache.olingo.server.api.ODataServerError error)
protected org.apache.olingo.commons.api.data.Link	getOrCreateLink(org.apache.olingo.commons.api.data.Linked linked, String navigationPropertyName)
org.apache.olingo.server.api.serializer.SerializerResult	metadataDocument(org.apache.olingo.server.api.ServiceMetadata serviceMetadata)
org.apache.olingo.server.api.serializer.SerializerResult	primitive(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmPrimitiveType type, org.apache.olingo.commons.api.data.Property property, org.apache.olingo.server.api.serializer.PrimitiveSerializerOptions options)
org.apache.olingo.server.api.serializer.SerializerResult	primitiveCollection(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmPrimitiveType type, org.apache.olingo.commons.api.data.Property property, org.apache.olingo.server.api.serializer.PrimitiveSerializerOptions options)
org.apache.olingo.server.api.serializer.SerializerResult	reference(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmEntitySet edmEntitySet, org.apache.olingo.commons.api.data.Entity entity, org.apache.olingo.server.api.serializer.ReferenceSerializerOptions options)
org.apache.olingo.server.api.serializer.SerializerResult	referenceCollection(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmEntitySet edmEntitySet, org.apache.olingo.commons.api.data.EntityCollection entityCollection, org.apache.olingo.server.api.serializer.ReferenceCollectionSerializerOptions options)
protected org.apache.olingo.commons.api.edm.EdmComplexType	resolveComplexType(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmComplexType baseType, String derivedTypeName)
protected org.apache.olingo.commons.api.edm.EdmEntityType	resolveEntityType(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmEntityType baseType, String derivedTypeName)
org.apache.olingo.server.api.serializer.SerializerResult	serviceDocument(org.apache.olingo.server.api.ServiceMetadata metadata, String serviceRoot)
protected void	writeComplexValue(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmComplexType type, List<org.apache.olingo.commons.api.data.Property> properties, Set<List<String>> selectedPaths, XMLStreamWriter writer)
protected void	writeEntity(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmEntityType entityType, org.apache.olingo.commons.api.data.Entity entity, org.apache.olingo.commons.api.data.ContextURL contextURL, org.apache.olingo.server.api.uri.queryoption.ExpandOption expand, org.apache.olingo.server.api.uri.queryoption.SelectOption select, XMLStreamWriter writer, boolean top)
protected void	writeEntitySet(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmEntityType entityType, org.apache.olingo.commons.api.data.EntityCollection entitySet, org.apache.olingo.server.api.uri.queryoption.ExpandOption expand, org.apache.olingo.server.api.uri.queryoption.SelectOption select, XMLStreamWriter writer)
protected void	writeExpandedNavigationProperty(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmNavigationProperty property, org.apache.olingo.commons.api.data.Link navigationLink, org.apache.olingo.server.api.uri.queryoption.ExpandOption innerExpand, org.apache.olingo.server.api.uri.queryoption.SelectOption innerSelect, XMLStreamWriter writer)
protected void	writeNavigationProperties(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmStructuredType type, org.apache.olingo.commons.api.data.Linked linked, org.apache.olingo.server.api.uri.queryoption.ExpandOption expand, XMLStreamWriter writer)
protected void	writePrimitiveValue(org.apache.olingo.commons.api.edm.EdmPrimitiveType type, Object primitiveValue, Boolean isNullable, Integer maxLength, Integer precision, Integer scale, Boolean isUnicode, XMLStreamWriter writer)
protected void	writeProperties(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmStructuredType type, List<org.apache.olingo.commons.api.data.Property> properties, org.apache.olingo.server.api.uri.queryoption.SelectOption select, XMLStreamWriter writer)
protected void	writeProperty(org.apache.olingo.server.api.ServiceMetadata metadata, org.apache.olingo.commons.api.edm.EdmProperty edmProperty, org.apache.olingo.commons.api.data.Property property, Set<List<String>> selectedPaths, XMLStreamWriter writer)

Methods inherited from class org.apache.olingo.server.core.serializer.AbstractODataSerializer

closeCircleStreamBufferOutput

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

The default character set is UTF-8.

See Also:

Constant Field Values

Constructor Detail

ODataXmlSerializer

public ODataXmlSerializer()

Method Detail

serviceDocument

public org.apache.olingo.server.api.serializer.SerializerResult serviceDocument(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                       String serviceRoot)
                                                                         throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

metadataDocument

public org.apache.olingo.server.api.serializer.SerializerResult metadataDocument(org.apache.olingo.server.api.ServiceMetadata serviceMetadata)
                                                                          throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

error

public org.apache.olingo.server.api.serializer.SerializerResult error(org.apache.olingo.server.api.ODataServerError error)
                                                               throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

entityCollection

public org.apache.olingo.server.api.serializer.SerializerResult entityCollection(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                        org.apache.olingo.commons.api.edm.EdmEntityType entityType,
                                                                        org.apache.olingo.commons.api.data.EntityCollection entitySet,
                                                                        org.apache.olingo.server.api.serializer.EntityCollectionSerializerOptions options)
                                                                          throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

entity

public org.apache.olingo.server.api.serializer.SerializerResult entity(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                              org.apache.olingo.commons.api.edm.EdmEntityType entityType,
                                                              org.apache.olingo.commons.api.data.Entity entity,
                                                              org.apache.olingo.server.api.serializer.EntitySerializerOptions options)
                                                                throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

writeEntitySet

protected void writeEntitySet(org.apache.olingo.server.api.ServiceMetadata metadata,
                  org.apache.olingo.commons.api.edm.EdmEntityType entityType,
                  org.apache.olingo.commons.api.data.EntityCollection entitySet,
                  org.apache.olingo.server.api.uri.queryoption.ExpandOption expand,
                  org.apache.olingo.server.api.uri.queryoption.SelectOption select,
                  XMLStreamWriter writer)
                       throws XMLStreamException,
                              org.apache.olingo.server.api.serializer.SerializerException

Throws:

XMLStreamException

org.apache.olingo.server.api.serializer.SerializerException

writeEntity

protected void writeEntity(org.apache.olingo.server.api.ServiceMetadata metadata,
               org.apache.olingo.commons.api.edm.EdmEntityType entityType,
               org.apache.olingo.commons.api.data.Entity entity,
               org.apache.olingo.commons.api.data.ContextURL contextURL,
               org.apache.olingo.server.api.uri.queryoption.ExpandOption expand,
               org.apache.olingo.server.api.uri.queryoption.SelectOption select,
               XMLStreamWriter writer,
               boolean top)
                    throws XMLStreamException,
                           org.apache.olingo.server.api.serializer.SerializerException

Throws:

XMLStreamException

org.apache.olingo.server.api.serializer.SerializerException

resolveEntityType

protected org.apache.olingo.commons.api.edm.EdmEntityType resolveEntityType(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                org.apache.olingo.commons.api.edm.EdmEntityType baseType,
                                                                String derivedTypeName)
                                                                     throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

resolveComplexType

protected org.apache.olingo.commons.api.edm.EdmComplexType resolveComplexType(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                  org.apache.olingo.commons.api.edm.EdmComplexType baseType,
                                                                  String derivedTypeName)
                                                                       throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

writeProperties

protected void writeProperties(org.apache.olingo.server.api.ServiceMetadata metadata,
                   org.apache.olingo.commons.api.edm.EdmStructuredType type,
                   List<org.apache.olingo.commons.api.data.Property> properties,
                   org.apache.olingo.server.api.uri.queryoption.SelectOption select,
                   XMLStreamWriter writer)
                        throws XMLStreamException,
                               org.apache.olingo.server.api.serializer.SerializerException

Throws:

XMLStreamException

org.apache.olingo.server.api.serializer.SerializerException

writeNavigationProperties

protected void writeNavigationProperties(org.apache.olingo.server.api.ServiceMetadata metadata,
                             org.apache.olingo.commons.api.edm.EdmStructuredType type,
                             org.apache.olingo.commons.api.data.Linked linked,
                             org.apache.olingo.server.api.uri.queryoption.ExpandOption expand,
                             XMLStreamWriter writer)
                                  throws org.apache.olingo.server.api.serializer.SerializerException,
                                         XMLStreamException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

XMLStreamException

getOrCreateLink

protected org.apache.olingo.commons.api.data.Link getOrCreateLink(org.apache.olingo.commons.api.data.Linked linked,
                                                      String navigationPropertyName)
                                                           throws XMLStreamException

Throws:

XMLStreamException

writeExpandedNavigationProperty

protected void writeExpandedNavigationProperty(org.apache.olingo.server.api.ServiceMetadata metadata,
                                   org.apache.olingo.commons.api.edm.EdmNavigationProperty property,
                                   org.apache.olingo.commons.api.data.Link navigationLink,
                                   org.apache.olingo.server.api.uri.queryoption.ExpandOption innerExpand,
                                   org.apache.olingo.server.api.uri.queryoption.SelectOption innerSelect,
                                   XMLStreamWriter writer)
                                        throws XMLStreamException,
                                               org.apache.olingo.server.api.serializer.SerializerException

Throws:

XMLStreamException

org.apache.olingo.server.api.serializer.SerializerException

writeProperty

protected void writeProperty(org.apache.olingo.server.api.ServiceMetadata metadata,
                 org.apache.olingo.commons.api.edm.EdmProperty edmProperty,
                 org.apache.olingo.commons.api.data.Property property,
                 Set<List<String>> selectedPaths,
                 XMLStreamWriter writer)
                      throws XMLStreamException,
                             org.apache.olingo.server.api.serializer.SerializerException

Throws:

XMLStreamException

org.apache.olingo.server.api.serializer.SerializerException

writePrimitiveValue

protected void writePrimitiveValue(org.apache.olingo.commons.api.edm.EdmPrimitiveType type,
                       Object primitiveValue,
                       Boolean isNullable,
                       Integer maxLength,
                       Integer precision,
                       Integer scale,
                       Boolean isUnicode,
                       XMLStreamWriter writer)
                            throws org.apache.olingo.commons.api.edm.EdmPrimitiveTypeException,
                                   XMLStreamException

Throws:

org.apache.olingo.commons.api.edm.EdmPrimitiveTypeException

XMLStreamException

writeComplexValue

protected void writeComplexValue(org.apache.olingo.server.api.ServiceMetadata metadata,
                     org.apache.olingo.commons.api.edm.EdmComplexType type,
                     List<org.apache.olingo.commons.api.data.Property> properties,
                     Set<List<String>> selectedPaths,
                     XMLStreamWriter writer)
                          throws XMLStreamException,
                                 org.apache.olingo.server.api.serializer.SerializerException

Throws:

XMLStreamException

org.apache.olingo.server.api.serializer.SerializerException

primitive

public org.apache.olingo.server.api.serializer.SerializerResult primitive(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                 org.apache.olingo.commons.api.edm.EdmPrimitiveType type,
                                                                 org.apache.olingo.commons.api.data.Property property,
                                                                 org.apache.olingo.server.api.serializer.PrimitiveSerializerOptions options)
                                                                   throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

complex

public org.apache.olingo.server.api.serializer.SerializerResult complex(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                               org.apache.olingo.commons.api.edm.EdmComplexType type,
                                                               org.apache.olingo.commons.api.data.Property property,
                                                               org.apache.olingo.server.api.serializer.ComplexSerializerOptions options)
                                                                 throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

primitiveCollection

public org.apache.olingo.server.api.serializer.SerializerResult primitiveCollection(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                           org.apache.olingo.commons.api.edm.EdmPrimitiveType type,
                                                                           org.apache.olingo.commons.api.data.Property property,
                                                                           org.apache.olingo.server.api.serializer.PrimitiveSerializerOptions options)
                                                                             throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

complexCollection

public org.apache.olingo.server.api.serializer.SerializerResult complexCollection(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                         org.apache.olingo.commons.api.edm.EdmComplexType type,
                                                                         org.apache.olingo.commons.api.data.Property property,
                                                                         org.apache.olingo.server.api.serializer.ComplexSerializerOptions options)
                                                                           throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

reference

public org.apache.olingo.server.api.serializer.SerializerResult reference(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                 org.apache.olingo.commons.api.edm.EdmEntitySet edmEntitySet,
                                                                 org.apache.olingo.commons.api.data.Entity entity,
                                                                 org.apache.olingo.server.api.serializer.ReferenceSerializerOptions options)
                                                                   throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

entityReference

protected org.apache.olingo.server.api.serializer.SerializerResult entityReference(org.apache.olingo.commons.api.data.Entity entity,
                                                                       org.apache.olingo.server.api.serializer.ReferenceSerializerOptions options)
                                                                            throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

referenceCollection

public org.apache.olingo.server.api.serializer.SerializerResult referenceCollection(org.apache.olingo.server.api.ServiceMetadata metadata,
                                                                           org.apache.olingo.commons.api.edm.EdmEntitySet edmEntitySet,
                                                                           org.apache.olingo.commons.api.data.EntityCollection entityCollection,
                                                                           org.apache.olingo.server.api.serializer.ReferenceCollectionSerializerOptions options)
                                                                             throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException

entityReferenceCollection

protected org.apache.olingo.server.api.serializer.SerializerResult entityReferenceCollection(org.apache.olingo.commons.api.data.EntityCollection entitySet,
                                                                                 org.apache.olingo.server.api.serializer.ReferenceCollectionSerializerOptions options)
                                                                                      throws org.apache.olingo.server.api.serializer.SerializerException

Throws:

org.apache.olingo.server.api.serializer.SerializerException