IODataSchema interface

Represents the OData Service Document.

Syntax

public abstract interface IODataSchema extends IParserDocument

Derived classes

Members

All members of IODataSchema, including inherited members.

Variables
Modifier and Type Variable Description
public static final String ACTION_FOR name of the appropriate Odata attribute
public static final String ATTRIBUTE_ENTITYSET Name of the appropriate OData attribute.
public static final String ATTRIBUTE_ENTITYTYPE Name of the appropriate OData attribute.
public static final String ATTRIBUTE_NAME Name of the appropriate OData attribute.
public static final String ATTRIBUTE_NAMESPACE Name of the appropriate OData attribute.
public static final String ELEMENT_COMPLEXTYPE Name of the appropriate OData element.
public static final String ELEMENT_DATASERVICES Name of the appropriate OData element.
public static final String ELEMENT_EDMX Name of the appropriate OData element.
public static final String ELEMENT_ENTITYCONTAINER Name of the appropriate OData element.
public static final String ELEMENT_ENTITYSET Name of the appropriate OData element.
public static final String ELEMENT_ENTITYTYPE Name of the appropriate OData element.
public static final String ELEMENT_FUNCTIONALIMPORT Name of the appropriate OData element.
public static final String ELEMENT_SCHEMA Name of the appropriate OData element.
Methods
Modifier and Type Method Description
public abstract IODataAssociation getAssociation(String) Returns the appropriate OData Association element with the given relationship attribute.
public abstract List< IODataAssociation > getAssociations() Returns the list of the appropriate OData elements.
public abstract IODataAssociationSet getAssociationSet(String) Returns the appropriate AssociationSet with for given association.
public abstract List< IODataAssociationSet > getAssociationSets() Returns the list of the appropriate OData elements.
public abstract IODataComplexType getComplexType(String) Returns The 'ComplexType' OData element associated with the reference.
public abstract List< IODataComplexType > getComplexTypes() Returns The list of the appropriate OData element.
public abstract IODataEntitySet getEntitySet(String) Returns The appropriate OData EntitySet.
public abstract IODataEntityType getEntityType(String) Returns The 'EntityType' OData element associated with the reference argument.
public abstract IODataEntityType getEntityTypeForCollection(String) Returns the 'EntityType' OData element contained by the 'EntitySet' element that is associated with the collectionId matching.
public abstract List< IODataFunctionImport > getFunctionImports() Returns The list of the 'FunctionImport' OData element.
public abstract List< IODataFunctionImport > getFunctionImportsForCollection(String) Returns List of FunctionImports valid for the appropriate collection.
public abstract IODataServiceDocument getServiceDocument() Returns the appropriate OData Service Document.
public abstract String getTargetCollectionIdForNavigationProperty(String, String) Resolves the target collection Id of the given OData Navigation Property element.
public abstract void setServiceDocument(IODataServiceDocument) Maintains reference to the appropriate OData Service Document.
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