DataModelGenerator (SAP Cloud SDK - Parent POM 3.20.0 API)

java.lang.Object
- com.sap.cloud.sdk.datamodel.odatav4.generator.DataModelGenerator

```
@Beta
public class DataModelGenerator
extends Object
```
Builder for the ODataToVdmGenerator, gathering all relevant parameter or providing default values for unspecified ones.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ANNOTATION_STRATEGY` The default fully-qualified name of the class to use for providing generated Java classes with necessary annotations.
`static String`	`DEFAULT_BASE_PATH` The default base path, used in absence of a swagger file to determine a service path.
`static String`	`DEFAULT_COPYRIGHT_HEADER` The default copyright header that is added to generated files.
`static Boolean`	`DEFAULT_DELETE_OUTPUT_DIRECTORY` The default flag indicating whether the output directory should be deleted prior to the generation.
`static String`	`DEFAULT_EXCLUDES_PATTERN` The default ant style pattern of filenames for which VDM should not be generated - empty string.
`static Boolean`	`DEFAULT_FAIL_ON_WARNING` The default flag indicating whether to exit with a failure in case a warning occurs.
`static String`	`DEFAULT_INPUT_DIRECTORY_NAME` The default directory name to search and save configuration data in.
`static Boolean`	`DEFAULT_LINK_TO_API_BUSINESS_HUB` The default flag indicating whether to generate API reference URLs linking to the SAP API Business Hub.
`static DefaultNamingStrategy.NameSource`	`DEFAULT_NAMING_SOURCE` The default naming source used in the `DefaultNamingStrategy`.
`static String`	`DEFAULT_NAMING_STRATEGY` The default fully-qualified name of the class to use for converting names from the OData world to the Java world.
`static String`	`DEFAULT_OUTPUT_DIRECTORY_NAME` The default directory name to store the generated sources in.
`static Boolean`	`DEFAULT_OVERWRITE_FILES` The default flag indicating whether already existing files should be overwritten.
`static String`	`DEFAULT_PACKAGE_NAME` The default package prefix of the generated sources.
`static Boolean`	`DEFAULT_POJOS_ONLY` The default flag indicating whether to generate just the POJO classes (entities and complex types).
`static String`	`DEFAULT_SERVICE_NAME_MAPPING_FILE_NAME` The default file name to the name mapping properties file.
`static Boolean`	`DEFAULT_VERSION_REFERENCE` The default flag indicating whether to skip generating comments indicating the version reference of the used OData generator plugin.
`static String`	`SAP_COPYRIGHT_HEADER` An SAP copyright header that can be added to generated files.

Constructor Summary

Constructors
Constructor and Description

DataModelGenerator()

Constructors
Constructor and Description
`DataModelGenerator()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataModelGenerator`	`copyrightHeader(String copyrightHeader)` Defines a copyright header to be placed at the beginning of generated files.
`DataModelGenerator`	`deleteOutputDirectory()` Deletes the output directory specified by `withPackageName(String)` prior to generating the sources.
`DataModelGenerator`	`deleteOutputDirectory(boolean deleteOutputDirectory)` Defines whether to delete the output directory specified by `withPackageName(String)` prior to generating the sources.
`void`	`execute()` Executes the actual generator based on the given parameter or, in case of absence, their default values.
`DataModelGenerator`	`failOnWarning()` The generator exists with failure in case a warning occurs during processing.
`DataModelGenerator`	`failOnWarning(boolean failOnWarning)` Defines whether to exit with failure in case a warning occurs during processing.
`boolean`	`failureDueToWarningsNecessary()` Get the failure indicator due to warning messages.
`protected AnnotationStrategy`	`getAnnotationStrategy()` Getter for the class which provides generated Java classes with necessary annotations.
`protected String`	`getCopyrightHeader()` Getter for the copyright header to be added to generated files.
`protected String`	`getDefaultBasePath()` Getter for the default base path.
`protected String`	`getExcludeFilePattern()` The ant style filename pattern for which VDM should not be generated.
`protected Set<String>`	`getIncludedActionImports()` Getter for the list of action imports to process.
`protected Set<String>`	`getIncludedEntitySets()` Getter for the list of entity sets to process.
`protected Set<String>`	`getIncludedFunctionImports()` Getter for the list of function imports to process.
`protected File`	`getInputDirectory()` Getter for the directory containing the metadata and swagger files.
`protected DefaultNamingStrategy.NameSource`	`getNameSource()` Getter for the given `DefaultNamingStrategy.NameSource`.
`protected NamingStrategy`	`getNamingStrategy()` Getter for the class which converts OData names to Java names.
`protected File`	`getOutputDirectory()` Getter for the directory the generated files should be written into.
`protected String`	`getPackageName()` Getter for the prefix of the java package the generated files should be located in.
`protected File`	`getServiceNameMappings()` Getter for the file containing the custom service names.
`protected boolean`	`isDeleteTargetDirectory()` Getter for the flag indicating that the `#getOutputDirectory()` should be cleared before generating new files.
`protected boolean`	`isFailOnWarning()` Getter for the flag indicating whether the generator fails in case a warning occurs.
`protected boolean`	`isForceFileOverride()` Getter for the flag indicating that already existing files in the `#getOutputDirectory()` can be overridden.
`protected boolean`	`isGenerateLinksToApiBusinessHub()` Getter for the flag indicating whether to generate API reference URLs linking to the SAP API Business Hub.
`protected boolean`	`isGeneratePojosOnly()` Getter for the flag indicating whether to generate just the POJO classes.
`protected boolean`	`isGenerateVersionReference()` Getter for the flag indicating whether to generate comments referencing the used OData code generator version.
`DataModelGenerator`	`linkToApiBusinessHub()` Activates generation of API reference URLs linking to the SAP API Business Hub.
`DataModelGenerator`	`linkToApiBusinessHub(boolean linkToApiBusinessHub)` Defines whether to generate API reference URLs linking to the SAP API Business Hub.
`DataModelGenerator`	`overwriteFiles()` Defines that already existing files will get overwritten.
`DataModelGenerator`	`overwriteFiles(boolean overwriteFiles)` Defines whether already existing files will get overwritten.
`DataModelGenerator`	`pojosOnly()` Activates POJO only generation, so just entity and complex type classes are generated.
`DataModelGenerator`	`pojosOnly(boolean pojosOnly)` Defines whether to generate just the POJO classes (entities and complex types).
`protected void`	`printExecuteInformation()` Prints all information gathered in this builder.
`DataModelGenerator`	`sapCopyrightHeader()` Generate SAP copyright headers at the top of generated files.
`DataModelGenerator`	`versionReference()` Generate comments, which indicate the version of the used OData VDM generator plugin.
`DataModelGenerator`	`versionReference(boolean versionReference)` Defines whether to generate the version reference of the used OData generator plugin.
`DataModelGenerator`	`withAnnotationStrategy(AnnotationStrategy annotationStrategy)` Sets the class to use to provide generated Java classes with necessary annotations.
`DataModelGenerator`	`withAnnotationStrategy(String annotationStrategyClassName)` Sets the class to use to provide generated Java classes with necessary annotations.
`DataModelGenerator`	`withDefaultBasePath(String defaultBasePath)` Specifies the default base path.
`DataModelGenerator`	`withExcludeFilePattern(String excludeFilePattern)` The ant style filename pattern for which VDM should not be generated.
`DataModelGenerator`	`withIncludedActionImports(Set<String> includedActionImports)` Restricts the generated action imports to the provided values, plus any dependent complex types.
`DataModelGenerator`	`withIncludedEntitySets(Set<String> includedEntitySets)` Restricts the generated entity classes to the provided values, plus any dependent complex types.
`DataModelGenerator`	`withIncludedFunctionImports(Set<String> includedFunctionImports)` Restricts the generated function imports to the provided values, plus any dependent complex types.
`DataModelGenerator`	`withInputDirectory(File inputDirectory)` Input directory that contains the service definition files.
`DataModelGenerator`	`withInputDirectory(String inputDirectory)` Path to the input directory that contains the service definition files.
`DataModelGenerator`	`withNameSource(DefaultNamingStrategy.NameSource nameSource)` Getter for the given `DefaultNamingStrategy.NameSource`.
`DataModelGenerator`	`withNamingStrategy(NamingStrategy namingStrategy)` Sets the class to use to convert OData names into suitable Java names.
`DataModelGenerator`	`withNamingStrategy(String namingStrategyClassName)` Sets the class to use to convert OData names into suitable Java names.
`DataModelGenerator`	`withOutputDirectory(File outputDirectory)` Output directory to store the generated sources in.
`DataModelGenerator`	`withOutputDirectory(String outputDirectory)` Path to the output directory to store the generated sources in.
`DataModelGenerator`	`withPackageName(String packageName)` Specifies the package prefix to be used in the generated sources.
`DataModelGenerator`	`withServiceNameMapping(File serviceNameMappingFile)` The properties file containing the service name mapping.
`DataModelGenerator`	`withServiceNameMapping(String serviceNameMappingFile)` The path to the properties file containing the service name mapping.

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

- Field Detail
  - DEFAULT_INPUT_DIRECTORY_NAME
```
public static final String DEFAULT_INPUT_DIRECTORY_NAME
```
    The default directory name to search and save configuration data in.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_OUTPUT_DIRECTORY_NAME
```
public static final String DEFAULT_OUTPUT_DIRECTORY_NAME
```
    The default directory name to store the generated sources in.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_DELETE_OUTPUT_DIRECTORY
```
public static final Boolean DEFAULT_DELETE_OUTPUT_DIRECTORY
```
    The default flag indicating whether the output directory should be deleted prior to the generation.
  - DEFAULT_OVERWRITE_FILES
```
public static final Boolean DEFAULT_OVERWRITE_FILES
```
    The default flag indicating whether already existing files should be overwritten. If false, an exception is thrown if a file already exists.
  - DEFAULT_PACKAGE_NAME
```
public static final String DEFAULT_PACKAGE_NAME
```
    The default package prefix of the generated sources.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_BASE_PATH
```
public static final String DEFAULT_BASE_PATH
```
    The default base path, used in absence of a swagger file to determine a service path.
  - DEFAULT_SERVICE_NAME_MAPPING_FILE_NAME
```
public static final String DEFAULT_SERVICE_NAME_MAPPING_FILE_NAME
```
    The default file name to the name mapping properties file.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NAMING_STRATEGY
```
public static final String DEFAULT_NAMING_STRATEGY
```
    The default fully-qualified name of the class to use for converting names from the OData world to the Java world.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_ANNOTATION_STRATEGY
```
public static final String DEFAULT_ANNOTATION_STRATEGY
```
    The default fully-qualified name of the class to use for providing generated Java classes with necessary annotations.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_NAMING_SOURCE
```
public static final DefaultNamingStrategy.NameSource DEFAULT_NAMING_SOURCE
```
    The default naming source used in the DefaultNamingStrategy.
  - DEFAULT_POJOS_ONLY
```
public static final Boolean DEFAULT_POJOS_ONLY
```
    The default flag indicating whether to generate just the POJO classes (entities and complex types).
  - DEFAULT_EXCLUDES_PATTERN
```
public static final String DEFAULT_EXCLUDES_PATTERN
```
    The default ant style pattern of filenames for which VDM should not be generated - empty string.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LINK_TO_API_BUSINESS_HUB
```
public static final Boolean DEFAULT_LINK_TO_API_BUSINESS_HUB
```
    The default flag indicating whether to generate API reference URLs linking to the SAP API Business Hub.
  - DEFAULT_FAIL_ON_WARNING
```
public static final Boolean DEFAULT_FAIL_ON_WARNING
```
    The default flag indicating whether to exit with a failure in case a warning occurs.
  - DEFAULT_VERSION_REFERENCE
```
public static final Boolean DEFAULT_VERSION_REFERENCE
```
    The default flag indicating whether to skip generating comments indicating the version reference of the used OData generator plugin.
  - DEFAULT_COPYRIGHT_HEADER
```
public static final String DEFAULT_COPYRIGHT_HEADER
```
    The default copyright header that is added to generated files. By default, no copyright headers are added.
    
    See Also:
    
    Constant Field Values
  - SAP_COPYRIGHT_HEADER
```
public static final String SAP_COPYRIGHT_HEADER
```
    An SAP copyright header that can be added to generated files.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataModelGenerator
```
public DataModelGenerator()
```
- Method Detail
  - withInputDirectory
```
@Nonnull
public DataModelGenerator withInputDirectory(@Nonnull
                                                      String inputDirectory)
```
    Path to the input directory that contains the service definition files.
    
    Parameters:
    
    inputDirectory - The directory to read the service data from.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withInputDirectory
```
@Nonnull
public DataModelGenerator withInputDirectory(@Nonnull
                                                      File inputDirectory)
```
    Input directory that contains the service definition files.
    
    Parameters:
    
    inputDirectory - The directory to read the service data from.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withOutputDirectory
```
@Nonnull
public DataModelGenerator withOutputDirectory(@Nonnull
                                                       String outputDirectory)
```
    Path to the output directory to store the generated sources in.
    The generated sources will be stored under this directory according to the packages specified.
    
    Parameters:
    
    outputDirectory - The path to the root directory to store the generated sources in.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withOutputDirectory
```
@Nonnull
public DataModelGenerator withOutputDirectory(@Nonnull
                                                       File outputDirectory)
```
    Output directory to store the generated sources in.
    The generated sources will be stored under this directory according to the packages specified.
    
    Parameters:
    
    outputDirectory - The root directory to store the generated sources in.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - deleteOutputDirectory
```
@Nonnull
public DataModelGenerator deleteOutputDirectory()
```
    Deletes the output directory specified by withPackageName(String) prior to generating the sources.
    This option should be used to determine the whole change set, including deleted files.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - deleteOutputDirectory
```
@Nonnull
public DataModelGenerator deleteOutputDirectory(boolean deleteOutputDirectory)
```
    Defines whether to delete the output directory specified by withPackageName(String) prior to generating the sources.
    This option should be used to determine the whole change set, including deleted files.
    
    Parameters:
    
    deleteOutputDirectory - Flag indicating whether the output directory should be cleaned.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - overwriteFiles
```
@Nonnull
public DataModelGenerator overwriteFiles()
```
    Defines that already existing files will get overwritten. Otherwise, an exception is thrown if a file already exists.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - overwriteFiles
```
@Nonnull
public DataModelGenerator overwriteFiles(boolean overwriteFiles)
```
    Defines whether already existing files will get overwritten. If false, an exception is thrown if a file already exists.
    
    Parameters:
    
    overwriteFiles - Flag indicating whether already existing files can be overwritten.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withPackageName
```
@Nonnull
public DataModelGenerator withPackageName(@Nonnull
                                                   String packageName)
```
    Specifies the package prefix to be used in the generated sources.
    
    Parameters:
    
    packageName - The package prefix for the generated sources.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withDefaultBasePath
```
@Nonnull
public DataModelGenerator withDefaultBasePath(@Nullable
                                                       String defaultBasePath)
```
    Specifies the default base path.
    If no swagger file is given, this base path, together with the metadata file name, constitute the service path with the following pattern: <defaultBasePath> + <metadataFileNameWithoutExtension>.
    
    Parameters:
    
    defaultBasePath - The default base path.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withServiceNameMapping
```
@Nonnull
public DataModelGenerator withServiceNameMapping(@Nonnull
                                                          File serviceNameMappingFile)
```
    The properties file containing the service name mapping.
    Any service not mapped in this file will get created/updated.
    
    Parameters:
    
    serviceNameMappingFile - The file to read/set the service name mappings in.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withServiceNameMapping
```
@Nonnull
public DataModelGenerator withServiceNameMapping(@Nonnull
                                                          String serviceNameMappingFile)
```
    The path to the properties file containing the service name mapping.
    Any service not mapped in this file will get created/updated.
    
    Parameters:
    
    serviceNameMappingFile - The file to read/set the service name mappings in.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withNamingStrategy
```
@Nonnull
public DataModelGenerator withNamingStrategy(@Nonnull
                                                      NamingStrategy namingStrategy)
```
    Sets the class to use to convert OData names into suitable Java names.
    
    Parameters:
    
    namingStrategy - Instance of a class, which must either implement the CodeNamingStrategy interface, or extend a class which implements this interface.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withNamingStrategy
```
@Nonnull
public DataModelGenerator withNamingStrategy(@Nonnull
                                                      String namingStrategyClassName)
```
    Sets the class to use to convert OData names into suitable Java names.
    
    Parameters:
    
    namingStrategyClassName - Fully-qualified name of a class, which must either implement the NamingStrategy interface, or extend a class which implements this interface.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withNameSource
```
@Nonnull
public DataModelGenerator withNameSource(@Nonnull
                                                  DefaultNamingStrategy.NameSource nameSource)
```
    Getter for the given DefaultNamingStrategy.NameSource.
    If the namingStrategy is DefaultNamingStrategy, this enum will be used to determine the actual source of the java name.
    
    Parameters:
    
    nameSource - The NameSource to be used by the DefaulNamingStrategy.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withAnnotationStrategy
```
@Nonnull
public DataModelGenerator withAnnotationStrategy(@Nonnull
                                                          AnnotationStrategy annotationStrategy)
```
    Sets the class to use to provide generated Java classes with necessary annotations.
    
    Parameters:
    
    annotationStrategy - Instance of a class, which must either implement the AnnotationStrategy interface, or extend a class which implements this interface.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withAnnotationStrategy
```
@Nonnull
public DataModelGenerator withAnnotationStrategy(@Nonnull
                                                          String annotationStrategyClassName)
```
    Sets the class to use to provide generated Java classes with necessary annotations.
    
    Parameters:
    
    annotationStrategyClassName - Fully-qualified name of a class, which must either implement the AnnotationStrategy interface, or extend a class which implements this interface.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - failOnWarning
```
@Nonnull
public DataModelGenerator failOnWarning(boolean failOnWarning)
```
    Defines whether to exit with failure in case a warning occurs during processing.
    
    Parameters:
    
    failOnWarning - Flag indicating whether to generate just the POJO classes.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - failOnWarning
```
@Nonnull
public DataModelGenerator failOnWarning()
```
    The generator exists with failure in case a warning occurs during processing.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - pojosOnly
```
@Nonnull
public DataModelGenerator pojosOnly(boolean pojosOnly)
```
    Defines whether to generate just the POJO classes (entities and complex types).
    
    Parameters:
    
    pojosOnly - Flag indicating whether to generate just the POJO classes.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - pojosOnly
```
@Nonnull
public DataModelGenerator pojosOnly()
```
    Activates POJO only generation, so just entity and complex type classes are generated.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withExcludeFilePattern
```
@Nonnull
public DataModelGenerator withExcludeFilePattern(@Nonnull
                                                          String excludeFilePattern)
```
    The ant style filename pattern for which VDM should not be generated.
    
    Parameters:
    
    excludeFilePattern - Provide the ant style pattern for filenames for which VDM should not be generated.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - linkToApiBusinessHub
```
@Nonnull
public DataModelGenerator linkToApiBusinessHub(boolean linkToApiBusinessHub)
```
    Defines whether to generate API reference URLs linking to the SAP API Business Hub.
    
    Parameters:
    
    linkToApiBusinessHub - Flag indicating whether to generate URLs.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - linkToApiBusinessHub
```
@Nonnull
public DataModelGenerator linkToApiBusinessHub()
```
    Activates generation of API reference URLs linking to the SAP API Business Hub.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - versionReference
```
@Nonnull
public DataModelGenerator versionReference(boolean versionReference)
```
    Defines whether to generate the version reference of the used OData generator plugin.
    
    Parameters:
    
    versionReference - Flag indicating whether to generate the comments.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - versionReference
```
@Nonnull
public DataModelGenerator versionReference()
```
    Generate comments, which indicate the version of the used OData VDM generator plugin.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - copyrightHeader
```
@Nonnull
public DataModelGenerator copyrightHeader(String copyrightHeader)
```
    Defines a copyright header to be placed at the beginning of generated files. Use an empty string if no header needs to be set. For setting SAP copyright headers #defaultSAPCopyrightHeaders.
    
    Parameters:
    
    copyrightHeader - The copyright header to add to generated files.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - sapCopyrightHeader
```
@Nonnull
public DataModelGenerator sapCopyrightHeader()
```
    Generate SAP copyright headers at the top of generated files.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withIncludedEntitySets
```
@Nonnull
public DataModelGenerator withIncludedEntitySets(@Nullable
                                                          Set<String> includedEntitySets)
```
    Restricts the generated entity classes to the provided values, plus any dependent complex types. For navigation properties, the associated entity set names must be included in order to be generated.
    
    Parameters:
    
    includedEntitySets - List of entity set names to generate classes for. These names must exist in the provided EDMX files in order to be recognized. If a null value is provided, then all entity sets will be generated.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withIncludedFunctionImports
```
@Nonnull
public DataModelGenerator withIncludedFunctionImports(@Nullable
                                                               Set<String> includedFunctionImports)
```
    Restricts the generated function imports to the provided values, plus any dependent complex types. If the return type is an entity, then make sure to include its entity set name using withIncludedEntitySets(Set) (or generate all entity sets). Otherwise the function import code cannot be generated.
    
    Parameters:
    
    includedFunctionImports - List of function import names to generate code for. These names must exist in the provided EDMX files in order to be recognized. If a null value is provided, then all function imports will be generated.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - withIncludedActionImports
```
@Nonnull
public DataModelGenerator withIncludedActionImports(@Nullable
                                                             Set<String> includedActionImports)
```
    Restricts the generated action imports to the provided values, plus any dependent complex types. If the return type is an entity, then make sure to include its entity set name using withIncludedEntitySets(Set) (or generate all entity sets). Otherwise the action import code cannot be generated.
    
    Parameters:
    
    includedActionImports - List of action import names to generate code for. These names must exist in the provided EDMX files in order to be recognized. If a null value is provided, then all action imports will be generated.
    
    Returns:
    
    This DataModelGenerator for chained method calls.
  - getInputDirectory
```
protected File getInputDirectory()
```
    Getter for the directory containing the metadata and swagger files.
    
    Returns:
    
    The input directory of the generator.
  - getOutputDirectory
```
protected File getOutputDirectory()
```
    Getter for the directory the generated files should be written into.
    This is also the directory which gets cleared if the isDeleteTargetDirectory() is set.
    
    Returns:
    
    The output directory of the generator.
  - isDeleteTargetDirectory
```
protected boolean isDeleteTargetDirectory()
```
    Getter for the flag indicating that the #getOutputDirectory() should be cleared before generating new files.
    
    Returns:
    
    true, if the #getOutputDirectory() should be cleared; false otherwise.
  - isForceFileOverride
```
protected boolean isForceFileOverride()
```
    Getter for the flag indicating that already existing files in the #getOutputDirectory() can be overridden.
    
    Returns:
    
    true, if existing files in #getOutputDirectory() can be overridden; false otherwise.
  - getPackageName
```
protected String getPackageName()
```
    Getter for the prefix of the java package the generated files should be located in.
    This also builds a directory structure inside the getOutputDirectory().
    
    Returns:
    
    The package prefix of the generated files.
  - getDefaultBasePath
```
@Nullable
protected String getDefaultBasePath()
```
    Getter for the default base path.
    If no swagger file is given, this base path, together with the metadata file name, constitute the service path with the following pattern: <defaultBasePath> + <metadataFileNameWithoutExtension>.
    
    Returns:
    
    The default base path.
  - getServiceNameMappings
```
protected File getServiceNameMappings()
```
    Getter for the file containing the custom service names.
    If this file does not exist it will be created.
    
    Returns:
    
    The service name mapping file.
  - getNamingStrategy
```
protected NamingStrategy getNamingStrategy()
```
    Getter for the class which converts OData names to Java names.
    Defaults to the DefaultNamingStrategy class.
    
    Returns:
    
    Class instance which converts OData names to Java names.
  - getNameSource
```
protected DefaultNamingStrategy.NameSource getNameSource()
```
    Getter for the given DefaultNamingStrategy.NameSource.
    If getNamingStrategy() returns the DefaultNamingStrategy, this enum will be used to determine the actual source of the java name.
    
    Returns:
    
    The specified NameSource enum to be used by the DefaultNamingStrategy.
  - getAnnotationStrategy
```
protected AnnotationStrategy getAnnotationStrategy()
```
    Getter for the class which provides generated Java classes with necessary annotations.
    Defaults to the DefaultAnnotationStrategy.
    
    Returns:
    
    Class instance which provides generated Java classes with necessary annotations.
  - isGeneratePojosOnly
```
protected boolean isGeneratePojosOnly()
```
    Getter for the flag indicating whether to generate just the POJO classes.
    
    Returns:
    
    true, if only the POJO classes should be generated; false otherwise.
  - isFailOnWarning
```
protected boolean isFailOnWarning()
```
    Getter for the flag indicating whether the generator fails in case a warning occurs.
    
    Returns:
    
    true, if the generator fails on a warning; false otherwise.
  - getExcludeFilePattern
```
protected String getExcludeFilePattern()
```
    The ant style filename pattern for which VDM should not be generated.
    
    Returns:
    
    The ant style exclusion pattern.
  - isGenerateLinksToApiBusinessHub
```
protected boolean isGenerateLinksToApiBusinessHub()
```
    Getter for the flag indicating whether to generate API reference URLs linking to the SAP API Business Hub.
    
    Returns:
    
    true, if URLs should be generated; false otherwise.
  - isGenerateVersionReference
```
protected boolean isGenerateVersionReference()
```
    Getter for the flag indicating whether to generate comments referencing the used OData code generator version.
    
    Returns:
    
    true, if the comments should be generated; false otherwise.
  - getCopyrightHeader
```
protected String getCopyrightHeader()
```
    Getter for the copyright header to be added to generated files.
    
    Returns:
    
    a string representing the header or an empty string, if no header is to be set.
  - getIncludedEntitySets
```
protected Set<String> getIncludedEntitySets()
```
    Getter for the list of entity sets to process.
    
    Returns:
    
    List of entity set names defined in the EDMX.
  - getIncludedFunctionImports
```
protected Set<String> getIncludedFunctionImports()
```
    Getter for the list of function imports to process.
    
    Returns:
    
    List of function import names defined in the EDMX.
  - getIncludedActionImports
```
protected Set<String> getIncludedActionImports()
```
    Getter for the list of action imports to process.
    
    Returns:
    
    List of action import names defined in the EDMX.
  - execute
```
public void execute()
```
    Executes the actual generator based on the given parameter or, in case of absence, their default values.
  - printExecuteInformation
```
protected void printExecuteInformation()
```
    Prints all information gathered in this builder.
  - failureDueToWarningsNecessary
```
public boolean failureDueToWarningsNecessary()
```
    Get the failure indicator due to warning messages.
    
    Returns:
    
    true if there where warning messages and the flag to fail was set.

Class DataModelGenerator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_INPUT_DIRECTORY_NAME

DEFAULT_OUTPUT_DIRECTORY_NAME

DEFAULT_DELETE_OUTPUT_DIRECTORY

DEFAULT_OVERWRITE_FILES

DEFAULT_PACKAGE_NAME

DEFAULT_BASE_PATH

DEFAULT_SERVICE_NAME_MAPPING_FILE_NAME

DEFAULT_NAMING_STRATEGY

DEFAULT_ANNOTATION_STRATEGY

DEFAULT_NAMING_SOURCE

DEFAULT_POJOS_ONLY

DEFAULT_EXCLUDES_PATTERN

DEFAULT_LINK_TO_API_BUSINESS_HUB

DEFAULT_FAIL_ON_WARNING

DEFAULT_VERSION_REFERENCE

DEFAULT_COPYRIGHT_HEADER

SAP_COPYRIGHT_HEADER

Constructor Detail

DataModelGenerator

Method Detail

withInputDirectory

withInputDirectory

withOutputDirectory

withOutputDirectory

deleteOutputDirectory

deleteOutputDirectory

overwriteFiles

overwriteFiles

withPackageName

withDefaultBasePath

withServiceNameMapping

withServiceNameMapping

withNamingStrategy

withNamingStrategy

withNameSource

withAnnotationStrategy

withAnnotationStrategy

failOnWarning

failOnWarning

pojosOnly

pojosOnly

withExcludeFilePattern

linkToApiBusinessHub

linkToApiBusinessHub

versionReference

versionReference

copyrightHeader

sapCopyrightHeader

withIncludedEntitySets

withIncludedFunctionImports

withIncludedActionImports

getInputDirectory

getOutputDirectory

isDeleteTargetDirectory

isForceFileOverride

getPackageName

getDefaultBasePath

getServiceNameMappings

getNamingStrategy

getNameSource

getAnnotationStrategy

isGeneratePojosOnly

isFailOnWarning

getExcludeFilePattern

isGenerateLinksToApiBusinessHub

isGenerateVersionReference

getCopyrightHeader

getIncludedEntitySets

getIncludedFunctionImports

getIncludedActionImports

execute

printExecuteInformation

failureDueToWarningsNecessary