com.sap.cloud.server.odata.csdl

Class CsdlDocument

java.lang.Object

com.sap.cloud.server.odata.csdl.CsdlDocument

public class CsdlDocument
extends java.lang.Object

Encapsulates the definitions from a parsed Open Data Protocol (OData) service metadata (CSDL) document.

See Also:

CsdlParser.

Field Summary

Fields

Modifier and Type	Field and Description
static StringMap	builtinVocabularyNamespaces

Constructor Summary

Constructors

Constructor and Description
CsdlDocument()

Method Summary

Modifier and Type	Method and Description
void	addCacheHandling() Add internal metadata to support cache databases.
void	addDeltaHandling() Add internal metadata to support change tracking.
void	addOwner(java.lang.Object owner) Register owner as an owner of this metadata document.
void	addRepeatability() Add internal metadata to support repeatable requests.
void	addVocabularyReference(java.lang.String ns) See addVocabularyReference(String, String, String).
void	addVocabularyReference(java.lang.String ns, java.lang.String uri) See addVocabularyReference(String, String, String).
void	addVocabularyReference(java.lang.String ns, java.lang.String uri, java.lang.String alias) Add a well-known vocabulary reference to this metadata.
void	applyAnnotations() Apply any Security or SQL annotations (from OData namespaces "com.sap.cloud.server.odata.*") to this metadata.
static java.lang.String	excludingAlias(java.lang.String alias, java.lang.String text) Return the metadata text, excluding any references or annotations using the specified alias.
static XmlDocument	excludingServerOnly(java.lang.String alias, XmlDocument xml) Return the metadata xml, excluding server-only elements.
AnnotationTermMap	getAnnotationTerms() Return map of annotation terms defined by the CSDL.
DataTypeMap	getBuiltinTypes() Return map of predefined CSDL data types.
boolean	getCanChangeAnything() Return allows any model element to be changed in the latest service metadata before calling DataService.refreshMetadata.
boolean	getCanRemoveAnything() Return allows any model element to be removed in the latest service metadata before calling DataService.refreshMetadata.
ComplexType	getComplexType(java.lang.String name) Lookup a complex type by qualified name.
ComplexTypeMap	getComplexTypes() Return map of complex types defined by the CSDL.
EntitySetMap	getDatabaseTables() Return entity sets that are mapped to database tables.
DataMethod	getDataMethod(java.lang.String name) Lookup a data method by qualified name (for function/action definitions) or by unqualified name (for function/action imports).
DataMethodMap	getDataMethods() Return map of data methods (actions, functions) defined by the CSDL.
DataSchema	getDataSchema(java.lang.String name) Lookup a data schema by name.
DataSchemaMap	getDataSchemas() Return map of data schemas defined by the CSDL.
EntityContainer	getDefaultContainer() Return (nullable) Default entity container defined by the CSDL (or null if there are no containers defined).
EntityContainerMap	getEntityContainers() Return map of entity containers defined by the CSDL.
EntitySet	getEntitySet(java.lang.String name) Lookup an entity set (or singleton entity) by name.
EntitySetMap	getEntitySets() Return map of entity sets defined by the CSDL.
EntityType	getEntityType(java.lang.String name) Lookup an entity type by qualified name.
EntityTypeMap	getEntityTypes() Return map of entity types defined by the CSDL.
EnumType	getEnumType(java.lang.String name) Lookup an enum type by qualified name.
EnumTypeMap	getEnumTypes() Return map of enum types defined by the CSDL.
DataMethodMap	getLookupMethods() For internal use only.
EntitySetMap	getLookupSets() For internal use only.
EntitySetMap	getLookupSingletons() For internal use only.
DataSchema	getMainSchema() Return (nullable) Main data schema defined by the CSDL (or null if there are no schemas defined).
java.lang.String	getOriginalText() Return (nullable) Original CSDL (XML) text.
ObjectList	getOwners() Return all the current registered owners of this metadata document.
PathAnnotationsMap	getPathAnnotations() Return map of path annotations defined by the CSDL (where the TargetPath does not directly reference a model element).
java.lang.String	getProxyVersion() Return (nullable) If this metadata was parsed by generated proxy classes, then the framework version that generated the proxies.
java.lang.String	getResolvedText() Return (nullable) Resolved CSDL (XML) text, with inline references and expanded aliases.
SimpleType	getSimpleType(java.lang.String name) Lookup a simple type by qualified name.
SimpleTypeMap	getSimpleTypes() Return map of simple types defined by the CSDL.
EntitySet	getSingleton(java.lang.String name) Lookup a singleton entity by name.
EntitySetMap	getSingletons() Return map of singletons defined by the CSDL.
java.lang.String	getSourceFile() Return (nullable) Source file name if known, otherwise null.
StringMap	getTopAliases() Return top-level aliases defined by the CSDL.
CsdlReferenceList	getTopReferences() Return top-level references defined by the CSDL.
DataSchemaList	getTopSchemas() Return top-level schemas defined by the CSDL.
int	getVersionCode() Return code for the OData version, e.g.
java.lang.String	getVersionText() Return text for the OData version, e.g.
StringMap	getXmlNamespaces() Return map of XML namespaces defined by the CSDL.
boolean	hasGeneratedProxies() Return true if this metadata is associated with generated proxy classes.
boolean	hasOpenEnumerations() Return allows addition of enumeration members in the latest service metadata before calling DataService.refreshMetadata.
boolean	hasTopReference(java.lang.String ns) Return true if this document includes a top-level reference for CSDL namespace ns.
boolean	hasTopSchema(java.lang.String ns) Return true if this document includes a top-level schema for CSDL namespace ns.
void	inheritAnnotations() Inherit annotations from entity types to entity sets in this metadata.
void	removeOwner(java.lang.Object owner) Unregister owner as an owner of this metadata document.
void	removeReferences(java.lang.String alias) Remove from CsdlDocument.originalText any references or annotations using the specified alias.
void	removeServerOnly(java.lang.String vocabularyAlias) Remove from CsdlDocument.originalText any elements which have a child ServerOnly Annotation element.
void	resolveEntity(EntityValue entity) Resolve the EntityValue.entitySet of `entity' (if it is not already set).
void	setCanChangeAnything(boolean value) Set allows any model element to be changed in the latest service metadata before calling DataService.refreshMetadata.
void	setCanRemoveAnything(boolean value) Set allows any model element to be removed in the latest service metadata before calling DataService.refreshMetadata.
void	setDefaultContainer(EntityContainer value) Set default entity container defined by the CSDL (or null if there are no containers defined).
void	setGeneratedProxies(boolean value) Set true if this metadata is associated with generated proxy classes.
void	setJoinSetRelations() Set the JoinSetRelations object to all navigation properties which has "JoinUsing" annotation.
void	setMainSchema(DataSchema value) Set main data schema defined by the CSDL (or null if there are no schemas defined).
void	setOpenEnumerations(boolean value) Set allows addition of enumeration members in the latest service metadata before calling DataService.refreshMetadata.
void	setOriginalText(java.lang.String value) Set original CSDL (XML) text.
void	setProxyVersion(java.lang.String value) Set if this metadata was parsed by generated proxy classes, then the framework version that generated the proxies.
void	setResolvedText(java.lang.String value) Set resolved CSDL (XML) text, with inline references and expanded aliases.
void	setSourceFile(java.lang.String value) Set source file name if known, otherwise null.
void	setVersionCode(int value) Set code for the OData version, e.g.
void	setVersionText(java.lang.String value) Set text for the OData version, e.g.

Methods inherited from class java.lang.Object

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

Field Detail

builtinVocabularyNamespaces

public static final StringMap builtinVocabularyNamespaces

Constructor Detail

CsdlDocument

public CsdlDocument()

Method Detail

addCacheHandling

public void addCacheHandling()

Add internal metadata to support cache databases.

addDeltaHandling

public void addDeltaHandling()

Add internal metadata to support change tracking.

addOwner

public void addOwner(java.lang.Object owner)

Register owner as an owner of this metadata document.

Parameters:

owner - Metadata owner.

addRepeatability

public void addRepeatability()

Add internal metadata to support repeatable requests.

addVocabularyReference

public void addVocabularyReference(java.lang.String ns)

See addVocabularyReference(String, String, String).

Parameters:

ns - Ns parameter.

addVocabularyReference

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

See addVocabularyReference(String, String, String).

Parameters:

ns - Ns parameter.

uri - Uri parameter.

addVocabularyReference

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

Add a well-known vocabulary reference to this metadata. If this metadata already has a reference to the well-known vocabulary, then no change is made. If the reference is to one of the CsdlDocument.builtinVocabularyNamespaces, then all defined annotation terms/types from the vocabulary will also be added to the current metadata.

See Also:

CsdlDocument.builtinVocabularyNamespaces.

Parameters:

ns - CSDL namespace.

uri - (nullable) Optional namespace URI. For builtin vocabulary namespaces, this can be derived from the namespace. For references to non-builtin vocabularies, it must be provided.

alias - (nullable) Optional namespace alias. For builtin vocabulary namespaces, this can be derived from the namespace. For references to non-builtin vocabularies, it can be provided.

applyAnnotations

public void applyAnnotations()

Apply any Security or SQL annotations (from OData namespaces "com.sap.cloud.server.odata.*") to this metadata.

excludingAlias

public static java.lang.String excludingAlias(java.lang.String alias,
                                              java.lang.String text)

Return the metadata text, excluding any references or annotations using the specified alias.

Parameters:

alias - Namespace/alias (or comma-separated list of namespaces/aliases).

text - Metadata text.

Returns:

The metadata text, excluding any references or annotations using the specified alias.

excludingServerOnly

public static XmlDocument excludingServerOnly(java.lang.String alias,
                                              XmlDocument xml)

Return the metadata xml, excluding server-only elements.

Parameters:

alias - (nullable) Optional alias for the vocabulary defining the ServerOnly annotation.

xml - Metadata XML.

Returns:

The metadata xml, excluding server-only elements.

getAnnotationTerms

public AnnotationTermMap getAnnotationTerms()

Return map of annotation terms defined by the CSDL.

Returns:

Map of annotation terms defined by the CSDL.

getBuiltinTypes

public DataTypeMap getBuiltinTypes()

Return map of predefined CSDL data types.

Returns:

Map of predefined CSDL data types.

getCanChangeAnything

public boolean getCanChangeAnything()

Return allows any model element to be changed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false. Warning: enabling this option can result in application instability (depending on the changes) if the application uses proxy classes!

Returns:

Allows any model element to be changed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false.

getCanRemoveAnything

public boolean getCanRemoveAnything()

Return allows any model element to be removed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false. Warning: enabling this option can result in application instability unless the application checks isRemoved flags on model elements!

Returns:

Allows any model element to be removed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false.

getComplexType

public ComplexType getComplexType(java.lang.String name)

Lookup a complex type by qualified name. If the complex type does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up simplet types before calling this method like in the following code snippet:

Example checking if a complex type exists:

 public void checkComplexTypeExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getComplexTypes()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models.EventLocation")) {
         Ignore.valueOf_any(csdlDocument.getComplexType("Microsoft.OData.Service.Sample.TrippinInMemory.Models.EventLocation"));
     } else {
     }
 }
 

See Also:

CsdlDocument.complexTypes, for looking up types that might not exist.

Parameters:

name - Name of the complex type to be returned.

Returns:

The complex type, which must exist.

getComplexTypes

public ComplexTypeMap getComplexTypes()

Return map of complex types defined by the CSDL.

Returns:

Map of complex types defined by the CSDL.

getDataMethod

public DataMethod getDataMethod(java.lang.String name)

Lookup a data method by qualified name (for function/action definitions) or by unqualified name (for function/action imports). If the data method does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up data methods before calling this method like in the following code snippet:

Example checking if a data method exists:

 public void checkDataMethodInCsdlDocumentExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getLookupMethods()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person.UpdatePersonLastName")) {
         Ignore.valueOf_any(csdlDocument.getDataMethod("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Person.UpdatePersonLastName"));
     } else {
     }
 }
 

See Also:

CsdlDocument.dataMethods, for looking up methods that might not exist.

Parameters:

name - Name of the data method to be returned.

Returns:

The data method, which must exist.

getDataMethods

public DataMethodMap getDataMethods()

Return map of data methods (actions, functions) defined by the CSDL.

Returns:

Map of data methods (actions, functions) defined by the CSDL.

getDataSchema

public DataSchema getDataSchema(java.lang.String name)

Lookup a data schema by name. If the data schema does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up data schemas before calling this method like in the following code snippet:

Example checking if a data schema exists:

 public void checkDataSchemaExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getDataSchemas()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models")) {
         Ignore.valueOf_any(csdlDocument.getDataSchema("Microsoft.OData.Service.Sample.TrippinInMemory.Models"));
     } else {
     }
 }
 

See Also:

CsdlDocument.dataSchemas, for looking up schemas that might not exist.

Parameters:

name - Name of the data schema to be returned.

Returns:

The data schema, which must exist.

getDataSchemas

public DataSchemaMap getDataSchemas()

Return map of data schemas defined by the CSDL.

Returns:

Map of data schemas defined by the CSDL.

getDatabaseTables

public EntitySetMap getDatabaseTables()

Return entity sets that are mapped to database tables.

Returns:

Entity sets that are mapped to database tables.

getDefaultContainer

public EntityContainer getDefaultContainer()

Return (nullable) Default entity container defined by the CSDL (or null if there are no containers defined).

Returns:

(nullable) Default entity container defined by the CSDL (or null if there are no containers defined).

getEntityContainers

public EntityContainerMap getEntityContainers()

Return map of entity containers defined by the CSDL.

Returns:

Map of entity containers defined by the CSDL.

getEntitySet

public EntitySet getEntitySet(java.lang.String name)

Lookup an entity set (or singleton entity) by name. If the entity set does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up simplet types before calling this method like in the following code snippet: Note that OData singleton entities are represented by entity sets where EntitySet.isSingleton is true.

Example checking if a entity set exists:

 public void checkEntitySetInCsdlDocumentExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getEntitySets()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airlines")) {
         Ignore.valueOf_any(csdlDocument.getEntitySet("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airlines"));
     } else {
     }
 }
 

See Also:

CsdlDocument.entitySets, for looking up sets that might not exist.

Parameters:

name - Name of the entity set to be returned.

Returns:

The entity set, which must exist.

getEntitySets

public EntitySetMap getEntitySets()

Return map of entity sets defined by the CSDL.

Returns:

Map of entity sets defined by the CSDL.

getEntityType

public EntityType getEntityType(java.lang.String name)

Lookup an entity type by qualified name. If the entity type does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up simplet types before calling this method like in the following code snippet:

Example checking if a entity type exists:

 public void checkEntityTypeExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getEntityTypes()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport")) {
         Ignore.valueOf_any(csdlDocument.getEntityType("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Airport"));
     } else {
     }
 }
 

See Also:

CsdlDocument.entityTypes, for looking up types that might not exist.

Parameters:

name - Name of the entity type to be returned.

Returns:

The entity type, which must exist.

getEntityTypes

public EntityTypeMap getEntityTypes()

Return map of entity types defined by the CSDL.

Returns:

Map of entity types defined by the CSDL.

getEnumType

public EnumType getEnumType(java.lang.String name)

Lookup an enum type by qualified name. If the enum type does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up simplet types before calling this method like in the following code snippet:

Example checking if an enum type exists:

 public void checkEnumTypeExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getEnumTypes()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender")) {
         Ignore.valueOf_any(csdlDocument.getEnumType("Microsoft.OData.Service.Sample.TrippinInMemory.Models.PersonGender"));
     } else {
     }
 }
 

See Also:

CsdlDocument.enumTypes, for looking up types that might not exist.

Parameters:

name - Name of the enum type to be returned.

Returns:

The enum type, which must exist.

getEnumTypes

public EnumTypeMap getEnumTypes()

Return map of enum types defined by the CSDL.

Returns:

Map of enum types defined by the CSDL.

getLookupMethods

public DataMethodMap getLookupMethods()

For internal use only.

Returns:

(internal use only)

getLookupSets

public EntitySetMap getLookupSets()

For internal use only.

Returns:

(internal use only)

getLookupSingletons

public EntitySetMap getLookupSingletons()

For internal use only.

Returns:

(internal use only)

getMainSchema

public DataSchema getMainSchema()

Return (nullable) Main data schema defined by the CSDL (or null if there are no schemas defined).

Returns:

(nullable) Main data schema defined by the CSDL (or null if there are no schemas defined).

getOriginalText

public java.lang.String getOriginalText()

Return (nullable) Original CSDL (XML) text.

See Also:

CsdlOption.RETAIN_ORIGINAL_TEXT.

Returns:

(nullable) Original CSDL (XML) text.

getOwners

public ObjectList getOwners()

Return all the current registered owners of this metadata document.

Returns:

all the current registered owners of this metadata document.

getPathAnnotations

public PathAnnotationsMap getPathAnnotations()

Return map of path annotations defined by the CSDL (where the TargetPath does not directly reference a model element).

Returns:

Map of path annotations defined by the CSDL (where the TargetPath does not directly reference a model element).

getProxyVersion

public java.lang.String getProxyVersion()

Return (nullable) If this metadata was parsed by generated proxy classes, then the framework version that generated the proxies. Otherwise null.

Returns:

(nullable) If this metadata was parsed by generated proxy classes, then the framework version that generated the proxies. Otherwise null.

getResolvedText

public java.lang.String getResolvedText()

Return (nullable) Resolved CSDL (XML) text, with inline references and expanded aliases.

See Also:

CsdlOption.RETAIN_RESOLVED_TEXT.

Returns:

(nullable) Resolved CSDL (XML) text, with inline references and expanded aliases.

getSimpleType

public SimpleType getSimpleType(java.lang.String name)

Lookup a simple type by qualified name. If the simple type does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up simplet types before calling this method like in the following code snippet:

Example checking if a simple type exists:

 public void checkSimpleTypeExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getSimpleTypes()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models.MySimpleType")) {
         Ignore.valueOf_any(csdlDocument.getSimpleType("Microsoft.OData.Service.Sample.TrippinInMemory.Models.MySimpleType"));
     } else {
     }
 }
 

See Also:

CsdlDocument.simpleTypes, for looking up types that might not exist.

Parameters:

name - Name of the simple type to be returned.

Returns:

The simple type, which must exist.

getSimpleTypes

public SimpleTypeMap getSimpleTypes()

Return map of simple types defined by the CSDL.

Returns:

Map of simple types defined by the CSDL.

getSingleton

public EntitySet getSingleton(java.lang.String name)

Lookup a singleton entity by name. If the singleton entity does not exist it indicates a fundamental implementation problem, therefore a non-catchable FatalException will be thrown, and the app intentionally crashes. The reason behind this drastic behaviour is to avoid mismatch between server and client. It is still possible to avoid the FatalException by looking up simplet types before calling this method like in the following code snippet: Note that OData singleton entities are represented by entity sets where EntitySet.isSingleton is true.

Example checking if a ingleton entity exists:

 public void checkSingletonExistsExample() {
     com.sap.cloud.server.odata.csdl.CsdlDocument csdlDocument = this.getService()
         .getMetadata();
     if (csdlDocument.getSingletons()
         .has("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Container/Me")) {
         Ignore.valueOf_any(csdlDocument.getSingleton("Microsoft.OData.Service.Sample.TrippinInMemory.Models.Container/Me"));
     } else {
     }
 }
 

See Also:

CsdlDocument.entitySets, for looking up sets that might not exist.

Parameters:

name - Name of the entity set to be returned.

Returns:

The entity set, which must exist.

getSingletons

public EntitySetMap getSingletons()

Return map of singletons defined by the CSDL. Each singleton is represented by an EntitySet with isSingleton == true

Returns:

Map of singletons defined by the CSDL.

getSourceFile

public java.lang.String getSourceFile()

Return (nullable) Source file name if known, otherwise null.

Returns:

(nullable) Source file name if known, otherwise null.

getTopAliases

public StringMap getTopAliases()

Return top-level aliases defined by the CSDL. This is a map from schema namespace to schema alias.

Returns:

Top-level aliases defined by the CSDL.

getTopReferences

public CsdlReferenceList getTopReferences()

Return top-level references defined by the CSDL.

Returns:

Top-level references defined by the CSDL.

getTopSchemas

public DataSchemaList getTopSchemas()

Return top-level schemas defined by the CSDL.

Returns:

Top-level schemas defined by the CSDL.

getVersionCode

public int getVersionCode()

Return code for the OData version, e.g. 400. If the OData version is considered as a decimal number (e.g. 4.0), then multiplying by 100 will give the code (e.g. 400).

See Also:

DataVersion.

Returns:

Code for the OData version, e.g. 400.

getVersionText

public java.lang.String getVersionText()

Return text for the OData version, e.g. "4.0".

Returns:

Text for the OData version, e.g. "4.0".

getXmlNamespaces

public StringMap getXmlNamespaces()

Return map of XML namespaces defined by the CSDL.

Returns:

Map of XML namespaces defined by the CSDL.

hasGeneratedProxies

public boolean hasGeneratedProxies()

Return true if this metadata is associated with generated proxy classes. Defaults to false (generated proxies will override to true).

Returns:

true if this metadata is associated with generated proxy classes. Defaults to false (generated proxies will override to true).

hasOpenEnumerations

public boolean hasOpenEnumerations()

Return allows addition of enumeration members in the latest service metadata before calling DataService.refreshMetadata. Defaults to false. Warning: enabling this option can result in application instability if the application uses proxy classes without "-open:enumerations".

Returns:

Allows addition of enumeration members in the latest service metadata before calling DataService.refreshMetadata. Defaults to false.

hasTopReference

public boolean hasTopReference(java.lang.String ns)

Return true if this document includes a top-level reference for CSDL namespace ns.

See Also:

CsdlDocument.topReferences.

Parameters:

ns - CSDL namespace.

Returns:

`true` if this document includes a top-level reference for CSDL namespace `ns`.

hasTopSchema

public boolean hasTopSchema(java.lang.String ns)

Return true if this document includes a top-level schema for CSDL namespace ns.

See Also:

CsdlDocument.topSchemas.

Parameters:

ns - CSDL namespace.

Returns:

`true` if this document includes a top-level schema for CSDL namespace `ns`.

inheritAnnotations

public void inheritAnnotations()

Inherit annotations from entity types to entity sets in this metadata.

removeOwner

public void removeOwner(java.lang.Object owner)

Unregister owner as an owner of this metadata document.

Parameters:

owner - Metadata owner.

removeReferences

public void removeReferences(java.lang.String alias)

Remove from CsdlDocument.originalText any references or annotations using the specified alias.

See Also:

CsdlDocument.excludingAlias.

Parameters:

alias - Namespace/alias (or comma-separated list of namespaces/aliases).

removeServerOnly

public void removeServerOnly(java.lang.String vocabularyAlias)

Remove from CsdlDocument.originalText any elements which have a child ServerOnly Annotation element.

Parameters:

vocabularyAlias - (nullable) Namespace/alias name of the SQL vocabulary.

resolveEntity

public void resolveEntity(EntityValue entity)

Resolve the EntityValue.entitySet of `entity' (if it is not already set).

Throws:

DataServiceException if entity.entitySet is not set, and is not unique (i.e. multiple entity sets use the same entity type)

or there is a circular dependency in related entities (parent entity is set as child as well) or an entity is resolved multiple times meaning that it is embedded as child more than once.

Parameters:

entity - Entity to resolve.

setCanChangeAnything

public void setCanChangeAnything(boolean value)

Set allows any model element to be changed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false. Warning: enabling this option can result in application instability (depending on the changes) if the application uses proxy classes!

Parameters:

value - Allows any model element to be changed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false.

setCanRemoveAnything

public void setCanRemoveAnything(boolean value)

Set allows any model element to be removed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false. Warning: enabling this option can result in application instability unless the application checks isRemoved flags on model elements!

Parameters:

value - Allows any model element to be removed in the latest service metadata before calling DataService.refreshMetadata. Defaults to false.

setDefaultContainer

public void setDefaultContainer(EntityContainer value)

Set default entity container defined by the CSDL (or null if there are no containers defined).

Parameters:

value - Default entity container defined by the CSDL (or null if there are no containers defined).

setGeneratedProxies

public void setGeneratedProxies(boolean value)

Set true if this metadata is associated with generated proxy classes. Defaults to false (generated proxies will override to true).

Parameters:

value - true if this metadata is associated with generated proxy classes. Defaults to false (generated proxies will override to true).

setJoinSetRelations

public void setJoinSetRelations()

Set the JoinSetRelations object to all navigation properties which has "JoinUsing" annotation. Without running this method the navigation through join entity sets cannot be resolved.

setMainSchema

public void setMainSchema(DataSchema value)

Set main data schema defined by the CSDL (or null if there are no schemas defined).

Parameters:

value - Main data schema defined by the CSDL (or null if there are no schemas defined).

setOpenEnumerations

public void setOpenEnumerations(boolean value)

Set allows addition of enumeration members in the latest service metadata before calling DataService.refreshMetadata. Defaults to false. Warning: enabling this option can result in application instability if the application uses proxy classes without "-open:enumerations".

Parameters:

value - Allows addition of enumeration members in the latest service metadata before calling DataService.refreshMetadata. Defaults to false.

setOriginalText

public void setOriginalText(java.lang.String value)

Set original CSDL (XML) text.

See Also:

CsdlOption.RETAIN_ORIGINAL_TEXT.

Parameters:

value - Original CSDL (XML) text.

setProxyVersion

public void setProxyVersion(java.lang.String value)

Set if this metadata was parsed by generated proxy classes, then the framework version that generated the proxies. Otherwise null.

Parameters:

value - If this metadata was parsed by generated proxy classes, then the framework version that generated the proxies. Otherwise null.

setResolvedText

public void setResolvedText(java.lang.String value)

Set resolved CSDL (XML) text, with inline references and expanded aliases.

See Also:

CsdlOption.RETAIN_RESOLVED_TEXT.

Parameters:

value - Resolved CSDL (XML) text, with inline references and expanded aliases.

setSourceFile

public void setSourceFile(java.lang.String value)

Set source file name if known, otherwise null.

Parameters:

value - Source file name if known, otherwise null.

setVersionCode

public void setVersionCode(int value)

Set code for the OData version, e.g. 400. If the OData version is considered as a decimal number (e.g. 4.0), then multiplying by 100 will give the code (e.g. 400).

See Also:

DataVersion.

Parameters:

value - Code for the OData version, e.g. 400.

setVersionText

public void setVersionText(java.lang.String value)

Set text for the OData version, e.g. "4.0".

Parameters:

value - Text for the OData version, e.g. "4.0".