org.pentaho.aggdes.output

Interface OutputService

All Known Implementing Classes:

OutputServiceImpl

public interface OutputService

The output service API defines how a client tool interacts with the output service layer. This includes creating outputs, and also generating full artifacts. An example of an output is the create table script. This script is created by the service layer and returned to the UI layer for rendering. When the DBA is ready to generate the full create table script, a call into getFullArtifact() is done.

Method Summary

Methods

Modifier and Type	Method and Description
Output	generateDefaultOutput(Aggregate aggregate) Returns an output of a specific type for an aggregate.
String	getArtifact(Output output, Class<? extends ArtifactGenerator> artifactGenerator) returns the artifact of an output.
String	getFullArtifact(List<? extends Output> outputs, Class<? extends ArtifactGenerator> artifactGenerator) returns the full artifact of a list of outputs of a single output type.
Class[]	getSupportedArtifactGeneratorClasses() returns a list of supported artifact generator classes that the output service supports.
void	init(Schema schema) set the state of this service (eventually this service will be stateless, but for now..)

Method Detail

generateDefaultOutput

Output generateDefaultOutput(Aggregate aggregate)
                             throws OutputValidationException

Returns an output of a specific type for an aggregate.

Note that in the future this call may require additional parameters, to override the default behavior.

Parameters:

aggregate - aggregate object

outputType -

Throws:

OutputValidationException

getSupportedArtifactGeneratorClasses

Class[] getSupportedArtifactGeneratorClasses()

returns a list of supported artifact generator classes that the output service supports.

Returns:

list of artifact generator classes supported.

getArtifact

String getArtifact(Output output,
                 Class<? extends ArtifactGenerator> artifactGenerator)
                   throws OutputValidationException

returns the artifact of an output. This should be called if output attributes have changed.

Parameters:

output - output object

Returns:

artifact string

Throws:

OutputValidationException

getFullArtifact

String getFullArtifact(List<? extends Output> outputs,
                     Class<? extends ArtifactGenerator> artifactGenerator)
                       throws OutputValidationException

returns the full artifact of a list of outputs of a single output type.

Parameters:

outputs - a list of outputs

Returns:

artifact string

Throws:

OutputValidationException

init

void init(Schema schema)

set the state of this service (eventually this service will be stateless, but for now..)

Parameters:

schema - olap schema