com.sap.client.odata.v4.csdl

Class CsdlParser

java.lang.Object

com.sap.client.odata.v4.csdl.CsdlParser

public class CsdlParser
extends java.lang.Object

Parser for Open Data Protocol (OData) service metadata documents (CSDL).

Constructor Summary

Constructors

Constructor and Description
CsdlParser()

Method Summary

Modifier and Type	Method and Description
CsdlFetcher	getCsdlFetcher() (nullable) A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata.
int	getCsdlOptions() A bitmask of CSDL parser options.
XmlElementList	getIncludeReferences() Supplementary edmx:Reference elements.
DataSchemaList	getIncludeSchemas() Pre-parsed schemas.
boolean	getLogErrors() Should parser errors be logged before they are thrown?
boolean	getLogWarnings() Should parser warnings be logged?
java.lang.String	getServiceName() (nullable) Data service name.
boolean	getTraceRequests() Should parsing requests be traced?
void	includeNamespace(java.lang.String ns) See includeNamespace(String, String).
void	includeNamespace(java.lang.String ns, java.lang.String alias) Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include).
void	includeReference(java.lang.String uri, java.lang.String ns) See includeReference(String, String, String).
void	includeReference(java.lang.String uri, java.lang.String ns, java.lang.String alias) Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include).
void	includeSchema(DataSchema schema) Include the definitions of a pre-parsed schema into the document to be parsed.
CsdlDocument	parse(java.lang.String text, java.lang.String url) Parse the text of an Open Data Protocol (OData) service metadata (CSDL) document.
CsdlDocument	parseInProxy(java.lang.String text, java.lang.String url) For internal use only.
static java.lang.String	resolveToLocalSAPVocabulary(java.lang.String ns) For internal use only.
void	setCsdlFetcher(CsdlFetcher value) A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata.
void	setCsdlOptions(int value) A bitmask of CSDL parser options.
void	setIncludeReferences(XmlElementList value) Supplementary edmx:Reference elements.
void	setIncludeSchemas(DataSchemaList value) Pre-parsed schemas.
void	setLogErrors(boolean value) Should parser errors be logged before they are thrown?
void	setLogWarnings(boolean value) Should parser warnings be logged?
void	setServiceName(java.lang.String value) Data service name.
void	setTraceRequests(boolean value) Should parsing requests be traced?

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CsdlParser

public CsdlParser()

Method Detail

getCsdlFetcher

public CsdlFetcher getCsdlFetcher()

(nullable) A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata. Must be set before CsdlParser.parse is called, or else any CSDL Reference that is encountered during parsing will result in a CsdlException being thrown.

getCsdlOptions

public int getCsdlOptions()

A bitmask of CSDL parser options.

See Also:

CsdlOption.

getIncludeReferences

public XmlElementList getIncludeReferences()

Supplementary edmx:Reference elements. Defaults to an empty list.

See Also:

CsdlParser.includeNamespace, CsdlParser.includeReference.

getIncludeSchemas

public DataSchemaList getIncludeSchemas()

Pre-parsed schemas. Defaults to an empty list.

See Also:

CsdlParser.includeSchema.

getLogErrors

public boolean getLogErrors()

Should parser errors be logged before they are thrown?

getLogWarnings

public boolean getLogWarnings()

Should parser warnings be logged?

getServiceName

public java.lang.String getServiceName()

(nullable) Data service name. If data metrics are required, this property should be set before CsdlParser.parse is called, so that all DataMethod and EntitySet in the parsed document will have appropriately named metrics.

getTraceRequests

public boolean getTraceRequests()

Should parsing requests be traced?

includeNamespace

public void includeNamespace(java.lang.String ns)

See includeNamespace(String, String).

includeNamespace

public void includeNamespace(java.lang.String ns,
                             java.lang.String alias)

Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include). Call this function before 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 CsdlParser.csdlFetcher which resolves documents either by fabricated location (include/ns.xml) or by namespace (ns).

See Also:

CsdlParser.csdlOptions, CsdlParser.includeReference.

Parameters:

ns - For the "Namespace" attribute of "edmx:Include".

alias - (nullable) For the "Alias" attribute of "edmx:Include".

includeReference

public void includeReference(java.lang.String uri,
                             java.lang.String ns)

See includeReference(String, String, String).

includeReference

public void includeReference(java.lang.String uri,
                             java.lang.String ns,
                             java.lang.String alias)

Add to CsdlParser.includeReferences a supplementary CSDL edmx:Reference (with embedded edmx:Include). Call this function before 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 CsdlParser.csdlFetcher which resolves documents either by caller-specified location (uri) or by namespace (ns).

See Also:

CsdlParser.csdlOptions, CsdlParser.includeNamespace.

Parameters:

uri - For the "Uri" attribute of "edmx:Reference".

ns - For the "Namespace" attribute of "edmx:Include".

alias - (nullable) For the "Alias" attribute of "edmx:Include".

includeSchema

public void includeSchema(DataSchema schema)

Include the definitions of a pre-parsed schema into the document to be parsed. Call this function before 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.

Parameters:

schema - Pre-parsed schema.

parse

public CsdlDocument parse(java.lang.String text,
                          java.lang.String url)

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

Parameters:

text - Text of the service metadata document.

url - URL of the service metadata document. Used for resolving relative URLs if any CSDL Reference is encountered during parsing. May also be included in exception messages.

Returns:

Parsed CSDL document.

parseInProxy

public CsdlDocument parseInProxy(java.lang.String text,
                                 java.lang.String url)

For internal use only.

resolveToLocalSAPVocabulary

public static java.lang.String resolveToLocalSAPVocabulary(java.lang.String ns)

For internal use only.

setCsdlFetcher

public void setCsdlFetcher(CsdlFetcher value)

A callback which will be used to resolve any CSDL Reference that is encountered during parsing, in order to fetch the referenced metadata. Must be set before CsdlParser.parse is called, or else any CSDL Reference that is encountered during parsing will result in a CsdlException being thrown.

setCsdlOptions

public void setCsdlOptions(int value)

A bitmask of CSDL parser options.

See Also:

CsdlOption.

setIncludeReferences

public void setIncludeReferences(XmlElementList value)

Supplementary edmx:Reference elements. Defaults to an empty list.

See Also:

CsdlParser.includeNamespace, CsdlParser.includeReference.

setIncludeSchemas

public void setIncludeSchemas(DataSchemaList value)

Pre-parsed schemas. Defaults to an empty list.

See Also:

CsdlParser.includeSchema.

setLogErrors

public void setLogErrors(boolean value)

Should parser errors be logged before they are thrown?

setLogWarnings

public void setLogWarnings(boolean value)

Should parser warnings be logged?

setServiceName

public void setServiceName(java.lang.String value)

Data service name. If data metrics are required, this property should be set before CsdlParser.parse is called, so that all DataMethod and EntitySet in the parsed document will have appropriately named metrics.

setTraceRequests

public void setTraceRequests(boolean value)

Should parsing requests be traced?