org.activemath.util.OMconverters
Interface OMConverter

All Known Implementing Classes:
OMConvertByStylesheet

public interface OMConverter

Interface OMConverter

Provides a collection of methods useful to be provided in every converter

Version:
1.0

Method Summary
 String convert(InputStream input)
          Convert content provided by an InputStream returning to a String
 String convert(String inputString)
          Convert content provided by a String returning to a String
 String convertFromMBase(MBaseRef mbaseRef, MBaseID id)
          Convert content provided by MBase returning to a String
 void convertStreams(InputStream input, OutputStream output)
          Convert content provided by an InputStream returning to an OutputStream
 

Method Detail

convertStreams

void convertStreams(InputStream input,
                    OutputStream output)
                    throws OMConvertException
Convert content provided by an InputStream returning to an OutputStream

Parameters:
input - the InputStream
output - the OutputStream
Throws:
OMConvertException

convert

String convert(InputStream input)
               throws OMConvertException
Convert content provided by an InputStream returning to a String

Parameters:
input - the InputStream
Returns:
the converted data as String
Throws:
OMConvertException

convert

String convert(String inputString)
               throws OMConvertException
Convert content provided by a String returning to a String

Parameters:
inputString - the input data as InputString
Returns:
the converted data as String
Throws:
OMConvertException

convertFromMBase

String convertFromMBase(MBaseRef mbaseRef,
                        MBaseID id)
                        throws OMConvertException
Convert content provided by MBase returning to a String

Parameters:
mbaseRef - the reference to an existing MBase
id - the id (key) of content to convert from MBase
Returns:
the converted data as String
Throws:
OMConvertException