com.google.enterprise.adaptor

Class ContentTransform

java.lang.Object

java.io.OutputStream

com.google.enterprise.adaptor.ContentTransform

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class ContentTransform
extends OutputStream

The document content transform can modify the content of a document.

Author:

Dominik Weidenfeld (dominik.weidenfeld@twt.de)

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	config
protected String	contentType
protected Metadata	metadata

Constructor Summary

Constructors

Constructor and Description
ContentTransform(Map<String,String> config, Metadata metadata, String contentType, OutputStream originalStream) Constructs a document content transform.

Method Summary

Modifier and Type	Method and Description
void	close()
void	flush()
static String	getContentTypeOutputForContentTypeInput(String ctIn) Specify the transformation in ContentType, where applicable.
String	toString()
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

config

protected final Map<String,String> config

metadata

protected final Metadata metadata

contentType

protected final String contentType

Constructor Detail

ContentTransform

public ContentTransform(Map<String,String> config,
                        Metadata metadata,
                        String contentType,
                        OutputStream originalStream)

Constructs a document content transform.

Parameters:

config - the configuration for this instance

metadata - the unchangeable metadata

contentType - the input content-type

originalStream - the original stream to put the final content in

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

toString

public final String toString()

Overrides:

toString in class Object

getContentTypeOutputForContentTypeInput

public static String getContentTypeOutputForContentTypeInput(String ctIn)

Specify the transformation in ContentType, where applicable. Because this is a static function, subclasses may *hide* this method by writing another method with the same signature, but make sure not to use the @Override declaration, because Java will flag that as an error.

Parameters:

ctIn - input ContentType of the Transformation step.

Returns:

output ContentType of the Transformation step.