com.sap.cloud.server.odata.atom

Class AtomValue

java.lang.Object

com.sap.cloud.server.odata.atom.AtomValue

public abstract class AtomValue
extends java.lang.Object

Utility functions for parsing and formatting DataValue in OData ATOM representation.

Constructor Summary

Constructors

Constructor and Description
AtomValue()

Method Summary

Modifier and Type	Method and Description
static XmlDocument	entryDocument(EntityValue entity, DataContext context) Return an entity value converted into an ATOM entry, wrapped as an XML document.
static ErrorResponse	errorResponse(XmlElement element, DataContext context) Return a parsed error response.
static XmlDocument	feedDocument(EntityValueList list, DataContext context) Return an entity list converted into an ATOM feed, wrapped as an XML document.
static XmlDocument	formatCall(DataMethodCall call, DataContext context) Return an action invocation request body in XML format.
static XmlDocument	formatDocument(DataValue value, DataContext context) Return a data value formatted in OData ATOM representation.
static XmlDocument	formatLink(EntityValue entity, DataContext context) Return an entity reference formatted in OData ATOM representation.
static void	fromBasicList(XmlElement element, DataValueList list, DataContext context) Convert a basic list to ATOM format.
static void	fromComplexList(XmlElement element, ComplexValueList list, DataContext context) Convert a complex list to ATOM format.
static void	fromComplexValue(XmlElement element, ComplexValue complex, DataContext context) Convert a complex value to ATOM format.
static void	fromDataValue(XmlElement element, DataValue value, DataContext context) Convert a data value to ATOM format.
static void	fromEntityList(XmlElement feed, EntityValueList list, DataContext context) Convert an entity list to ATOM format.
static void	fromEntityValue(XmlElement entry, EntityValue entity, DataContext context) Convert an entity value to ATOM format.
static DataValue	parseDocument(XmlElement element, DataType type, DataContext context) Return (nullable) A data value (basic, basic list, complex list, entity, entity list) parsed from OData ATOM representation.
static EntityValue	parseLink(XmlElement element, EntityType type, DataContext context) Return an entity reference parsed from OData ATOM representation.
static EntityValueList	parseLinks(XmlElement element, EntityType type, DataContext context) Return a list of entity references parsed from OData ATOM representation.
static EntityValue	parseReference(java.lang.String uri, EntityType entityType, EntitySet entitySet, DataContext context) See parseReference(String, EntityType, EntitySet, DataContext, boolean).
static EntityValue	parseReference(java.lang.String uri, EntityType entityType, EntitySet entitySet, DataContext context, boolean binding) Return an entity reference parsed from OData ATOM reference representation.
static DataValueList	toBasicList(XmlElement element, DataType type, DataContext context) Return a basic list parsed from ATOM format.
static ComplexValueList	toComplexList(XmlElement element, DataType type, DataContext context) Return a complex list parsed from ATOM format.
static ComplexValue	toComplexValue(XmlElement element, ComplexType type, DataContext context) Return (nullable) A complex value parsed from ATOM format.
static DataValue	toDataValue(XmlElement element, DataType type, DataContext context) Return (nullable) A data value parsed from ATOM format.
static EntityValueList	toEntityList(XmlElement feed, DataType type, DataContext context) Return an entity list parsed from ATOM format.
static EntityValue	toEntityValue(XmlElement entry, EntityType type, DataContext context) Return (nullable) An entity value parsed from ATOM format.

Methods inherited from class java.lang.Object

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

Constructor Detail

AtomValue

public AtomValue()

Method Detail

entryDocument

public static XmlDocument entryDocument(EntityValue entity,
                                        DataContext context)

Return an entity value converted into an ATOM entry, wrapped as an XML document.

Parameters:

entity - Entity value to be converted into ATOM format.

context - Data context.

Returns:

An entity value converted into an ATOM entry, wrapped as an XML document.

errorResponse

public static ErrorResponse errorResponse(XmlElement element,
                                          DataContext context)

Return a parsed error response.

Parameters:

element - Error response in ATOM representation.

context - Data context.

Returns:

A parsed error response.

feedDocument

public static XmlDocument feedDocument(EntityValueList list,
                                       DataContext context)

Return an entity list converted into an ATOM feed, wrapped as an XML document.

Parameters:

list - Entity list to be converted into ATOM format.

context - Data context.

Returns:

An entity list converted into an ATOM feed, wrapped as an XML document.

formatCall

public static XmlDocument formatCall(DataMethodCall call,
                                     DataContext context)

Return an action invocation request body in XML format.

Parameters:

call - Action invocation.

context - Data context.

Returns:

An action invocation request body in XML format.

formatDocument

public static XmlDocument formatDocument(DataValue value,
                                         DataContext context)

Return a data value formatted in OData ATOM representation.

Parameters:

value - Data value.

context - Data context.

Returns:

A data value formatted in OData ATOM representation.

formatLink

public static XmlDocument formatLink(EntityValue entity,
                                     DataContext context)

Return an entity reference formatted in OData ATOM representation.

Parameters:

entity - Entity value.

context - Data context.

Returns:

An entity reference formatted in OData ATOM representation.

fromBasicList

public static void fromBasicList(XmlElement element,
                                 DataValueList list,
                                 DataContext context)

Convert a basic list to ATOM format.

Parameters:

element - XML element to receive the ATOM format.

list - Value to be converted into ATOM format.

context - Data context.

fromComplexList

public static void fromComplexList(XmlElement element,
                                   ComplexValueList list,
                                   DataContext context)

Convert a complex list to ATOM format.

Parameters:

element - XML element to receive the ATOM format.

list - Value to be converted into ATOM format.

context - Data context.

fromComplexValue

public static void fromComplexValue(XmlElement element,
                                    ComplexValue complex,
                                    DataContext context)

Convert a complex value to ATOM format.

Parameters:

element - XML element to receive the ATOM format.

complex - (nullable) Value to be converted into ATOM format.

context - Data context.

fromDataValue

public static void fromDataValue(XmlElement element,
                                 DataValue value,
                                 DataContext context)

Convert a data value to ATOM format.

Parameters:

element - XML element to receive the ATOM format.

value - (nullable) Value to be converted into ATOM format.

context - Data context.

fromEntityList

public static void fromEntityList(XmlElement feed,
                                  EntityValueList list,
                                  DataContext context)

Convert an entity list to ATOM format.

Parameters:

feed - XML element to receive the ATOM format.

list - Value to be converted into ATOM format.

context - Data context.

fromEntityValue

public static void fromEntityValue(XmlElement entry,
                                   EntityValue entity,
                                   DataContext context)

Convert an entity value to ATOM format.

Parameters:

entry - XML element to receive the ATOM format.

entity - (nullable) Value to be converted into ATOM format.

context - Data context.

parseDocument

public static DataValue parseDocument(XmlElement element,
                                      DataType type,
                                      DataContext context)

Return (nullable) A data value (basic, basic list, complex list, entity, entity list) parsed from OData ATOM representation.

Parameters:

element - (nullable) Value in ATOM representation.

type - Data type for the expected parsed result.

context - Data context.

Returns:

(nullable) A data value (basic, basic list, complex list, entity, entity list) parsed from OData ATOM representation.

parseLink

public static EntityValue parseLink(XmlElement element,
                                    EntityType type,
                                    DataContext context)

Return an entity reference parsed from OData ATOM representation. The reference will have EntityValue.isReference == true and EntityValue.readLink != null.

Parameters:

element - Value in ATOM representation.

type - Entity type for the expected parsed result.

context - Data context.

Returns:

An entity reference parsed from OData ATOM representation.

parseLinks

public static EntityValueList parseLinks(XmlElement element,
                                         EntityType type,
                                         DataContext context)

Return a list of entity references parsed from OData ATOM representation. Each reference will have EntityValue.isReference == true and EntityValue.readLink != null.

See Also:

AtomValue.parseLink.

Parameters:

element - Value in ATOM representation.

type - Entity type for the expected parsed result.

context - Data context.

Returns:

A list of entity references parsed from OData ATOM representation.

parseReference

public static EntityValue parseReference(java.lang.String uri,
                                         EntityType entityType,
                                         EntitySet entitySet,
                                         DataContext context)

See parseReference(String, EntityType, EntitySet, DataContext, boolean).

Parameters:

uri - Uri parameter.

entityType - EntityType parameter.

entitySet - EntitySet parameter.

context - Context parameter.

Returns:

(see linked method).

parseReference

public static EntityValue parseReference(java.lang.String uri,
                                         EntityType entityType,
                                         EntitySet entitySet,
                                         DataContext context,
                                         boolean binding)

Return an entity reference parsed from OData ATOM reference representation. The reference will have EntityValue.isReference == true, EntityValue.readLink != null, and EntityValue.hasKey will be true if the URI was in canonical URL format.

Parameters:

uri - Entity reference URI.

entityType - Entity type for the expected parsed result.

entitySet - Entity set for the expected parsed result.

context - Data context.

binding - Is the reference for a "bind operation"?

Returns:

An entity reference parsed from OData ATOM reference representation.

toBasicList

public static DataValueList toBasicList(XmlElement element,
                                        DataType type,
                                        DataContext context)

Return a basic list parsed from ATOM format.

Parameters:

element - (nullable) Value in ATOM format.

type - Data type for the expected parsed result.

context - Data context.

Returns:

A basic list parsed from ATOM format.

toComplexList

public static ComplexValueList toComplexList(XmlElement element,
                                             DataType type,
                                             DataContext context)

Return a complex list parsed from ATOM format.

Parameters:

element - (nullable) Value in ATOM format.

type - Data type for the expected parsed result.

context - Data context.

Returns:

A complex list parsed from ATOM format.

toComplexValue

public static ComplexValue toComplexValue(XmlElement element,
                                          ComplexType type,
                                          DataContext context)

Return (nullable) A complex value parsed from ATOM format.

Parameters:

element - (nullable) Value in ATOM format.

type - Data type for the expected parsed result.

context - Data context.

Returns:

(nullable) A complex value parsed from ATOM format.

toDataValue

public static DataValue toDataValue(XmlElement element,
                                    DataType type,
                                    DataContext context)

Return (nullable) A data value parsed from ATOM format.

Parameters:

element - (nullable) Value in ATOM format.

type - Data type for the expected parsed result.

context - Data context.

Returns:

(nullable) A data value parsed from ATOM format.

toEntityList

public static EntityValueList toEntityList(XmlElement feed,
                                           DataType type,
                                           DataContext context)

Return an entity list parsed from ATOM format.

Parameters:

feed - (nullable) Value in ATOM format.

type - Data type for the expected parsed result.

context - Data context.

Returns:

An entity list parsed from ATOM format.

toEntityValue

public static EntityValue toEntityValue(XmlElement entry,
                                        EntityType type,
                                        DataContext context)

Return (nullable) An entity value parsed from ATOM format.

Parameters:

entry - (nullable) Value in ATOM format.

type - Data type for the expected parsed result.

context - Data context.

Returns:

(nullable) An entity value parsed from ATOM format.