org.carewebframework.maven.plugin.help.chm

Class BaseTransform

java.lang.Object

org.carewebframework.maven.plugin.transform.AbstractTransform

org.carewebframework.maven.plugin.help.chm.BaseTransform

Direct Known Subclasses:

BinaryTransform, ViewTransform

public abstract class BaseTransform
extends AbstractTransform

Extracts the topic tree from a view, converting from window-1252 to UTF-8 encoding and restructuring to create a more easily parsed format.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Charset	CS_UTF8
protected static Charset	CS_WIN1252
protected String	type
protected static String	UTF8
protected static String	WIN1252

Fields inherited from class org.carewebframework.maven.plugin.transform.AbstractTransform

mojo

Constructor Summary

Constructors

Constructor and Description
BaseTransform(BaseMojo mojo, String type)

Method Summary

Modifier and Type	Method and Description
protected String	extractAttribute(String name, String line) Extracts the value of the named attribute.
String	getTargetPath(IResource resource) Renames the source files.
void	transform(IResource resource, OutputStream outputStream)
protected void	write(OutputStream outputStream, String data) Write data to the output stream without any special formatting.
protected void	write(OutputStream outputStream, String data, boolean terminate, int level) Write data to the output stream with the specified formatting.
protected void	writeAttribute(OutputStream outputStream, String name, String value) Write the attribute's name/value pair to the output stream.
protected void	writeSetting(OutputStream outputStream, String name, Object value, int level) Writes a setting's name/value pair to the output stream.

Methods inherited from class org.carewebframework.maven.plugin.transform.AbstractTransform

transform

Methods inherited from class java.lang.Object

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

Field Detail

UTF8

protected static final String UTF8

See Also:

Constant Field Values

CS_UTF8

protected static final Charset CS_UTF8

WIN1252

protected static final String WIN1252

See Also:

Constant Field Values

CS_WIN1252

protected static final Charset CS_WIN1252

type

protected final String type

Constructor Detail

BaseTransform

public BaseTransform(BaseMojo mojo,
                     String type)

Method Detail

getTargetPath

public String getTargetPath(IResource resource)

Renames the source files.

Overrides:

getTargetPath in class AbstractTransform

transform

public void transform(IResource resource,
                      OutputStream outputStream)
               throws Exception

Overrides:

transform in class AbstractTransform

Throws:

Exception

extractAttribute

protected String extractAttribute(String name,
                                  String line)

Extracts the value of the named attribute.

Parameters:

name - The attribute name.

line - The source line.

Returns:

The attribute value, or null if not found.

writeAttribute

protected void writeAttribute(OutputStream outputStream,
                              String name,
                              String value)

Write the attribute's name/value pair to the output stream.

Parameters:

outputStream - The output stream.

name - The attribute name.

value - The attribute value.

writeSetting

protected void writeSetting(OutputStream outputStream,
                            String name,
                            Object value,
                            int level)
                     throws IOException

Writes a setting's name/value pair to the output stream.

Parameters:

outputStream - The output stream.

name - The setting name.

value - The setting value.

level - The indent level.

Throws:

IOException - Exception while writing to the output stream.

write

protected void write(OutputStream outputStream,
                     String data)

Write data to the output stream without any special formatting.

Parameters:

outputStream - The output stream.

data - The data to write.

write

protected void write(OutputStream outputStream,
                     String data,
                     boolean terminate,
                     int level)

Write data to the output stream with the specified formatting.

Parameters:

outputStream - The output stream.

data - The data to write.

terminate - If true, add a line terminator.

level - The indent level.