ODataURL class

Consists of APIs related to OData URL.

Package

com.sap.mobile.lib.parser

Syntax

public class ODataURL extends ParserDocument implements IODataURL

Implemented interfaces

Members

All members of ODataURL, including inherited members.

Variables
Modifier and Type Variable Description
protected String baseUrl  
Constructors
Modifier and Type Constructor Description
public ODataURL()  
protected ODataURL(int[], String[])  
public ODataURL(ParserDocument)  
Methods
Modifier and Type Method Description
public List< String > getMandatoryTemplateParameters() Returns the list of mandatory template parameter names.
protected List< String > getMandatoryTemplateParameters(String)  
public List< String > getOptionalTemplateParameters() Returns the list of optional template parameter names.
protected List< String > getOptionalTemplateParameters(String)  
public String getTemplate() Returns the value of the appropriate OData attribute.
public List< String > getTemplateParameters() Returns the list of all template parameter names.
public String getType() Returns the value of the appropriate OData attribute.
public String getUrl() Returns the full URL of this OData attribute without parameters.
public String getUrlFromTemplate(Map< String, String >) Returns the full URL of this OData attribute extended with parameter names and values according to the given parameter map.
public void read(BufferedReader)  
protected void setBaseUrl(String)  
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)  
Parent topic: parser package