de.ipcon.schema.generators.java

Class JavaPersistenceCode

java.lang.Object

de.ipcon.schema.generators.AbstractCode

de.ipcon.schema.generators.java.JavaPersistenceCode

All Implemented Interfaces:

CBOGeneratorI, java.io.Serializable

public class JavaPersistenceCode
extends AbstractCode

generates the *Base classes from schema entities in Java source code. A typical base class contains, among other things, fields, setters and getters for attribtues, de/serialization logic and special setter / getter for the persistence layer (hence the name).

lk 2024-06-14: more or less a 1:1 translation from PersistenceCode.nrx - there's still room for further optimization and refactoring!

See Also:

Serialized Form

Field Summary

Fields inherited from interface de.ipcon.schema.CBOGeneratorI

SCOPE_GLOBAL, SCOPE_LOCAL

Constructor Summary

Constructors

Constructor and Description
JavaPersistenceCode(electric.xml.Element e)

Method Summary

Modifier and Type	Method and Description
void	debugSUIDCalculation(SchemaI schema)
boolean	doGenerate(CBOEntity entity) Determines whether code should be generated for the given entity.
CBOGeneratorResult	generate(SchemaI schema, SchemaI ignore) generates classes for each entity in the provided schema.
void	generateEntity(CBOEntity entity, SchemaI schema)
void	generateInterface(SchemaInterfaceI interfaceI) generates a java source file for a schema-declared interface
java.lang.String	getFileExtension()
java.lang.String	getName() Retrieves the name of the generator implementation.

Methods inherited from class de.ipcon.schema.generators.AbstractCode

compile, touchNonModulesEntityFile, writeFile, writeFile, writeFile

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.ipcon.schema.CBOGeneratorI

generate

Constructor Detail

JavaPersistenceCode

public JavaPersistenceCode(electric.xml.Element e)

Method Detail

getName

public java.lang.String getName()

Description copied from interface: CBOGeneratorI

Retrieves the name of the generator implementation.

Specified by:

getName in interface CBOGeneratorI

Specified by:

getName in class AbstractCode

Returns:

The generator name as a String.

getFileExtension

public java.lang.String getFileExtension()

Overrides:

getFileExtension in class AbstractCode

generate

public CBOGeneratorResult generate(SchemaI schema,
                                   SchemaI ignore)

generates classes for each entity in the provided schema.

Specified by:

generate in interface CBOGeneratorI

Specified by:

generate in class AbstractCode

Parameters:

schema - the schema for which entities shall be generated

ignore - if given, entities from this schema are ignored

Returns:

a null CBOGeneratorResult

debugSUIDCalculation

public void debugSUIDCalculation(SchemaI schema)

generateInterface

public void generateInterface(SchemaInterfaceI interfaceI)

generates a java source file for a schema-declared interface

Parameters:

interfaceI - the schema-declared interface to use as basis for the Java source file.

doGenerate

public boolean doGenerate(CBOEntity entity)

Determines whether code should be generated for the given entity.

Code generation is performed if the following conditions are met:

• The entity is marked for code generation (entity.isGenerate() returns true).
• The entity is in the current scope. This means either the entity is local (entity.isLocal() returns true) or the generator's scope is not restricted to local entities (scope != CBOGeneratorI.SCOPE_LOCAL).

Parameters:

entity - The entity to check for code generation.

Returns:

true if code should be generated for the entity, false otherwise.

generateEntity

public void generateEntity(CBOEntity entity,
                           SchemaI schema)