Package com.sap.olingo.jpa.metadata.core.edm.mapper.extention

Interface IntermediateReferenceList

public interface IntermediateReferenceList

A IntermediateReferenceList collects all references to external CSDL documents. The document must be an XML document.
See also: Common Schema Definition Language (CSDL) 3.3 Element edmx:Reference

Author:

Oliver Grande

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IntermediateReferenceList.IntermediateReferenceAccess

Method Summary

Modifier and Type	Method	Description
IntermediateReferenceList.IntermediateReferenceAccess	addReference(String uri)	Loads a referenced external CSDL document from the provided uri.
IntermediateReferenceList.IntermediateReferenceAccess	addReference(String uri, String path)	Loads a referenced external CSDL document from the file system.
IntermediateReferenceList.IntermediateReferenceAccess	addReference(String uri, String path, Charset charset)	Loads a referenced external CSDL document from the file system.

Method Details

addReference

IntermediateReferenceList.IntermediateReferenceAccess addReference(@Nonnull
 String uri)
                                                            throws ODataJPAModelException

Loads a referenced external CSDL document from the provided uri. The document has to be a XML document.
The method is mainly for prototyping and testing, move of content as it is usually not wanted in productive code that the used content changes during runtime or on a restart.

Parameters:

uri - A uniquely identifier of a referenced document, so two references MUST NOT specify the same URI. E.g. "http://docs.oasis-open.org/odata/odata/v4.0/os/vocabularies/Org.OData.Core.V1.xml"

Returns:

Throws:

ODataJPAModelException

addReference

IntermediateReferenceList.IntermediateReferenceAccess addReference(@Nonnull
 String uri,
 @Nonnull
 String path)
                                                            throws ODataJPAModelException

Loads a referenced external CSDL document from the file system. The document has to be a XML document. The document is loaded assuming it has been stored using the system default character set.

Parameters:

uri - A uniquely identifier of a referenced document, so two references MUST NOT specify the same URI.

path - Path to the CSDL document

Returns:

Throws:

ODataJPAModelException

addReference

IntermediateReferenceList.IntermediateReferenceAccess addReference(@Nonnull
 String uri,
 @Nonnull
 String path,
 @Nonnull
 Charset charset)
                                                            throws ODataJPAModelException

Loads a referenced external CSDL document from the file system. The document has to be a XML document.

Parameters:

uri - A uniquely identifier of a referenced document, so two references MUST NOT specify the same URI.

path - Path to the CSDL document

charset - Character set to be used when loading the document.

Returns:

Throws:

ODataJPAModelException