net.sf.statcvs.renderer.xml
Class XMLTableRenderer

java.lang.Object
  extended by net.sf.statcvs.renderer.xml.XMLTableRenderer
All Implemented Interfaces:
TableCellRenderer

public class XMLTableRenderer
extends java.lang.Object
implements TableCellRenderer

Renders a Table to a JDOM XML element

Version:
$Id: XMLTableRenderer.java,v 1.1 2003/06/22 19:24:26 cyganiak Exp $
Author:
Richard Cyganiak

Constructor Summary
XMLTableRenderer(java.lang.String tableElementName, java.lang.String rowElementName)
          Constructor
 
Method Summary
static java.lang.String convertToXMLName(java.lang.String string)
          Tries to convert a String into an XML name, for example "Hello world!!!" to "helloWorld".
 org.jdom.Element getRenderedTable(Table table)
          Returns an XML element containing the table
 void renderAuthorCell(Author author)
          Render a cell containing an author
 void renderCell(java.lang.String content)
          Render a generic table cell
 void renderDirectoryCell(Directory directory)
          Render a cell containing a directory
 void renderEmptyCell()
          Render an empty cell
 void renderFileCell(CvsFile file, boolean withIcon)
          Render a cell containing a file
 void renderIntegerCell(int value)
          Render an integer cell
 void renderIntegerCell(int value, int total)
          Render an integer cell, showing both the integer value and a percentage of a total
 void renderPercentageCell(double ratio)
          Render a percentage cell
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XMLTableRenderer

public XMLTableRenderer(java.lang.String tableElementName,
                        java.lang.String rowElementName)
Constructor

Parameters:
tableElementName - the XML element name for the table
rowElementName - the XML element name for each row of the table
Method Detail

getRenderedTable

public org.jdom.Element getRenderedTable(Table table)
Returns an XML element containing the table

Parameters:
table - the table
Returns:
a JDOM element

convertToXMLName

public static java.lang.String convertToXMLName(java.lang.String string)
Tries to convert a String into an XML name, for example "Hello world!!!" to "helloWorld". If this doesn't succeed, null will be returned. For example, "123" can't be easily turned into an XML name because they must start with a letter.

Parameters:
string - any String
Returns:
an XML name similar to the string, or null

renderCell

public void renderCell(java.lang.String content)
Description copied from interface: TableCellRenderer
Render a generic table cell

Specified by:
renderCell in interface TableCellRenderer
Parameters:
content - the cell's content
See Also:
TableCellRenderer.renderCell(java.lang.String)

renderEmptyCell

public void renderEmptyCell()
Description copied from interface: TableCellRenderer
Render an empty cell

Specified by:
renderEmptyCell in interface TableCellRenderer
See Also:
TableCellRenderer.renderEmptyCell()

renderIntegerCell

public void renderIntegerCell(int value)
Description copied from interface: TableCellRenderer
Render an integer cell

Specified by:
renderIntegerCell in interface TableCellRenderer
Parameters:
value - the cell's content
See Also:
TableCellRenderer.renderIntegerCell(int)

renderIntegerCell

public void renderIntegerCell(int value,
                              int total)
Description copied from interface: TableCellRenderer
Render an integer cell, showing both the integer value and a percentage of a total

Specified by:
renderIntegerCell in interface TableCellRenderer
Parameters:
value - the cell's content
total - the total, worth 100%
See Also:
TableCellRenderer.renderIntegerCell(int, int)

renderPercentageCell

public void renderPercentageCell(double ratio)
Description copied from interface: TableCellRenderer
Render a percentage cell

Specified by:
renderPercentageCell in interface TableCellRenderer
Parameters:
ratio - the cell's content
See Also:
TableCellRenderer.renderPercentageCell(double)

renderAuthorCell

public void renderAuthorCell(Author author)
Description copied from interface: TableCellRenderer
Render a cell containing an author

Specified by:
renderAuthorCell in interface TableCellRenderer
Parameters:
author - the author
See Also:
TableCellRenderer.renderAuthorCell(net.sf.statcvs.model.Author)

renderDirectoryCell

public void renderDirectoryCell(Directory directory)
Description copied from interface: TableCellRenderer
Render a cell containing a directory

Specified by:
renderDirectoryCell in interface TableCellRenderer
Parameters:
directory - the directory
See Also:
TableCellRenderer.renderDirectoryCell(net.sf.statcvs.model.Directory)

renderFileCell

public void renderFileCell(CvsFile file,
                           boolean withIcon)
Description copied from interface: TableCellRenderer
Render a cell containing a file

Specified by:
renderFileCell in interface TableCellRenderer
Parameters:
file - the file
withIcon - display an icon in front of the filename?
See Also:
TableCellRenderer.renderFileCell(net.sf.statcvs.model.CvsFile, boolean)