kotlin-odata/com.sap.cloud.mobile.kotlin.odata.csdl/CsdlParser

CsdlParser

Parser for Open Data Protocol (OData) service metadata documents (CSDL). A new parser should be created for each {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#parse(kotlin.String, kotlin.String) CsdlParser.parse} call. A parser should not be shared by multiple threads.

Constructors

CsdlParser

constructor()

Types

Companion

object Companion

Properties

csdlFetcher

var csdlFetcher: CsdlFetcher?

csdlOptions

var csdlOptions: Int

excludeServerOnly

var excludeServerOnly: Boolean

includeElements

var includeElements: XmlElementList

includeReferences

var includeReferences: XmlElementList

includeSchemas

var includeSchemas: DataSchemaList

internalOptions

var internalOptions: Int

logErrors

var logErrors: Boolean

logWarnings

var logWarnings: Boolean

serviceName

var serviceName: String?

traceRequests

var traceRequests: Boolean

Functions

includeNamespace

open fun includeNamespace(ns: String)

See includeNamespace(String, String?).

open fun includeNamespace(ns: String, alias: String?)

Add to {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeReferences CsdlParser.includeReferences} a supplementary CSDL edmx:Reference (with embedded edmx:Include). Call this function before {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#parse(kotlin.String, kotlin.String) CsdlParser.parse} if the document to be parsed is missing expected edmx:Reference elements for well-known schemas. This function generates an edmx:Reference with a fabricated "Uri" (with value "include/ns.xml"). It can be used together with a {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#csdlFetcher CsdlParser.csdlFetcher} which resolves documents either by fabricated location (include/ns.xml) or by namespace (ns).

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#csdlOptions CsdlParser.csdlOptions}, {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeReference(kotlin.String, kotlin.String, kotlin.String?) CsdlParser.includeReference}.

includeReference

open fun includeReference(uri: String, ns: String)

See includeReference(String, String, String?).

open fun includeReference(uri: String, ns: String, alias: String?)

Add to {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeReferences CsdlParser.includeReferences} a supplementary CSDL edmx:Reference (with embedded edmx:Include). Call this function before {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#parse(kotlin.String, kotlin.String) CsdlParser.parse} if the document to be parsed is missing expected edmx:Reference elements for well-known schemas. This function generates an edmx:Reference with a caller-specified "Uri". It can be used together with a {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#csdlFetcher CsdlParser.csdlFetcher} which resolves documents either by caller-specified location (uri) or by namespace (ns).

See Also:: {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#csdlOptions CsdlParser.csdlOptions}, {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeNamespace(kotlin.String, kotlin.String?) CsdlParser.includeNamespace}.

includeSchema

open fun includeSchema(schema: DataSchema)

Include the definitions of a pre-parsed schema into the document to be parsed. Call this function before {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#parse(kotlin.String, kotlin.String) CsdlParser.parse} if the document to be parsed has an edmx:Reference element for a well-known schema, and the pre-parsed schema should be used rather than loading the referenced schema over the network.

mergeAnnotationsFrom

open fun mergeAnnotationsFrom(text: String, file: String)

See mergeAnnotationsFrom(String, String, StringSet).

open fun mergeAnnotationsFrom(text: String, file: String, tags: StringSet)

Merge into {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeReferences CsdlParser.includeReferences} and {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeElements CsdlParser.includeElements} any extra annotation elements that are found in text.

mergeDefinitionsFrom

open fun mergeDefinitionsFrom(text: String, file: String)

See mergeDefinitionsFrom(String, String, StringSet).

open fun mergeDefinitionsFrom(text: String, file: String, tags: StringSet)

mergeReferencesFrom

open fun mergeReferencesFrom(text: String, file: String)

Merge into {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeReferences CsdlParser.includeReferences} any extra Reference elements that are found in text.

mergeSchemasFrom

open fun mergeSchemasFrom(text: String, file: String)

Merge into {@link com.sap.cloud.mobile.kotlin.odata.csdl.CsdlParser#includeElements CsdlParser.includeElements} any extra Schema elements that are found in text.

parse

open fun parse(text: String, url: String): CsdlDocument

Parse the text of an Open Data Protocol (OData) service metadata (CSDL) document. Supports OData versions 1.0 to 4.0.

parseInProxy

open fun parseInProxy(text: String, url: String): CsdlDocument

For internal use only.

parseNoExcept

open fun parseNoExcept(text: String, url: String): CsdlDocument

For internal use only.