Package no.sikt.graphitron.generators.db

Class DBClassGenerator

java.lang.Object

no.sikt.graphitron.generators.abstractions.AbstractClassGenerator

no.sikt.graphitron.generators.abstractions.AbstractSchemaClassGenerator<ObjectDefinition>

no.sikt.graphitron.generators.db.DBClassGenerator

All Implemented Interfaces:

ClassGenerator

public class DBClassGenerator
extends AbstractSchemaClassGenerator<ObjectDefinition>

Class generator that keeps track of all method generators for DB queries.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_SAVE_DIRECTORY_NAME
static final String	FILE_NAME_SUFFIX
protected final Set<ObjectField>	objectFieldsReturningNode

Fields inherited from class no.sikt.graphitron.generators.abstractions.AbstractSchemaClassGenerator

processedSchema

Constructor Summary

Constructors

Constructor	Description
DBClassGenerator(ProcessedSchema processedSchema)

Method Summary

Modifier and Type	Method	Description
TypeSpec	generate(ObjectDefinition target)
List<TypeSpec>	generateAll()	Generate the classes and return the list of TypeSpecs.
String	getDefaultSaveDirectoryName()
String	getFileNameSuffix()
TypeSpec.Builder	getSpec(String className, List<? extends MethodGenerator> generators)
protected Set<Class<?>>	getStaticImports()
void	writeToFile(TypeSpec generatedClass, String path, String packagePath, String directoryOverride)	Create the JavaFile for this class, add any common static imports and write it to file.
String	writeToString(TypeSpec generatedClass)	Create the JavaFile for this class, add any common static imports and render the file as a string.

Methods inherited from class no.sikt.graphitron.generators.abstractions.AbstractClassGenerator

generateAllAsMap, generateAllToDirectory, getGeneratedClassName, getSpec, setDependencies, writeToFile

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_SAVE_DIRECTORY_NAME

public static final String DEFAULT_SAVE_DIRECTORY_NAME

See Also:

• Constant Field Values

FILE_NAME_SUFFIX

public static final String FILE_NAME_SUFFIX

See Also:

• Constant Field Values

objectFieldsReturningNode

protected final Set<ObjectField> objectFieldsReturningNode

Constructor Details

DBClassGenerator

public DBClassGenerator(ProcessedSchema processedSchema)

Method Details

generateAll

public List<TypeSpec> generateAll()

Description copied from interface: ClassGenerator

Generate the classes and return the list of TypeSpecs.

generate

public TypeSpec generate(ObjectDefinition target)

Specified by:

generate in class AbstractSchemaClassGenerator<ObjectDefinition>

Parameters:

target - A GenerationTarget object representing a source from which a class should be generated.

Returns:

A complete class in the form of a javapoet TypeSpec.

getDefaultSaveDirectoryName

public String getDefaultSaveDirectoryName()

Returns:

The final directory path within the package where the classes are ultimately saved.

getSpec

public TypeSpec.Builder getSpec(String className,
 List<? extends MethodGenerator> generators)

Specified by:

getSpec in interface ClassGenerator

Overrides:

getSpec in class AbstractClassGenerator

Parameters:

className - The name of the class.

generators - List of method generators that this class should use to generate its methods.

Returns:

A completed TypeSpec.Builder for this class, where all methods have already been added.

getStaticImports

protected Set<Class<?>> getStaticImports()

writeToFile

public void writeToFile(TypeSpec generatedClass,
 String path,
 String packagePath,
 String directoryOverride)

Description copied from interface: ClassGenerator

Create the JavaFile for this class, add any common static imports and write it to file.

Specified by:

writeToFile in interface ClassGenerator

Overrides:

writeToFile in class AbstractClassGenerator

Parameters:

generatedClass - A complete javapoet TypeSpec.

path - The path to the output directory.

packagePath - The package path that this class should be written to.

directoryOverride - Override the directory within the package where the class is saved to.

writeToString

public String writeToString(TypeSpec generatedClass)

Description copied from interface: ClassGenerator

Create the JavaFile for this class, add any common static imports and render the file as a string.

Specified by:

writeToString in interface ClassGenerator

Overrides:

writeToString in class AbstractClassGenerator

Parameters:

generatedClass - A complete javapoet TypeSpec.

getFileNameSuffix

public String getFileNameSuffix()

Returns:

The suffix that is to be added to the end of file names generated by this class.