com.sap.cloud.sdk.s4hana.datamodel.odata.generator

Class DataModelGenerator

java.lang.Object

com.sap.cloud.sdk.s4hana.datamodel.odata.generator.DataModelGenerator

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 Boolean	DEFAULT_DELETE_OUTPUT_DIRECTORY The default flag indicating whether the output directory should be deleted prior to the generation.
static String	DEFAULT_INPUT_DIRECTORY_NAME The default directory name to search and save configuration data in.
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.

Constructor Summary

Constructors

Constructor and Description
DataModelGenerator()

Method Summary

Modifier and Type	Method and Description
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	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).
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	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

equals, 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).

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.

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.

execute

public void execute()

Executes the actual generator based on the given parameter or, in case of absence, their default values.