com.asakusafw.dmdl.java.spi

Class JavaDataModelDriver

java.lang.Object

com.asakusafw.dmdl.java.spi.JavaDataModelDriver

Direct Known Subclasses:

CompositeDataModelDriver, CsvFormatEmitter, CsvSupportEmitter, CsvTextEmitter, GeneratorInfoDriver, HiveDataModelEmitter, JdbcSupportEmitter, JoinDriver, JsonFormatEmitter, LineFormatEmitter, ObjectDriver, OrcFileEmitter, ParquetFileEmitter, ProjectionDriver, PropertyOrderDriver, SequenceFileFormatEmitter, StreamSupportEmitter, StringPropertyDriver, SummarizeDriver, TabularTextEmitter, TsvFormatEmitter, WritableDriver

public abstract class JavaDataModelDriver
extends Object

Decorates Java data model classes.

To enhance Java model class generator, clients can implement this and put the class name in META-INF/services/com.asakusafw.dmdl.java.spi.JavaDataModelDriver.

All default implementation will do nothing.

Since:

0.2.0

Version:

0.9.2

Constructor Summary

Constructors

Constructor and Description
JavaDataModelDriver()

Method Summary

Modifier and Type	Method and Description
void	generateResources(EmitContext context, ModelDeclaration model) Generates any resources (includes source programs) for the model.
List<FieldDeclaration>	getFields(EmitContext context, ModelDeclaration model) Returns the field declarations to mixin to the model.
List<Type>	getInterfaces(EmitContext context, ModelDeclaration model) Returns the interface types to implement to the model.
List<Annotation>	getMemberAnnotations(EmitContext context, PropertyDeclaration property) Returns the type annotations to attach to the property.
List<Annotation>	getMemberAnnotations(EmitContext context, PropertyReferenceDeclaration reference) Returns the type annotations to attach to the reference.
List<MethodDeclaration>	getMethods(EmitContext context, ModelDeclaration model) Returns the method declarations to mixin to the model.
List<Annotation>	getTypeAnnotations(EmitContext context, ModelDeclaration model) Returns the type annotations to attach to the model.

Methods inherited from class java.lang.Object

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

Constructor Detail

JavaDataModelDriver

public JavaDataModelDriver()

Method Detail

generateResources

public void generateResources(EmitContext context,
                              ModelDeclaration model)
                       throws IOException

Generates any resources (includes source programs) for the model. This will be invoked once for each model.

Parameters:

context - the attached context

model - target model

Throws:

IOException - if failed to generate resources

Since:

0.2.2

getInterfaces

public List<Type> getInterfaces(EmitContext context,
                                ModelDeclaration model)
                         throws IOException

Returns the interface types to implement to the model.

Parameters:

context - the attached context

model - target model

Returns:

the list of interface types

Throws:

IOException - if failed to create other models

getFields

public List<FieldDeclaration> getFields(EmitContext context,
                                        ModelDeclaration model)
                                 throws IOException

Returns the field declarations to mixin to the model.

Parameters:

context - the attached context

model - target model

Returns:

the list of field declarations

Throws:

IOException - if failed to create other models

Since:

0.2.3

getMethods

public List<MethodDeclaration> getMethods(EmitContext context,
                                          ModelDeclaration model)
                                   throws IOException

Returns the method declarations to mixin to the model.

Parameters:

context - the attached context

model - target model

Returns:

the list of method declarations

Throws:

IOException - if failed to create other models

getTypeAnnotations

public List<Annotation> getTypeAnnotations(EmitContext context,
                                           ModelDeclaration model)
                                    throws IOException

Returns the type annotations to attach to the model.

Parameters:

context - the attached context

model - target model

Returns:

the list of annotations

Throws:

IOException - if failed to create other models

getMemberAnnotations

public List<Annotation> getMemberAnnotations(EmitContext context,
                                             PropertyDeclaration property)
                                      throws IOException

Returns the type annotations to attach to the property.

Parameters:

context - the attached context

property - target property

Returns:

the list of annotations

Throws:

IOException - if failed to create other models

getMemberAnnotations

public List<Annotation> getMemberAnnotations(EmitContext context,
                                             PropertyReferenceDeclaration reference)
                                      throws IOException

Returns the type annotations to attach to the reference.

Parameters:

context - the attached context

reference - target reference

Returns:

the list of annotations

Throws:

IOException - if failed to create other models

Since:

0.9.2