ISDMParserDocument interface

Deprecated. since 3.0, Use IParserDocument Represents a general XML-compatible, persistable object.

Package

com.sap.mobile.lib.sdmparser

Syntax

public abstract interface ISDMParserDocument extends ISDMPersistable, 

Implemented interfaces

Derived classes

Derived interfaces

Members

All members of ISDMParserDocument, including inherited members.

Variables
Modifier and Type Variable Description
public static final String ROOT_DOCUMENT_NAME The default root element name for a new document.
public static Map< String, String > DEFAULT_PREFIXMAPPING The default XML Namespace-to-Prefix mapping used for building XMLS.
public static String ELEMENT_FEED Name of the appropriate SDMOData element.
public static final String ELEMENT_ID Name of the appropriate SDMOData element.
public static final String ATTRIBUTE_ETAG Name of the appropriate SDMOData element.
public static final String XMLNS_ATOM_URI Constant for XMLNS URI: http://www.w3.org/2005/Atom.
public static final String XMLNS_GENERICPLAYER_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData/GenericPlayer.
public static final String XMLNS_SAP_URI Constant for XMLNS URI: http://www.sap.com/Protocols/SAPData.
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_METADATA_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices/metadata.
public static final String XMLNS_DATASERVICES_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String XMLNS_APPLICATION_URI Constant for XMLNS URI: http://schemas.microsoft.com/ado/2007/08/dataservices.
public static final String ATTRIBUTE_VALUEPREFIX_EDMTYPE Value prefix for EDM Type type values.
public static final String EDMTIME_PATTERN EDM Time pattern.
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.
Methods
Modifier and Type Method Description
public abstract ISDMParserDocument 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< ISDMParserDocument > getChildDocuments(String...) Returns the elements contained by the element with the given route.
public abstract List< ISDMParserDocument > 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< ISDMParserDocument > 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 ISDMParserDocument getDocument(String...) Returns the first element with the given route.
public abstract List< ISDMParserDocument > getDocuments(String...) Returns all the elements with the given route.
public abstract List< ISDMParserDocument > getDocumentsWithAttribute(String, String, String...) Returns the elements with the given route that contains the given attribute with the given value.
public abstract List< ISDMParserDocument > getDocumentsWithAttribute(String, String, boolean, String...) Returns the elements with the given route that contains the given attribute with the given value.
public abstract ISDMParserDocument getDocumentWithAttribute(String, String, String...) Returns the first element with the given route that contains the given attribute with the given value.
public abstract ISDMParserDocument 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(ISDMParserDocument, 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< ISDMParserDocument >, 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 ISDMPersistable
Modifier and Type Member Description
public void read(BufferedReader)  
public void write(BufferedWriter)  

Usage

XML like elements, values and attributes can be access via routes Routes are list of element names where each element contains the next element in the list

Elements can be retrieved as a new ISDMParserDocument containing all the attributes, values and child elements of the represented element.

Empty routes always refer to the given object the method invoked on