com.sap.smp.client.odata.impl

Class ODataEntityDefaultImpl

java.lang.Object

com.sap.smp.client.odata.impl.ODataEntityDefaultImpl

All Implemented Interfaces:

ODataEntity, ODataPayload, java.io.Serializable

public class ODataEntityDefaultImpl
extends java.lang.Object
implements ODataEntity

Default implementation of ODataEntity.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.smp.client.odata.ODataPayload

ODataPayload.Type

Constructor Summary

Constructors

Constructor and Description
ODataEntityDefaultImpl(java.lang.String type) Constructor.
ODataEntityDefaultImpl(java.lang.String type, java.util.Map<AnnotationName,java.lang.String> localAnnotations)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAnnotation(AnnotationName name) Returns the annotation value specified by the given fully qualified local annotation name.
java.lang.String	getAnnotation(java.lang.String namespace, java.lang.String name) Returns the annotation value specified by the given local annotation namespace and localname.
java.util.Set<AnnotationName>	getAnnotationNames() Returns a set of fully qualified local annotation names.
java.net.URL	getEditMediaLink() Returns the edit media link of this entity.
java.lang.String	getEditResourcePath() Returns the path to the endpoint through which this entity can be edited.
java.lang.String	getEntityType() Returns the type of the entity in it's fully-qualified form which includes the namespace prefix.
java.lang.String	getEtag() Returns the ETag of the entry backing this entity.
java.lang.String	getMediaContentType() Returns the content type of the media.
java.lang.String	getMediaEtag() Returns the ETag of the media resource.
java.net.URL	getMediaLink() Returns the media link of this entity.
ODataNavigationProperty	getNavigationProperty(java.lang.String key) Returns the navigation property associated with the given key.
java.util.Set<java.lang.String>	getNavigationPropertyNames() Returns the set containing the names of navigation properties.
ODataPropMap	getProperties() Returns the current map containing the data properties of this entity.
java.lang.String	getResourcePath() Returns the path from which this entity has been obtained.
int	hashCode()
boolean	isMediaEntry() Convenience method telling whether this entity is a media entry.
void	setEditResourcePath(java.lang.String editResourcePath)
void	setEtag(java.lang.String etag) Sets the ETag of the entry backing this entity.
void	setMediaEtag(java.lang.String mediaEtag) Sets the media ETag
void	setMediaLink(java.lang.String mediaContentType, java.net.URL mediaLink, java.net.URL editMediaLink) Sets the media links and the media content type of this entity.
ODataNavigationProperty	setNavigationProperty(java.lang.String key, ODataNavigationProperty link) Associates the specified key with the specified navigation property.
void	setResourcePath(java.lang.String resourcePath)
void	setResourcePath(java.lang.String resourcePath, java.lang.String editResourcePath) Sets resource paths.

Methods inherited from class java.lang.Object

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

Constructor Detail

ODataEntityDefaultImpl

public ODataEntityDefaultImpl(java.lang.String type)

Constructor.

Parameters:

type - type of the entity

ODataEntityDefaultImpl

public ODataEntityDefaultImpl(java.lang.String type,
                              java.util.Map<AnnotationName,java.lang.String> localAnnotations)

Method Detail

getResourcePath

public java.lang.String getResourcePath()

Description copied from interface: ODataEntity

Returns the path from which this entity has been obtained. The path is relative to the base URL.

Specified by:

getResourcePath in interface ODataEntity

Returns:

the resource path, can be null

setResourcePath

public void setResourcePath(java.lang.String resourcePath)

getEditResourcePath

public java.lang.String getEditResourcePath()

Description copied from interface: ODataEntity

Returns the path to the endpoint through which this entity can be edited. The path is relative to the base URL.

Specified by:

getEditResourcePath in interface ODataEntity

Returns:

the edit resource path, can be null

setEditResourcePath

public void setEditResourcePath(java.lang.String editResourcePath)

isMediaEntry

public boolean isMediaEntry()

Description copied from interface: ODataEntity

Convenience method telling whether this entity is a media entry. An entity qualifies as such in case it either the media link or the edit media link is set.

Specified by:

isMediaEntry in interface ODataEntity

Returns:

true if this is a media entry, false otherwise

getMediaContentType

public java.lang.String getMediaContentType()

Description copied from interface: ODataEntity

Returns the content type of the media.

Specified by:

getMediaContentType in interface ODataEntity

Returns:

the media content type, can be null

getMediaLink

public java.net.URL getMediaLink()

Description copied from interface: ODataEntity

Returns the media link of this entity.

Specified by:

getMediaLink in interface ODataEntity

Returns:

the media link, can be null

getEditMediaLink

public java.net.URL getEditMediaLink()

Description copied from interface: ODataEntity

Returns the edit media link of this entity.

Specified by:

getEditMediaLink in interface ODataEntity

Returns:

the edit media link, can be null

setMediaLink

public void setMediaLink(java.lang.String mediaContentType,
                         java.net.URL mediaLink,
                         java.net.URL editMediaLink)

Description copied from interface: ODataEntity

Sets the media links and the media content type of this entity.

Specified by:

setMediaLink in interface ODataEntity

Parameters:

mediaContentType - the media content type, can be null

mediaLink - the media link, can be null

editMediaLink - the edit media link, can be null

getNavigationPropertyNames

public java.util.Set<java.lang.String> getNavigationPropertyNames()

Description copied from interface: ODataEntity

Returns the set containing the names of navigation properties. The returned set may be backed by this object and therefore should not be modified by the caller!

Specified by:

getNavigationPropertyNames in interface ODataEntity

Returns:

the set of navigation property names, always non-null

getNavigationProperty

public ODataNavigationProperty getNavigationProperty(java.lang.String key)

Description copied from interface: ODataEntity

Returns the navigation property associated with the given key.

Specified by:

getNavigationProperty in interface ODataEntity

Parameters:

key - the key of the property, can be null

Returns:

the associated navigation property or null if none is found

setNavigationProperty

public ODataNavigationProperty setNavigationProperty(java.lang.String key,
                                                     ODataNavigationProperty link)

Description copied from interface: ODataEntity

Associates the specified key with the specified navigation property.

Specified by:

setNavigationProperty in interface ODataEntity

Parameters:

key - the key, must be non-null

link - the property, must be non-null

Returns:

the previous property associated with the key, can be null

getProperties

public ODataPropMap getProperties()

Description copied from interface: ODataEntity

Returns the current map containing the data properties of this entity.

Specified by:

getProperties in interface ODataEntity

Returns:

the map of entity properties, always non-null

getEntityType

public java.lang.String getEntityType()

Description copied from interface: ODataEntity

Returns the type of the entity in it's fully-qualified form which includes the namespace prefix.

Specified by:

getEntityType in interface ODataEntity

Returns:

the entity type, can be null

setResourcePath

public void setResourcePath(java.lang.String resourcePath,
                            java.lang.String editResourcePath)

Description copied from interface: ODataEntity

Sets resource paths. All arguments should be relative to the base URL.

Specified by:

setResourcePath in interface ODataEntity

Parameters:

resourcePath - the resource path, can be null

editResourcePath - the edit resource path, can be null

getEtag

public java.lang.String getEtag()

Description copied from interface: ODataEntity

Returns the ETag of the entry backing this entity.

Specified by:

getEtag in interface ODataEntity

Returns:

the entity tag, can be null

setEtag

public void setEtag(java.lang.String etag)

Description copied from interface: ODataEntity

Sets the ETag of the entry backing this entity.

Specified by:

setEtag in interface ODataEntity

Parameters:

etag - the entity tag, can be null

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getAnnotationNames

public java.util.Set<AnnotationName> getAnnotationNames()

Description copied from interface: ODataEntity

Returns a set of fully qualified local annotation names.

Specified by:

getAnnotationNames in interface ODataEntity

Returns:

set of fully qualified local annotation names, always non-null

getAnnotation

public java.lang.String getAnnotation(AnnotationName name)

Description copied from interface: ODataEntity

Returns the annotation value specified by the given fully qualified local annotation name.

Specified by:

getAnnotation in interface ODataEntity

Parameters:

name - fully qualified local annotation name

Returns:

the annotation value if found, null otherwise

getAnnotation

public java.lang.String getAnnotation(java.lang.String namespace,
                                      java.lang.String name)

Description copied from interface: ODataEntity

Returns the annotation value specified by the given local annotation namespace and localname.

Specified by:

getAnnotation in interface ODataEntity

Parameters:

namespace - annotation namespace, can be null

name - annotation local name. It MUST be non-null, otherwise NullPointerException is thrown

Returns:

the annotation value if found, null otherwise

getMediaEtag

public java.lang.String getMediaEtag()

Description copied from interface: ODataEntity

Returns the ETag of the media resource. It can be non-null if the this entity is a media entity.

Specified by:

getMediaEtag in interface ODataEntity

Returns:

the entity media tag, can be null

setMediaEtag

public void setMediaEtag(java.lang.String mediaEtag)

Description copied from interface: ODataEntity

Sets the media ETag

Specified by:

setMediaEtag in interface ODataEntity

Parameters:

mediaEtag - the media etag, can be null