ODataEntry class

Consists of APIs related to OData Entry.

Package

com.sap.mobile.lib.parser

Syntax

public class ODataEntry extends ParserDocument implements IODataEntry

Implemented interfaces

IODataEntry

Derived classes

Members

All members of ODataEntry, including inherited members.

Variables

Modifier and Type	Variable	Description
protected transient JsonObject	jsonObject	JSON related variables
protected transient IODataSchema	schema
protected String	collectionId
protected cacheState	Cachestate
protected boolean	isLocalEntry
protected Long	cache_timestamp
protected static transient static final String	FILTER
protected static transient static final String	FILTER_EQ
protected static transient static final String	FILTER_AND
protected static transient static final int	TRUE
protected static transient static final int	FALSE
protected static transient static final int	NOT_TESTED

Constructors

Modifier and Type	Constructor	Description
public	ODataEntry()
public	ODataEntry(boolean)
protected	ODataEntry(int[], String[])
public	ODataEntry(IODataSchema)
public	ODataEntry(JsonObject)	Json Related
public	ODataEntry(ParserDocument)
public	ODataEntry(ParserDocument, IODataSchema)

Methods

Modifier and Type	Method	Description
protected void	addPropertyValues(IODataProperty, Map< String, String >, String)
public ODataEntry	clone()	Creates a copy of this object.
protected void	fillPropertyData(IODataProperty, String...)
protected void	fillPropertyDataWithAttribute(IODataProperty, String, String, boolean, String...)
public List< IODataLink >	getActionLinks()	Returns OData Link objects that are set as action links (Has semantics (SAP name-space) attribute with value 'action')
public String	getAuthorName()	Returns The value of the 'name' OData element of the 'author' OData element.
public cacheState	getCachestate()
public Long	getCacheTimestamp()
public String	getCollectionId()	Returns the Id of the OCata Collection that this Entry belongs to.
public String	getContentType()	Returns the content type of the entry.
public String	getEtag()	Returns the Id of the OData Collection that this Entry belongs to.
public String	getFilterUrl()	Returns the full execution URL hat can be used for filtering collection search for this single entry.
public List< IODataProperty >	getGPUseInSearchPropertiesData()	Returns the value and meta information (retrieved from OData Schema document) of the properties of this OData Entry document with 'true' use-in-search (Generic Player name-space) attribute value.
public List< IODataProperty >	getGPVisibleInDetailPropertiesData()	Returns the value and meta information (retrieved from OData Schema document) of the properties of this OData Entry document with 'true' visible-in-detail (Generic Player name-space) attribute value.
public List< IODataProperty >	getGPVisibleInListPropertiesData()	Returns the value and meta information (retrieved from OData Schema document) of the properties of this OData Entry document with 'true' visible-in-list (Generic Player name-space) attribute value.
public List< IODataIcon >	getIcons()	Returns the list of the appropriate OData elements.
public String	getId()	Returns The Id of this OData Entry (value of appropriate OData Id element)
public boolean	getIsLocal()
public Map< String, String >	getKeyPropertyValues()	Returns the values of the properties that are marked as key properties in the OData Schema document.
public Date	getLastUpdated()	Returns The parsed value of the 'updated' OData Element.
public List< IODataLink >	getLinks()	Returns the list of the appropriate OData elements.
public String	getMediaSrc()	Returns the media source if the entry has a media content.
public List< IODataProperty >	getPropertiesData()	Returns the value and meta information (retrieved from OData Schema document) of the properties of this Odata Entry document.
public List< IODataProperty >	getPropertiesDataWithAttribute(String, String)	Returns the value and meta information (retrieved from OData Schema document) of the properties of this OData Entry document with the given attribute value.
public List< IODataProperty >	getPropertiesDataWithAttribute(String, String, boolean)	Returns the value and meta information (retrieved from OData Schema document) of the properties of this OData Entry document with the given attribute value.
public IParserDocument	getPropertiesDocument()	Returns the representer document of OData 'properties' (Metadata name-space) document This method is created for performance reasons mostly to use in search methods.
public String	getPropertyValue(String...)	Returns the value of the appropriate property.
public List< String >	getPropertyValues(List< String[]>)	Return list of property values for the given property paths.
public Map< String, String >	getPropertyValues()	Returns the all the values of properties contained by this OData Entry document Key for the properties will be their name of their full path in case they are enclosed by Complex Types.
public List< IODataLink >	getRelatedDataLinks()	Returns OData Link objects that represents links to Related Data.
public List< IODataProperty >	getSAPSearchablePropertiesData()	Returns the value and meta information (retrieved from OData Schema document) of the properties of this OData Entry document with 'true' searchable (SAP name-space) attribute value.
public IODataSchema	getSchema()	Returns the appropriate OData Schema object.
public IODataLink	getSelfLink()	Returns OData Link object that should be used for self related operations (with 'rel' attribute value 'self' or 'edit')
public IODataLink	getSubscriptionLink()	Returns OData Link object that should be used for subscription or null if there is no subscription link defined.
public String	getSummary()	Returns The value of the appropriate OData element.
public String	getTitle()	Returns The value of the appropriate OData element.
protected void	materialize()
protected void	parseCollectionId()
protected long	parseEdmTime(String)
public void	putComplexPropertyValue(String, String...)	Puts the new property element as a sub-element of the 'complex properties' OData element.
public void	putContentType(String)	Puts the content type for a new entry object.
public void	putDocument(IParserDocument, String...)	Insert the document under the element with the given route inserted document will be placed before already existing documents with the same route name under All missing elements from the route will be created.
public void	putId(String)	Sets id of this OData Entry document (value of appropriate OData Id element)
public void	putMediaSrc(String)	Puts the media source for a new entry object.
public void	putPropertyValue(String, String)	Puts the new property element as a sub-element of the 'properties' OData element.
public void	putPropertyValue(String, String, boolean)	Puts the new property element as a sub-element of the 'properties' OData element.
public void	read(BufferedReader)
protected String	resolveTargetCollection(IODataLink)
public void	setAuthorName(String)	Sets the value of the 'name' OData element of the 'author' OData element.
public void	setCachestate(cacheState)
public void	setCacheTimestamp(Long)
public void	setCollectionId(String)	Maintains the Id of the OCata Collection that this Entry belongs to.
public void	setIsLocal(boolean)
public void	setSchema(IODataSchema)	Maintains the reference to the appropriate OData Schema object.
public void	setSummary(String)	Sets the value of the appropriate OData element.
public void	setTitle(String)	Sets the value of the appropriate OData element.
public void	write(BufferedWriter)

Inherited members from IParserDocument

Modifier and Type	Member	Description
public abstract IParserDocument	clone()	Creates a copy of this object.
public abstract String	getAttribute(String...)	Returns the value of the first attribute with the given route.
public abstract List< String >	getAttributes(String...)	Returns all the values of attributes with the given route.
public abstract Map< String, String >	getChildAttributeMap(String...)	Returns all the name-value pairs of attributes contained by the element with the given route.
public abstract List< String >	getChildAttributes(String...)	Returns all the values of attributes contained by the element with the given route.
public abstract List< IParserDocument >	getChildDocuments(String...)	Returns the elements contained by the element with the given route.
public abstract List< IParserDocument >	getChildDocumentsWithAttribute(String, String, String...)	Returns the elements contained by the element with the given route and having the given attribute with the given value.
public abstract List< IParserDocument >	getChildDocumentsWithAttribute(String, String, boolean, String...)	Returns the elements contained by the element with the given route and having the given attribute with the given value.
public abstract IParserDocument	getDocument(String...)	Returns the first element with the given route.
public abstract List< IParserDocument >	getDocuments(String...)	Returns all the elements with the given route.
public abstract List< IParserDocument >	getDocumentsWithAttribute(String, String, String...)	Returns the elements with the given route that contains the given attribute with the given value.
public abstract List< IParserDocument >	getDocumentsWithAttribute(String, String, boolean, String...)	Returns the elements with the given route that contains the given attribute with the given value.
public abstract IParserDocument	getDocumentWithAttribute(String, String, String...)	Returns the first element with the given route that contains the given attribute with the given value.
public abstract IParserDocument	getDocumentWithAttribute(String, String, boolean, String...)	Returns the first element with the given route that contains the given attribute with the given value.
public abstract String	getElementName()	Returns The name of the root element of this document.
public abstract String	getFunctionImportComplexPropertyValue(String...)
public abstract String	getPrefixForUri(String)	Returns the appropriate name-space prefix for the given XML name-space URI.
public abstract String[]	getStrings()	Returns all the string values contained by this document.
public abstract String	getValue(String...)	Returns the value of the first element with the given route.
public abstract List< String >	getValues(String...)	Returns all the values of elements with the given route.
public abstract void	putAttribute(String, String...)	Sets the value of the attribute with the given route If attribute does not exist it will be created as well as all other non existing elements in the route.
public abstract void	putDocument(IParserDocument, String...)	Insert the document under the element with the given route inserted document will be placed before already existing documents with the same route name under All missing elements from the route will be created.
public abstract void	putValue(String, String...)	Sets the value of the first element with the given route.
public abstract boolean	removeAttribute(String...)	Removes first element with the given route.
public abstract boolean	removeAttributes(String...)	Removes all the attribute with the given route.
public abstract boolean	removeDocument(String...)	Removes first element with the given route For removing multiple element use setDocuemtns with null arguments.
public abstract void	setAttributes(List< String >, String...)	Sets all the values of the attributes with the given route Values will be paired to attributes in order Attributes with greater or equals index than size of new values will be untouched Attributes paired with null values will be removed.
public abstract void	setDocuments(List< IParserDocument >, String...)	Replaces all the elements with the given route Documents will be paired to elements in order Elements with greater or equals index than size of new elements will be untouched Element paired with null will be removed.
public abstract void	setElementName(String, String...)	Sets the name of the root element with the given route Use empty route for setting root name of this document.
public abstract void	setValues(List< String >, String...)	Sets all the values of the elements with the given rout Values will be paired to elements in order Elements with greater or equals index than size of new values will be untouched Null values will be treated as empty strings.
public abstract String	toXMLString()	Returns the XML string representation of this object.

Inherited members from IPersistable

Modifier and Type	Member	Description
public void	read(BufferedReader)
public void	write(BufferedWriter)