com.sap.cloud.server.odata

Class QueryFormatter

java.lang.Object

com.sap.cloud.server.odata.QueryFormatter

public abstract class QueryFormatter
extends java.lang.Object

Formatter for OData queries.

Constructor Summary

Constructors

Constructor and Description
QueryFormatter()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(DataQuery query, DataContext context) Return a formatted data query for use in an OData URL.
static java.lang.String	formatCanonicalURL(EntityValue entity, DataContext context) See formatCanonicalURL(EntityValue, DataContext, boolean).
static java.lang.String	formatCanonicalURL(EntityValue entity, DataContext context, boolean absolute) Return the canonical URL of an entity (relative by default, absolute if specified).
static java.lang.String	formatDataValue(DataValue value, DataContext context) Return a formatted data value for use in an OData URL.
static java.lang.String	formatEditLink(EntityValue entity, DataContext context) Return the exit link of an entity (if set) or the entity's canonical URL.
static java.lang.String	formatEntityID(EntityValue entity, DataContext context) Return the formatted ID of an entity for use in a URL, i.e.
static java.lang.String	formatEntityKey(EntityKey entityKey, EntityType entityType, DataContext context) Return the formatted key of an entity for use in a URL, e.g.
static java.lang.String	formatReadLink(EntityValue entity, DataContext context) Return the read link of an entity (if set) or the entity's canonical URL.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryFormatter

public QueryFormatter()

Method Detail

format

public static java.lang.String format(DataQuery query,
                                      DataContext context)

Return a formatted data query for use in an OData URL.

Parameters:

query - Data query.

context - Data context.

Returns:

A formatted data query for use in an OData URL.

formatCanonicalURL

public static java.lang.String formatCanonicalURL(EntityValue entity,
                                                  DataContext context)

See formatCanonicalURL(EntityValue, DataContext, boolean).

Parameters:

entity - Entity parameter.

context - Context parameter.

Returns:

(see linked method).

formatCanonicalURL

public static java.lang.String formatCanonicalURL(EntityValue entity,
                                                  DataContext context,
                                                  boolean absolute)

Return the canonical URL of an entity (relative by default, absolute if specified).

See Also:

Canonical URL (OData V4).

Parameters:

entity - Entity value.

context - Data context.

absolute - Is absolute URL required? (defaults to `false`, resulting in relative URL).

Returns:

The canonical URL of an entity (relative by default, absolute if specified).

formatDataValue

public static java.lang.String formatDataValue(DataValue value,
                                               DataContext context)

Return a formatted data value for use in an OData URL.

Parameters:

value - (nullable) Data value.

context - Data context.

Returns:

A formatted data value for use in an OData URL.

formatEditLink

public static java.lang.String formatEditLink(EntityValue entity,
                                              DataContext context)

Return the exit link of an entity (if set) or the entity's canonical URL.

Parameters:

entity - Entity value.

context - Data context.

Returns:

The exit link of an entity (if set) or the entity's canonical URL.

formatEntityID

public static java.lang.String formatEntityID(EntityValue entity,
                                              DataContext context)

Return the formatted ID of an entity for use in a URL, i.e. entity.entityID (if set) or the entity's canonical URL.

Parameters:

entity - Entity value.

context - Data context.

Returns:

The formatted ID of an entity for use in a URL, i.e. entity.entityID (if set) or the entity's canonical URL.

formatEntityKey

public static java.lang.String formatEntityKey(EntityKey entityKey,
                                               EntityType entityType,
                                               DataContext context)

Return the formatted key of an entity for use in a URL, e.g. "(123)" or "(n=123,s='xyz')".

Parameters:

entityKey - Entity key.

entityType - Entity type.

context - Data context.

Returns:

The formatted key of an entity for use in a URL, e.g. "(123)" or "(n=123,s='xyz')".

formatReadLink

public static java.lang.String formatReadLink(EntityValue entity,
                                              DataContext context)

Return the read link of an entity (if set) or the entity's canonical URL.

Parameters:

entity - Entity value.

context - Data context.

Returns:

The read link of an entity (if set) or the entity's canonical URL.