org.apache.batik.transcoder
Interface Transcoder

All Known Implementing Classes:
AbstractTranscoder

public interface Transcoder

Provides a way to transcode an input stream or a document.


Method Summary
 void addTranscodingHint(TranscodingHints.Key key, java.lang.Object value)
          Sets the value of a single preference for the transcoding algorithms.
 java.lang.String getMimeType()
          Returns the mime type of the ouput format of this transcoder.
 TranscodingHints getTranscodingHints()
          Returns the transcoding hints of this transcoder.
 void setTranscodingHints(java.util.Map hints)
          Replaces the values of all preferences for the transcoding algorithms with the specified hints.
 void transcodeToStream(Document document, java.io.OutputStream ostream)
          Transcodes the specified document and write the result to the specified output.
 void transcodeToStream(InputSource isource, java.io.OutputStream ostream)
          Transcodes the specified input and write the result to the specified output.
 

Method Detail

transcodeToStream

public void transcodeToStream(InputSource isource,
                              java.io.OutputStream ostream)
                       throws TranscoderException
Transcodes the specified input and write the result to the specified output.
Parameters:
isource - the input to transcode
ostream - the ouput stream where to write the transcoded input
Throws:
TranscoderException - if an error occured while transcoding

transcodeToStream

public void transcodeToStream(Document document,
                              java.io.OutputStream ostream)
                       throws TranscoderException
Transcodes the specified document and write the result to the specified output.
Parameters:
document - the document to transcode
ostream - the ouput stream where to write the transcoded input
Throws:
TranscoderException - if an error occured while transcoding

getTranscodingHints

public TranscodingHints getTranscodingHints()
Returns the transcoding hints of this transcoder.

addTranscodingHint

public void addTranscodingHint(TranscodingHints.Key key,
                               java.lang.Object value)
Sets the value of a single preference for the transcoding algorithms.
Parameters:
key - the key of the hint to be set
value - the value indicating preferences for the specified hint category.

setTranscodingHints

public void setTranscodingHints(java.util.Map hints)
Replaces the values of all preferences for the transcoding algorithms with the specified hints.
Parameters:
hints - the rendering hints to be set

getMimeType

public java.lang.String getMimeType()
Returns the mime type of the ouput format of this transcoder.


Copyright © 2000 Apache Software Foundation. All Rights Reserved.