org.ginsim.common.document

Class DocumentWriter

java.lang.Object

org.ginsim.common.document.DocumentWriter

Direct Known Subclasses:

LaTeXDocumentWriter, OOoDocumentWriter, WikiDocumentWriter, XHTMLDocumentWriter

public abstract class DocumentWriter
extends Object

DocumentWriter is an abstract class designed to help writing documents. It contains all the methods to define the structure of a document such as startDocument, openParagraph...
To write a document, you must call startDocument() first. Then build the structure of the document using the openXXX or addXXX methods. End the document with close()

The openXXX and closeXXX deals with the tree structure of the document and call the corresponding doXXX methods.
The doXXX methods are implemented in the DocumentWriter's subclass and must write the structure in the document.
For example, openHeader make sure we are at the "out" level in the document's tree then it calls doOpenHeader which must write the header itself

DocumentProperties :

The protected instance variable documentProperties is a Map of properties (meta) that contains some informations about the document such as the title, the authors...
There is a list of class constants beginning with META_* for commonly used properties
They must be declared before the startDocument()

There is 3 methods to manipulate documentProperties :

• setDocumentProperty(Object name, Object value) to define a new property
• setDocumentProperties(Map map) to define multiple properties
• setDocumentProperties(Object[] table) to define multiple properties [name, value, name, value...]

DocumentExtras :

DocumentExtra is a concept to allow to define content for a specific type of document.
A documentExtra is a StringBuffer containing the content.
documentExtras is a map of documentExtra with a key representing the id of the extra

When you implement a DocumentWriter subclass, you should register for the extra you are able to use

When you use a DocumentWriter subclass, if you want to add specific content, first test if the document support the extra, if it does get the documentExtra and append it your content.

There is 3 methods to manipulate documentExtras :

• registerForDocumentExtra(String extra) register the document for an extra
• getDocumentExtra(String extra) to get an extra
• doesDocumentSupportExtra(String extra) to know if the current document support the extra

DocumentStyles :

Allow you to set the style for the document.
They must be declared before the startDocument()

There is 2 methods to manipulate documentStyles :

• getStyles() get the styles of the document
• setStyles(DocumentStyle newStyle) define anotherStyle for the document

New lines

To append a generic new line, use the newLine() function.
When you subclass DocumentWriter, you can overwrite newLine() or simply set a new value for the NEW_LINE variable.

Author:

Aurelien Naldi, Duncan Berenguier

See Also:

DocumentStyle

Field Summary

Fields

Modifier and Type	Field and Description
protected String	dirPrefix
protected Map	documentProperties
protected DocumentStyle	documentStyles
static String	META_AUTHOR
static String	META_DATE
static String	META_DESCRIPTION
static String	META_GENERATOR
static String	META_KEYWORDS
static String	META_TITLE
String	NEW_LINE
protected OutputStream	output
protected File	outputDir
protected org.ginsim.common.document.DocumentPos	pos
static int	POS_HEADER
static int	POS_LIST
static int	POS_LIST_ITEM
static int	POS_OUT
static int	POS_PARAGRAPH
static int	POS_TABLE
static int	POS_TABLE_CELL
static int	POS_TABLE_ROW
static String	PROP_SUBDOCUMENT

Constructor Summary

Constructors

Constructor and Description
DocumentWriter()

Method Summary

Modifier and Type	Method and Description
void	addAnchor(String name, String content) add a new anchor into the document.
void	addImage(BufferedImage img, String name)
void	addLink(String href, String content) add a new link into the document.
void	addTableRow(String[] t_content) Open a new table row and new table cells with the content of the array
void	close() Close every element open then close the document
void	closeList() Close a list.
void	closeListItem() Close a list item.
void	closeParagraph() Close a paragraph
void	closeTable() Close a table
void	closeTableCell() Close a table cell
void	closeTableRow() Close a table row
protected void	closeUntil(int targetpos) Close every opened element until we are in the correct position in the tree
protected abstract void	doAddAnchor(String name, String content)
protected abstract void	doAddImage(BufferedImage img, String name)
protected abstract void	doAddLink(String href, String content)
protected abstract void	doCloseDocument()
protected abstract void	doCloseList()
protected abstract void	doCloseListItem()
protected abstract void	doCloseParagraph()
protected abstract void	doCloseTable()
protected abstract void	doCloseTableCell()
protected abstract void	doCloseTableRow()
boolean	doesDocumentSupportExtra(String extra) Indicate if the current document support a specific extra
protected abstract void	doOpenHeader(int level, String content, String style)
protected abstract void	doOpenList(String style, boolean isNumbered)
protected abstract void	doOpenListItem()
protected abstract void	doOpenParagraph(String style)
protected abstract void	doOpenTable(String name, String style, String[] t_colStyle)
protected abstract void	doOpenTableCell(int colspan, int rowspan, boolean header, String style)
protected abstract void	doOpenTableRow(String style)
protected abstract void	doWriteText(String text, boolean newLine)
protected void	ensureParagraph() Open a new paragraph if we are in a paragraph.
StringBuffer	getDocumentExtra(String extra) Get a documentExtra
DocumentStyle	getStyles() Get the styles of the document, and initialize them if needed.
protected String	newLine()
void	newParagraph() Open a paragraph without a style
void	openHeader(int level, String content, String style) Open a new header.
void	openList(String style) Open a list element with a specific style A list is made of ListItems
void	openList(String style, boolean isNumbered)
void	openListItem(String content) Open a new list item and write the content in.
void	openParagraph(String style) Open a paragraph with a style
void	openTable(String name, String style, String[] t_colStyle) Open a new table.
void	openTableCell(int colspan, int rowspan, String content) Open a new cell in the current table row
void	openTableCell(int colspan, int rowspan, String content, boolean header) Open a new cell in the current table row
void	openTableCell(int colspan, int rowspan, String content, String cl, boolean header)
void	openTableCell(String content) Open a new cell in the current table row with 1 colspan and rowspan
void	openTableCell(String content, boolean header)
void	openTableRow() Open a new row in the current table.
void	openTableRow(String style) Open a new row in the current table.
protected void	registerForDocumentExtra(String extra) Register the current document for extra (initialize the StringBuffer)
void	setDocumentProperties(Map map) Add a map of properties to the document.
void	setDocumentProperties(Object[] table) Add an array of properties to the document
void	setDocumentProperty(Object name, Object value) Set a property for the document.
void	setOutput(File file)
void	setOutput(OutputStream output)
DocumentStyle	setStyles(DocumentStyle newStyle) Define a new DocumentStyle for the document
abstract void	startDocument()
void	writeText(String text) Write the text into the current opened element.
void	writeTextln(String text) Write the text into the current opened element and append a new line at the end.

Methods inherited from class java.lang.Object

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

Field Detail

POS_OUT

public static final int POS_OUT

See Also:

Constant Field Values

POS_PARAGRAPH

public static final int POS_PARAGRAPH

See Also:

Constant Field Values

POS_HEADER

public static final int POS_HEADER

See Also:

Constant Field Values

POS_TABLE

public static final int POS_TABLE

See Also:

Constant Field Values

POS_TABLE_ROW

public static final int POS_TABLE_ROW

See Also:

Constant Field Values

POS_TABLE_CELL

public static final int POS_TABLE_CELL

See Also:

Constant Field Values

POS_LIST

public static final int POS_LIST

See Also:

Constant Field Values

POS_LIST_ITEM

public static final int POS_LIST_ITEM

See Also:

Constant Field Values

META_TITLE

public static final String META_TITLE

See Also:

Constant Field Values

META_AUTHOR

public static final String META_AUTHOR

See Also:

Constant Field Values

META_DATE

public static final String META_DATE

See Also:

Constant Field Values

META_KEYWORDS

public static final String META_KEYWORDS

See Also:

Constant Field Values

META_DESCRIPTION

public static final String META_DESCRIPTION

See Also:

Constant Field Values

META_GENERATOR

public static final String META_GENERATOR

See Also:

Constant Field Values

PROP_SUBDOCUMENT

public static final String PROP_SUBDOCUMENT

See Also:

Constant Field Values

NEW_LINE

public String NEW_LINE

pos

protected org.ginsim.common.document.DocumentPos pos

documentProperties

protected Map documentProperties

documentStyles

protected DocumentStyle documentStyles

output

protected OutputStream output

outputDir

protected File outputDir

dirPrefix

protected String dirPrefix

Constructor Detail

DocumentWriter

public DocumentWriter()

Method Detail

setOutput

public void setOutput(OutputStream output)

setOutput

public void setOutput(File file)
               throws FileNotFoundException

Throws:

FileNotFoundException

startDocument

public abstract void startDocument()
                            throws IOException

Throws:

IOException

openParagraph

public void openParagraph(String style)
                   throws IOException

Open a paragraph with a style

Parameters:

style -

Throws:

IOException

newParagraph

public void newParagraph()
                  throws IOException

Open a paragraph without a style

Throws:

IOException

closeParagraph

public void closeParagraph()
                    throws IOException

Close a paragraph

Throws:

IOException

openHeader

public void openHeader(int level,
                       String content,
                       String style)
                throws IOException

Open a new header. Note the header can't be in another element.

Parameters:

level - The header's level (1 = section, 2 = subsection, 3 = subsubsection...)

content -

style -

Throws:

IOException

addLink

public void addLink(String href,
                    String content)
             throws IOException

add a new link into the document.

Parameters:

href - the link's location (URI)

content - the link's description

Throws:

IOException

addAnchor

public void addAnchor(String name,
                      String content)
               throws IOException

add a new anchor into the document.

Parameters:

name - the anchors location (URI)

content - the anchors description

Throws:

IOException

openTable

public void openTable(String name,
                      String style,
                      String[] t_colStyle)
               throws IOException

Open a new table. A table is made of table rows

Parameters:

name -

style -

t_colStyle - a style for each column of the table. You must set the style, even if you do not use it. (use new String[] {"" , ""...} if you didn't want any style)

Throws:

IOException

openTableRow

public void openTableRow()
                  throws IOException

Open a new row in the current table. A row is made of table cells

Throws:

IOException

openTableRow

public void openTableRow(String style)
                  throws IOException

Open a new row in the current table. A row is made of table cells

Parameters:

style - TODO

Throws:

IOException

openTableCell

public void openTableCell(int colspan,
                          int rowspan,
                          String content)
                   throws IOException

Open a new cell in the current table row

Parameters:

colspan - the number of column to collapse together.

rowspan - the number of rows to collapse together.

content - the cell's content

Throws:

IOException

openTableCell

public void openTableCell(int colspan,
                          int rowspan,
                          String content,
                          boolean header)
                   throws IOException

Open a new cell in the current table row

Parameters:

colspan - the number of column to collapse together.

rowspan - the number of rows to collapse together.

content - the cell's content

header - if true the cell is an header

Throws:

IOException

openTableCell

public void openTableCell(int colspan,
                          int rowspan,
                          String content,
                          String cl,
                          boolean header)
                   throws IOException

Throws:

IOException

openTableCell

public void openTableCell(String content)
                   throws IOException

Open a new cell in the current table row with 1 colspan and rowspan

Parameters:

content - the cell's content

Throws:

IOException

addTableRow

public void addTableRow(String[] t_content)
                 throws IOException

Open a new table row and new table cells with the content of the array

Parameters:

t_content - the content for the cells

Throws:

IOException

closeTableCell

public void closeTableCell()
                    throws IOException

Close a table cell

Throws:

IOException

closeTableRow

public void closeTableRow()
                   throws IOException

Close a table row

Throws:

IOException

closeTable

public void closeTable()
                throws IOException

Close a table

Throws:

IOException

openList

public void openList(String style)
              throws IOException

Open a list element with a specific style A list is made of ListItems

Parameters:

style -

Throws:

IOException

openList

public void openList(String style,
                     boolean isNumbered)
              throws IOException

Throws:

IOException

openListItem

public void openListItem(String content)
                  throws IOException

Open a new list item and write the content in. You must be in a List to open list items. It close automatically previously opened list item.

Parameters:

content -

Throws:

IOException

closeListItem

public void closeListItem()
                   throws IOException

Close a list item.

Throws:

IOException

closeList

public void closeList()
               throws IOException

Close a list.

Throws:

IOException

writeText

public void writeText(String text)
               throws IOException

Write the text into the current opened element.

Parameters:

text - the text to write

Throws:

IOException

writeTextln

public void writeTextln(String text)
                 throws IOException

Write the text into the current opened element and append a new line at the end.

Parameters:

text - the text to write

Throws:

IOException

close

public void close()
           throws IOException

Close every element open then close the document

Throws:

IOException

addImage

public void addImage(BufferedImage img,
                     String name)
              throws IOException

Throws:

IOException

doOpenParagraph

protected abstract void doOpenParagraph(String style)
                                 throws IOException

Throws:

IOException

doCloseParagraph

protected abstract void doCloseParagraph()
                                  throws IOException

Throws:

IOException

doWriteText

protected abstract void doWriteText(String text,
                                    boolean newLine)
                             throws IOException

Throws:

IOException

doOpenTable

protected abstract void doOpenTable(String name,
                                    String style,
                                    String[] t_colStyle)
                             throws IOException

Throws:

IOException

doCloseTable

protected abstract void doCloseTable()
                              throws IOException

Throws:

IOException

doCloseTableRow

protected abstract void doCloseTableRow()
                                 throws IOException

Throws:

IOException

doCloseTableCell

protected abstract void doCloseTableCell()
                                  throws IOException

Throws:

IOException

doOpenTableRow

protected abstract void doOpenTableRow(String style)
                                throws IOException

Throws:

IOException

doOpenTableCell

protected abstract void doOpenTableCell(int colspan,
                                        int rowspan,
                                        boolean header,
                                        String style)
                                 throws IOException

Throws:

IOException

doCloseDocument

protected abstract void doCloseDocument()
                                 throws IOException

Throws:

IOException

doOpenHeader

protected abstract void doOpenHeader(int level,
                                     String content,
                                     String style)
                              throws IOException

Throws:

IOException

doAddLink

protected abstract void doAddLink(String href,
                                  String content)
                           throws IOException

Throws:

IOException

doAddAnchor

protected abstract void doAddAnchor(String name,
                                    String content)
                             throws IOException

Throws:

IOException

doAddImage

protected abstract void doAddImage(BufferedImage img,
                                   String name)
                            throws IOException

Throws:

IOException

doOpenList

protected abstract void doOpenList(String style,
                                   boolean isNumbered)
                            throws IOException

Throws:

IOException

doOpenListItem

protected abstract void doOpenListItem()
                                throws IOException

Throws:

IOException

doCloseListItem

protected abstract void doCloseListItem()
                                 throws IOException

Throws:

IOException

doCloseList

protected abstract void doCloseList()
                             throws IOException

Throws:

IOException

newLine

protected String newLine()

setDocumentProperty

public void setDocumentProperty(Object name,
                                Object value)

Set a property for the document.

Parameters:

name - the name of the property (use 'META' constant if possible)

value - the value of the property

setDocumentProperties

public void setDocumentProperties(Map map)

Add a map of properties to the document.

Parameters:

map - the map of properties

setDocumentProperties

public void setDocumentProperties(Object[] table)
                           throws ArrayIndexOutOfBoundsException

Add an array of properties to the document

Parameters:

table - A table that alternate the name then the value of properties

Throws:

ArrayIndexOutOfBoundsException - if there is not the same number of name and values.

registerForDocumentExtra

protected void registerForDocumentExtra(String extra)

Register the current document for extra (initialize the StringBuffer)

Parameters:

extra - The name of the extra to create

getDocumentExtra

public StringBuffer getDocumentExtra(String extra)

Get a documentExtra

Parameters:

extra - The name of the extra to get

Returns:

the document extra

doesDocumentSupportExtra

public boolean doesDocumentSupportExtra(String extra)

Indicate if the current document support a specific extra

Parameters:

extra - The name of the extra

Returns:

true if the document support the specified extra

getStyles

public DocumentStyle getStyles()

Get the styles of the document, and initialize them if needed.

Returns:

the document style

setStyles

public DocumentStyle setStyles(DocumentStyle newStyle)

Define a new DocumentStyle for the document

Parameters:

newStyle - the new Style

Returns:

the old style

ensureParagraph

protected void ensureParagraph()
                        throws IOException

Open a new paragraph if we are in a paragraph.

Throws:

IOException

closeUntil

protected void closeUntil(int targetpos)
                   throws IOException

Close every opened element until we are in the correct position in the tree

Parameters:

targetpos - the position

Throws:

IOException

openTableCell

public void openTableCell(String content,
                          boolean header)
                   throws IOException

Throws:

IOException