CsdlFormatter (SAP Cloud Platform - Server OData API for Mobile Services)

java.lang.Object
- com.sap.cloud.server.odata.csdl.CsdlFormatter

```
public class CsdlFormatter
extends java.lang.Object
```
Formatter for Open Data Protocol (OData) service metadata documents (CSDL). A new formatter should be created for each CsdlFormatter.formatXML or CsdlFormatter.formatJSON call. A formatter should not be shared by multiple threads.

Constructor Summary

Constructors
Constructor and Description

CsdlFormatter()

Constructors
Constructor and Description
`CsdlFormatter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JsonObject`	`formatJSON(CsdlDocument metadata)` See formatJSON(CsdlDocument, int).
`JsonObject`	`formatJSON(CsdlDocument metadata, int version)` Return OData CSDL JSON generated from `metadata`.
`XmlDocument`	`formatXML(CsdlDocument metadata)` See formatXML(CsdlDocument, int).
`XmlDocument`	`formatXML(CsdlDocument metadata, int version)` Return OData CSDL XML generated from `metadata`.
`boolean`	`getDefaultEntitySets()` Return set this to `true` to generate a default entity set for each entity type that has no associated entity set.
`boolean`	`getDefaultMethodImports()` Return set this to `true` to generate a default ActionImport/FunctionImport for each data method that has no associated import.
`boolean`	`getDefaultPathBindings()` Return set this to `true` to generate a default path binding for each navigation property that has no associated path binding.
`boolean`	`getReturnTypeElements()` Return set this to `true` to generate `ReturnType` elements even for OData V2 (which normally uses XML attributes).
`boolean`	`getReturnTypeFacets()` Return set this to `true` to generate `ReturnType` facets even for OData V2/V3 (which normally disallow return facets).
`void`	`setDefaultEntitySets(boolean value)` Set set this to `true` to generate a default entity set for each entity type that has no associated entity set.
`void`	`setDefaultMethodImports(boolean value)` Set set this to `true` to generate a default ActionImport/FunctionImport for each data method that has no associated import.
`void`	`setDefaultPathBindings(boolean value)` Set set this to `true` to generate a default path binding for each navigation property that has no associated path binding.
`void`	`setReturnTypeElements(boolean value)` Set set this to `true` to generate `ReturnType` elements even for OData V2 (which normally uses XML attributes).
`void`	`setReturnTypeFacets(boolean value)` Set set this to `true` to generate `ReturnType` facets even for OData V2/V3 (which normally disallow return facets).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CsdlFormatter
```
public CsdlFormatter()
```
- Method Detail
  - formatJSON
```
public JsonObject formatJSON(CsdlDocument metadata)
```
    See formatJSON(CsdlDocument, int).
    
    Parameters:
    
    metadata - Metadata parameter.
    
    Returns:
    
    (see linked method).
  - formatJSON
```
public JsonObject formatJSON(CsdlDocument metadata,
                             int version)
```
    Return OData CSDL JSON generated from metadata.
    
    Parameters:
    
    metadata - CSDL document.
    
    version - CSDL version for generation. If zero, defaults to CsdlDocument.versionCode.
    
    Returns:
    
    OData CSDL JSON generated from metadata.
  - formatXML
```
public XmlDocument formatXML(CsdlDocument metadata)
```
    See formatXML(CsdlDocument, int).
    
    Parameters:
    
    metadata - Metadata parameter.
    
    Returns:
    
    (see linked method).
  - formatXML
```
public XmlDocument formatXML(CsdlDocument metadata,
                             int version)
```
    Return OData CSDL XML generated from metadata.
    
    Parameters:
    
    metadata - CSDL document.
    
    version - CSDL version for generation. If zero, defaults to CsdlDocument.versionCode.
    
    Returns:
    
    OData CSDL XML generated from metadata.
  - getDefaultEntitySets
```
public boolean getDefaultEntitySets()
```
    Return set this to true to generate a default entity set for each entity type that has no associated entity set.
    
    Returns:
    
    Set this to true to generate a default entity set for each entity type that has no associated entity set.
  - getDefaultMethodImports
```
public boolean getDefaultMethodImports()
```
    Return set this to true to generate a default ActionImport/FunctionImport for each data method that has no associated import. Not applicable to data methods with DataMethod.isBound == true.
    
    Returns:
    
    Set this to true to generate a default ActionImport/FunctionImport for each data method that has no associated import.
  - getDefaultPathBindings
```
public boolean getDefaultPathBindings()
```
    Return set this to true to generate a default path binding for each navigation property that has no associated path binding.
    
    Returns:
    
    Set this to true to generate a default path binding for each navigation property that has no associated path binding.
  - getReturnTypeElements
```
public boolean getReturnTypeElements()
```
    Return set this to true to generate ReturnType elements even for OData V2 (which normally uses XML attributes). This results in non-standard CSDL (but may be useful for datatype coverage testing).
    
    Returns:
    
    Set this to true to generate ReturnType elements even for OData V2 (which normally uses XML attributes).
  - getReturnTypeFacets
```
public boolean getReturnTypeFacets()
```
    Return set this to true to generate ReturnType facets even for OData V2/V3 (which normally disallow return facets). This results in non-standard CSDL (but may be useful for datatype coverage testing).
    
    Returns:
    
    Set this to true to generate ReturnType facets even for OData V2/V3 (which normally disallow return facets).
  - setDefaultEntitySets
```
public void setDefaultEntitySets(boolean value)
```
    Set set this to true to generate a default entity set for each entity type that has no associated entity set.
    
    Parameters:
    
    value - Set this to true to generate a default entity set for each entity type that has no associated entity set.
  - setDefaultMethodImports
```
public void setDefaultMethodImports(boolean value)
```
    Set set this to true to generate a default ActionImport/FunctionImport for each data method that has no associated import. Not applicable to data methods with DataMethod.isBound == true.
    
    Parameters:
    
    value - Set this to true to generate a default ActionImport/FunctionImport for each data method that has no associated import.
  - setDefaultPathBindings
```
public void setDefaultPathBindings(boolean value)
```
    Set set this to true to generate a default path binding for each navigation property that has no associated path binding.
    
    Parameters:
    
    value - Set this to true to generate a default path binding for each navigation property that has no associated path binding.
  - setReturnTypeElements
```
public void setReturnTypeElements(boolean value)
```
    Set set this to true to generate ReturnType elements even for OData V2 (which normally uses XML attributes). This results in non-standard CSDL (but may be useful for datatype coverage testing).
    
    Parameters:
    
    value - Set this to true to generate ReturnType elements even for OData V2 (which normally uses XML attributes).
  - setReturnTypeFacets
```
public void setReturnTypeFacets(boolean value)
```
    Set set this to true to generate ReturnType facets even for OData V2/V3 (which normally disallow return facets). This results in non-standard CSDL (but may be useful for datatype coverage testing).
    
    Parameters:
    
    value - Set this to true to generate ReturnType facets even for OData V2/V3 (which normally disallow return facets).

Class CsdlFormatter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CsdlFormatter

Method Detail

formatJSON

formatJSON

formatXML

formatXML

getDefaultEntitySets

getDefaultMethodImports

getDefaultPathBindings

getReturnTypeElements

getReturnTypeFacets

setDefaultEntitySets

setDefaultMethodImports

setDefaultPathBindings

setReturnTypeElements

setReturnTypeFacets