org.pentaho.aggdes.output

Interface ArtifactGenerator

All Known Subinterfaces:

CreateScriptGenerator, PopulateScriptGenerator, SchemaGenerator

All Known Implementing Classes:

AbstractGenerator, CreateTableGenerator, MondrianSchemaGenerator, PopulateTableGenerator

public interface ArtifactGenerator

Artifact Generators generate outputs such as DDL, DML, or Schema snippits based on Output Java beans. Artifact Generators should register with the OutputService.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canGenerate(Schema schema, Output output) returns true if the output implementation is fully compatible with this artifact generator
String	generate(Schema schema, Output output) this method gets called by the output service only if output is supported and canGenerate returns true
String	generateFull(Schema schema, List<? extends Output> outputs) this method generates a full output of an artifact, which may include additional items not found in the individual outputs.
Class[]	getSupportedOutputClasses() returns a list of supported output classes that this generator can render

Method Detail

getSupportedOutputClasses

Class[] getSupportedOutputClasses()

returns a list of supported output classes that this generator can render

Returns:

a list of class objects

canGenerate

boolean canGenerate(Schema schema,
                  Output output)

returns true if the output implementation is fully compatible with this artifact generator

Parameters:

schema - schema object

output - output object

Returns:

true if compatible

generate

String generate(Schema schema,
              Output output)

this method gets called by the output service only if output is supported and canGenerate returns true

Parameters:

schema - schema object

output - output object

Returns:

artifact

generateFull

String generateFull(Schema schema,
                  List<? extends Output> outputs)

this method generates a full output of an artifact, which may include additional items not found in the individual outputs.

Parameters:

schema - schema object

outputs - list of outputs

Returns:

string