org.apache.cocoon.components.language.markup
Interface MarkupLanguage

All Superinterfaces:

org.apache.avalon.framework.component.Component

All Known Implementing Classes:

AbstractMarkupLanguage

public interface MarkupLanguage

extends org.apache.avalon.framework.component.Component

This interface defines a markup language whose SAX producer's instance are to be translated into an executable program capable or transforming the original document augmenting it with dynamic content

Version:

CVS $Id: MarkupLanguage.java,v 1.5 2002/02/22 07:00:08 cziegeler Exp $

Author:

Ricardo Rocha

Field Summary

static java.lang.String

ROLE

Method Summary

java.lang.String	generateCode(org.xml.sax.InputSource input, java.lang.String filename, ProgrammingLanguage programmingLanguage, SourceResolver resolver) Generate source code from the input source for the target ProgrammingLanguage.
java.lang.String	getEncoding() Return the input document's encoding or null if it is the platform's default encoding.

Field Detail

ROLE

public static final java.lang.String ROLE

Method Detail

getEncoding

public java.lang.String getEncoding()

Return the input document's encoding or null if it is the platform's default encoding. This method should be called after generateCode method.

Returns:

The input document's encoding

generateCode

public java.lang.String generateCode(org.xml.sax.InputSource input,
                                     java.lang.String filename,
                                     ProgrammingLanguage programmingLanguage,
                                     SourceResolver resolver)
                              throws java.lang.Exception

Generate source code from the input source for the target ProgrammingLanguage.

Parameters:

input - The input source document

filename - The input document's original filename

programmingLanguage - The target programming language

Returns:

The generated source code

Throws:

java.lang.Exception - If an error occurs during code generation