com.clarkparsia.owlapi.explanation.io.manchester

Class BlockWriter

java.lang.Object

java.io.Writer

java.io.PrintWriter

com.clarkparsia.owlapi.explanation.io.manchester.BlockWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

Direct Known Subclasses:

TextBlockWriter

public abstract class BlockWriter
extends PrintWriter

Title:

Description: A convenience class that wraps a PrinWriter instance to provide support for generating nicely aligned attribute. This class is geared towards textual outputs and is used for aligning the outputs in consecutive lines.

The idea is to create virtual blocks of output in a line (i.e. invisible tabbing points) and when a new line is printed tab the output with spaces (or some similar invisible character) to the last tabbing points. Alignment blocks are created in a LIFO fashion that is and you can only align w.r.t. latest block.

This class is an abstract class to provide some general functionality that can be reused in implementations that supports purely textual output or HTML output.

Copyright: Copyright (c) 2008

Company: Clark & Parsia, LLC.

Author:

Evren Sirin

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	newLine
protected String	pad

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
BlockWriter(Writer out, String pad)

Method Summary

Modifier and Type	Method and Description
abstract void	clearBlocks() Clear all the blocks previously defined.
abstract void	endBlock() Ends the current alignment block.
void	println()
abstract void	printSpace()
abstract void	startBlock() Start a new block for alignment.
protected abstract void	startNewLine() Do the preprocessing step required at the beginning of each line for alignment;
void	write(char[] buf, int off, int len)
void	write(int c)
void	write(String s, int off, int len)

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, setError, write, write

Methods inherited from class java.lang.Object

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

Field Detail

pad

protected String pad

newLine

protected boolean newLine

Constructor Detail

BlockWriter

public BlockWriter(Writer out,
                   String pad)

Parameters:

out -

Method Detail

startNewLine

protected abstract void startNewLine()

Do the preprocessing step required at the beginning of each line for alignment;

clearBlocks

public abstract void clearBlocks()

Clear all the blocks previously defined.

startBlock

public abstract void startBlock()

Start a new block for alignment. This will mark the current location in the current line as the point to be used for alignment next time a new line is printed. Previously defined alignment blocks will be inaccessible until this block is closed with a endBlock() call.

endBlock

public abstract void endBlock()
                       throws IllegalStateException

Ends the current alignment block. All subsequent lines will be aligned w.r.t. the previous block or not at all if there was no previous bloack.

Throws:

IllegalStateException - if there is no block previously created with a startBlock() call.

println

public void println()

Overrides:

println in class PrintWriter

write

public void write(int c)

Overrides:

write in class PrintWriter

write

public void write(char[] buf,
                  int off,
                  int len)

Overrides:

write in class PrintWriter

write

public void write(String s,
                  int off,
                  int len)

Overrides:

write in class PrintWriter

printSpace

public abstract void printSpace()