org.apache.cocoon.components.language.generator
Interface ProgramGenerator

All Superinterfaces:
org.apache.avalon.framework.component.Component
All Known Implementing Classes:
ProgramGeneratorImpl

public interface ProgramGenerator
extends org.apache.avalon.framework.component.Component

This interface defines a loader for programs automatically built from XML documents written in a MarkupLanguage

Version:
CVS $Id: ProgramGenerator.java,v 1.7.2.1 2002/09/21 02:13:20 vgritsenko Exp $
Author:
Ricardo Rocha

Field Summary
static java.lang.String ROLE
           
 
Method Summary
 CompiledComponent load(org.apache.avalon.framework.component.ComponentManager newManager, Source source, java.lang.String markupLanguage, java.lang.String programmingLanguage, SourceResolver resolver)
          Load a program built from an XML document written in a MarkupLanguage
 CompiledComponent load(org.apache.avalon.framework.component.ComponentManager newManager, java.lang.String fileName, java.lang.String markupLanguage, java.lang.String programmingLanguage, SourceResolver resolver)
          Deprecated. Pass Source object instead of file name.
 void release(CompiledComponent component)
          Release a program instance built from an XML document written in a MarkupLanguage.
 void remove(Source source)
          Remove a program from the generator's cache and dipose all instances of this program.
 

Field Detail

ROLE

public static final java.lang.String ROLE
See Also:
Constant Field Values
Method Detail

load

public CompiledComponent load(org.apache.avalon.framework.component.ComponentManager newManager,
                              java.lang.String fileName,
                              java.lang.String markupLanguage,
                              java.lang.String programmingLanguage,
                              SourceResolver resolver)
                       throws java.lang.Exception
Deprecated. Pass Source object instead of file name.

Load a program built from an XML document written in a MarkupLanguage

Parameters:
newManager - The ComponentManager that it will be loaded with
fileName - The input document's File name
markupLanguage - The MarkupLanguage in which the input document is written
programmingLanguage - The ProgrammingLanguage in which the program must be written
Returns:
The loaded object
Throws:
java.lang.Exception - If an error occurs during generation or loading

load

public CompiledComponent load(org.apache.avalon.framework.component.ComponentManager newManager,
                              Source source,
                              java.lang.String markupLanguage,
                              java.lang.String programmingLanguage,
                              SourceResolver resolver)
                       throws java.lang.Exception
Load a program built from an XML document written in a MarkupLanguage

Parameters:
newManager - The ComponentManager that it will be loaded with
source - The input document's File name
markupLanguage - The MarkupLanguage in which the input document is written
programmingLanguage - The ProgrammingLanguage in which the program must be written
Returns:
The loaded object
Throws:
java.lang.Exception - If an error occurs during generation or loading

release

public void release(CompiledComponent component)
Release a program instance built from an XML document written in a MarkupLanguage.

Parameters:
component - to be released.

remove

public void remove(Source source)
Remove a program from the generator's cache and dipose all instances of this program.

Parameters:
source - of the program to be removed.


Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.