ODataSubscriptionEntry class

Syntax

public class ODataSubscriptionEntry extends ODataEntry, IODataSubscriptionEntry

Members

All members of ODataSubscriptionEntry, including inherited members.

Constructors
Modifier and Type Constructor Description
public ODataSubscriptionEntry()  
public ODataSubscriptionEntry(String, String)  
public ODataSubscriptionEntry(String, String, String, String, String, String)  
public ODataSubscriptionEntry(ParserDocument)  
protected ODataSubscriptionEntry(int[], String[])  
Methods
Modifier and Type Method Description
public String getCollection() Returns The value of the appropriate entry property.
public String getDeliveryAddress() Returns The value of the appropriate entry property.
public String getFilter() Returns The value of the appropriate entry property.
public String getSelect() Returns The value of the appropriate entry property.
public void setCollection(String) Sets the value of the appropriate entry property.
public void setDeliveryAddress(String) Sets the value of the appropriate entry property.
public void setFilter(String) Sets the value of the appropriate entry property.
public void setSelect(String) Sets the value of the appropriate entry property.
Inherited members from ODataEntry
Modifier and Type Member Description
protected void addPropertyValues(IODataProperty, Map< String, String >, String)  
protected Long cache_timestamp  
protected cacheState Cachestate  
public ODataEntry clone() Creates a copy of this object.
protected String collectionId  
protected static transient static final int FALSE  
protected void fillPropertyData(IODataProperty, String...)  
protected void fillPropertyDataWithAttribute(IODataProperty, String, String, boolean, String...)  
protected static transient static final String FILTER  
protected static transient static final String FILTER_AND  
protected static transient static final String FILTER_EQ  
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< T > T getPropertyValueParsed(String...) Returns the value of the appropriate property parsed to it's real type.
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 boolean isLocalEntry  
protected transient JsonObject jsonObject JSON related variables
protected void materialize()  
protected static transient static final int NOT_TESTED  
public ODataEntry()  
public ODataEntry(boolean)  
protected ODataEntry(int[], String[])  
public ODataEntry(IODataSchema)  
public ODataEntry(ParserDocument)  
public ODataEntry(ParserDocument, IODataSchema)  
public ODataEntry(JsonObject) Json Related
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)  
protected transient IODataSchema schema  
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.
protected static transient static final int TRUE  
public void write(BufferedWriter)  
Inherited members from ParserDocument
Modifier and Type Member Description
static transient final String ANY_STRING  
static transient final int ATTRIBUTE_ID  
static transient final String ATTRIBUTE_STRING  
protected Map< String, String > extensions  
public String getAttribute(String...) Returns the value of the first attribute with the given route.
public List< String > getAttributes(String...) Returns all the values of attributes with the given route.
protected int getAttributesEndPosition(int[], int, int)  
public Map< String, String > getChildAttributeMap(String...) Returns all the name-value pairs of attributes contained by the element with the given route.
public List< String > getChildAttributes(String...) Returns all the values of attributes contained by the element with the given route.
public List< IParserDocument > getChildDocuments(String...) Returns the elements contained by the element with the given route.
public 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 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 ParserDocument getDocument(String...) Returns the first element with the given route.
protected List< int[]> getDocumentPositions(String[], int, boolean, boolean)  
public List< IParserDocument > getDocuments(String...) Returns all the elements with the given route.
public List< IParserDocument > getDocumentsWithAttribute(String, String, String...) Returns the elements with the given route that contains the given attribute with the given value.
public List< IParserDocument > getDocumentsWithAttribute(String, String, boolean, String...) Returns the elements with the given route that contains the given attribute with the given value.
public IParserDocument getDocumentWithAttribute(String, String, String...) Returns the first element with the given route that contains the given attribute with the given value.
public IParserDocument getDocumentWithAttribute(String, String, boolean, String...) Returns the first element with the given route that contains the given attribute with the given value.
public String getElementName() Returns The name of the root element of this document.
public String getExtension(String)  
public String getFunctionImportComplexPropertyValue(String...)  
static int getNameId(String, boolean, boolean)  
public static List< String > getNameMap()  
public static String getPrefix(String)  
public String getPrefixForUri(String) Returns the appropriate name-space prefix for the given XML name-space URI.
public static Map< String, String > getPrefixMapping()  
protected List< Integer > getStringPositions(String[], int, boolean, boolean)  
public String[] getStrings() Returns all the string values contained by this document.
public String getValue(String...) Returns the value of the first element with the given route.
public List< String > getValues(String...) Returns all the values of elements with the given route.
protected int[] insertRoutePositions(int[], int, int[])  
protected void insertRoutesPositions(int, int[])  
protected void insertStringsPositions(int, String[])  
protected String[] insertStringsPositions(String[], int, String[])  
boolean isComplexEntity  
boolean isJson  
protected boolean isMatched(String, String)  
static List< String > nameMap  
ParserDocument()  
ParserDocument(boolean)  
public ParserDocument(String)  
public ParserDocument(ParserDocument)  
protected ParserDocument(int[], String[])  
protected ParserDocument(String, boolean)  
static Map< String, String > prefixMapping  
public 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 void putExtension(String, String)  
protected void putString(int, String, int, String...)  
public void putValue(String, String...) Sets the value of the first element with the given route.
public static void readNameMap(BufferedReader)  
public boolean removeAttribute(String...) Removes first element with the given route.
public boolean removeAttributes(String...) Removes all the attribute with the given route.
public boolean removeDocument(String...) Removes first element with the given route For removing multiple element use setDocuemtns with null arguments.
public void removeExtension(String)  
protected void removeRoutesPositions(int, int)  
protected int[] removeRoutesPositions(int[], int, int)  
protected boolean removeString(String...)  
protected boolean removeStrings(String...)  
protected void removeStringsPositions(int, int)  
protected String[] removeStringsPositions(String[], int, int)  
protected int replaceRoutesPositions(int, int, int[])  
protected int[] replaceRoutesPositions(int[], int, int, int[])  
protected int replaceStringsPositions(int, int, String[])  
protected String[] replaceStringsPositions(String[], int, int, String[])  
public static String resolveUrl(String, String)  
protected int[] routes  
public void setAttribute(String, String...)  
public 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 boolean setDocument(IParserDocument, String...)  
public 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 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 static void setNameMap(List< String >)  
public static void setPrefixMapping(Map< String, String >)  
protected void setString(String, String...)  
protected void setStrings(List< String >, String...)  
public void setValue(String, String...)  
public 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.
protected String[] strings  
public String toXMLString() Returns the XML string representation of this object.
protected static final String URL_PROTOCOL_PREFIX  
static transient final int VALUE_ID  
static transient final String VALUE_STRING  
public static void writeNameMap(BufferedWriter)  
Inherited members from IParserDocument
Modifier and Type Member Description
public static final String ATTRIBUTE_ETAG Name of the appropriate OData element.
public static final String ATTRIBUTE_VALUEPREFIX_EDMTYPE Value prefix for EDM Type type values.
public static Map< String, String > DEFAULT_PREFIXMAPPING The default XML Namespace-to-Prefix mapping used for building XMLS.
public static final String[] EDMDATETIME_PATTERNS Possible EDM DateTime patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String[] EDMDATETIMEOFFSET_PATTERNS Possible EDM TimeOffset patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String EDMTIME_PATTERN EDM Time pattern.
public static String ELEMENT_FEED Name of the appropriate OData element.
public static final String ELEMENT_ID Name of the appropriate OData element.
public static final String ROOT_DOCUMENT_NAME The default root element name for a new document.
public static final String XMLNS_APPLICATION_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_ATOM_URI Constant for XMLNS URI: http://www.w3.org/2005/Atom.
public static final String XMLNS_DATASERVICES_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_EDM_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/05/edm.
public static final String XMLNS_EDMX_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/06/edmx.
public static final String XMLNS_GENERICPLAYER_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData/GenericPlayer.
public static final String XMLNS_METADATA_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices/metadata.
public static final String XMLNS_SAP_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData.
Inherited members from IPersistable
Modifier and Type Member Description
public void read(BufferedReader)  
public void write(BufferedWriter)  
Inherited members from IODataEntry
Modifier and Type Member Description
public static final String ATTRIBUTE_SEMANTICS Name of the appropriate OData attribute.
public static final String ATTRIBUTE_TERM Name of the appropriate OData attribute.
public static final String ATTRIBUTE_VALUE_SEMANTICS_ACTION Value option for appropriate OData attribute.
public static final String ELEMENT_AUTHOR Name of the appropriate OData element.
public static final String ELEMENT_CATEGORY Name of the appropriate OData element.
public static final String ELEMENT_CONTENT Name of the appropriate OData element.
public static final String ELEMENT_ENTRY Name of the appropriate OData element.
public static final String ELEMENT_LINK Name of the appropriate OData element.
public static final String ELEMENT_NAME Name of the appropriate OData element.
public static final String ELEMENT_PROPERTIES Name of the appropriate OData element.
public static final String ELEMENT_SUMMARY Name of the appropriate OData element.
public static final String ELEMENT_TITLE Name of the appropriate OData element.
public static final String ELEMENT_UPDATED Name of the appropriate OData element.
public static final String PROPERTY_LEVEL_SEPARATOR  
Inherited members from IParserDocument
Modifier and Type Member Description
public static final String ATTRIBUTE_ETAG Name of the appropriate OData element.
public static final String ATTRIBUTE_VALUEPREFIX_EDMTYPE Value prefix for EDM Type type values.
public abstract IParserDocument clone() Creates a copy of this object.
public static Map< String, String > DEFAULT_PREFIXMAPPING The default XML Namespace-to-Prefix mapping used for building XMLS.
public static final String[] EDMDATETIME_PATTERNS Possible EDM DateTime patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String[] EDMDATETIMEOFFSET_PATTERNS Possible EDM TimeOffset patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String EDMTIME_PATTERN EDM Time pattern.
public static String ELEMENT_FEED Name of the appropriate OData element.
public static final String ELEMENT_ID Name of the appropriate OData element.
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 static final String ROOT_DOCUMENT_NAME The default root element name for a new document.
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.
public static final String XMLNS_APPLICATION_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_ATOM_URI Constant for XMLNS URI: http://www.w3.org/2005/Atom.
public static final String XMLNS_DATASERVICES_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_EDM_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/05/edm.
public static final String XMLNS_EDMX_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/06/edmx.
public static final String XMLNS_GENERICPLAYER_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData/GenericPlayer.
public static final String XMLNS_METADATA_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices/metadata.
public static final String XMLNS_SAP_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData.
Inherited members from IPersistable
Modifier and Type Member Description
public void read(BufferedReader)  
public void write(BufferedWriter)  
Inherited members from IODataSubscriptionEntry
Modifier and Type Member Description
public static final String ELEMENT_COLLECTION Name of the appropriate OData element.
public static final String ELEMENT_DELIVERYADDRESS Name of the appropriate OData element.
public static final String ELEMENT_FILTER Name of the appropriate OData element.
public static final String ELEMENT_SELECT Name of the appropriate OData element.
Inherited members from IODataEntry
Modifier and Type Member Description
public static final String ATTRIBUTE_SEMANTICS Name of the appropriate OData attribute.
public static final String ATTRIBUTE_TERM Name of the appropriate OData attribute.
public static final String ATTRIBUTE_VALUE_SEMANTICS_ACTION Value option for appropriate OData attribute.
public static final String ELEMENT_AUTHOR Name of the appropriate OData element.
public static final String ELEMENT_CATEGORY Name of the appropriate OData element.
public static final String ELEMENT_CONTENT Name of the appropriate OData element.
public static final String ELEMENT_ENTRY Name of the appropriate OData element.
public static final String ELEMENT_LINK Name of the appropriate OData element.
public static final String ELEMENT_NAME Name of the appropriate OData element.
public static final String ELEMENT_PROPERTIES Name of the appropriate OData element.
public static final String ELEMENT_SUMMARY Name of the appropriate OData element.
public static final String ELEMENT_TITLE Name of the appropriate OData element.
public static final String ELEMENT_UPDATED Name of the appropriate OData element.
public abstract List< IODataLink > getActionLinks() Returns OData Link objects that are set as action links (Has semantics (SAP name-space) attribute with value 'action')
public abstract String getAuthorName() Returns The value of the 'name' OData element of the 'author' OData element.
public cacheState getCachestate()  
public Long getCacheTimestamp()  
public abstract String getCollectionId() Returns the Id of the OCata Collection that this Entry belongs to.
public abstract String getContentType() Returns the content type of the entry.
public abstract String getEtag() Returns the Id of the OData Collection that this Entry belongs to.
public abstract String getFilterUrl() Returns the full execution URL hat can be used for filtering collection search for this single entry.
public abstract 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 abstract 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 abstract 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 abstract List< IODataIcon > getIcons() Returns the list of the appropriate OData elements.
public abstract String getId() Returns The Id of this OData Entry (value of appropriate OData Id element)
public boolean getIsLocal()  
public abstract Map< String, String > getKeyPropertyValues() Returns the values of the properties that are marked as key properties in the OData Schema document.
public abstract Date getLastUpdated() Returns The parsed value of the 'updated' OData Element.
public abstract List< IODataLink > getLinks() Returns the list of the appropriate OData elements.
public abstract String getMediaSrc() Returns the media source if the entry has a media content.
public abstract List< IODataProperty > getPropertiesData() Returns the value and meta information (retrieved from OData Schema document) of the properties of this Odata Entry document.
public abstract 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 abstract 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 abstract 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 abstract String getPropertyValue(String...) Returns the value of the appropriate property.
public abstract< T > T getPropertyValueParsed(String...) Returns the value of the appropriate property parsed to it's real type.
public abstract 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 abstract List< String > getPropertyValues(List< String[]>) Return list of property values for the given property paths.
public abstract List< IODataLink > getRelatedDataLinks() Returns OData Link objects that represents links to Related Data.
public abstract 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 abstract IODataSchema getSchema() Returns the appropriate OData Schema object.
public abstract IODataLink getSelfLink() Returns OData Link object that should be used for self related operations (with 'rel' attribute value 'self' or 'edit')
public abstract IODataLink getSubscriptionLink() Returns OData Link object that should be used for subscription or null if there is no subscription link defined.
public abstract String getSummary() Returns The value of the appropriate OData element.
public abstract String getTitle() Returns The value of the appropriate OData element.
public static final String PROPERTY_LEVEL_SEPARATOR  
public abstract void putComplexPropertyValue(String, String...) Puts the new property element as a sub-element of the 'complex properties' OData element.
public abstract void putContentType(String) Puts the content type for a new entry object.
public abstract void putId(String) Sets id of this OData Entry document (value of appropriate OData Id element)
public abstract void putMediaSrc(String) Puts the media source for a new entry object.
public abstract void putPropertyValue(String, String) Puts the new property element as a sub-element of the 'properties' OData element.
public abstract void putPropertyValue(String, String, boolean) Puts the new property element as a sub-element of the 'properties' OData element.
public abstract 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 abstract void setCollectionId(String) Maintains the Id of the OCata Collection that this Entry belongs to.
public void setIsLocal(boolean)  
public abstract void setSchema(IODataSchema) Maintains the reference to the appropriate OData Schema object.
public abstract void setSummary(String) Sets the value of the appropriate OData element.
public abstract void setTitle(String) Sets the value of the appropriate OData element.
Inherited members from IParserDocument
Modifier and Type Member Description
public static final String ATTRIBUTE_ETAG Name of the appropriate OData element.
public static final String ATTRIBUTE_VALUEPREFIX_EDMTYPE Value prefix for EDM Type type values.
public abstract IParserDocument clone() Creates a copy of this object.
public static Map< String, String > DEFAULT_PREFIXMAPPING The default XML Namespace-to-Prefix mapping used for building XMLS.
public static final String[] EDMDATETIME_PATTERNS Possible EDM DateTime patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String[] EDMDATETIMEOFFSET_PATTERNS Possible EDM TimeOffset patterns Note: Some pattern are not supported by OData specification but still widely used.
public static final String EDMTIME_PATTERN EDM Time pattern.
public static String ELEMENT_FEED Name of the appropriate OData element.
public static final String ELEMENT_ID Name of the appropriate OData element.
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 static final String ROOT_DOCUMENT_NAME The default root element name for a new document.
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.
public static final String XMLNS_APPLICATION_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_ATOM_URI Constant for XMLNS URI: http://www.w3.org/2005/Atom.
public static final String XMLNS_DATASERVICES_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_EDM_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/05/edm.
public static final String XMLNS_EDMX_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/06/edmx.
public static final String XMLNS_GENERICPLAYER_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData/GenericPlayer.
public static final String XMLNS_METADATA_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices/metadata.
public static final String XMLNS_SAP_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData.
Inherited members from IPersistable
Modifier and Type Member Description
public void read(BufferedReader)  
public void write(BufferedWriter)  
Parent topic: SAP Mobile Platform 3.0 OData SDK for Android