uk.ac.cam.caret.sakai.rwiki.tool.bean

Class GenericDiffBean

java.lang.Object

uk.ac.cam.caret.sakai.rwiki.tool.bean.GenericDiffBean

public class GenericDiffBean
extends Object

Bean Helper class that for creating diffs. Line endings for the left and right content are both normalized to Unix Line endings by the simple regular expression replace "\r\n?" with "\n"

Version:

$Id: GenericDiffBean.java 7664 2006-04-12 15:27:23Z ian@caret.cam.ac.uk $

Author:

andrew

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GenericDiffBean.ColorDiffRevisionVisitor RevisionVisitor that will generate a listed diff view Notes: Each line is given it's own div.
class	GenericDiffBean.ColorDiffTableRevisionVisitor RevisionVisitor that will generate rows for a diff table.

Constructor Summary

Constructors

Constructor and Description
GenericDiffBean()
GenericDiffBean(String leftContent, String rightContent) Create a GenericDiffBean for the given left and right content

Method Summary

Methods

Modifier and Type	Method and Description
String	getColorDiffString() Creates a string containing XHTML representing the differences between the left and right revision contents.
String	getColorDiffTable() Creates the rows for an XHTML table representing the differences between the left and right revision contents.
org.apache.commons.jrcs.diff.Revision	getDifference() Gets a JRCS Revision representing the difference between the left and right content
String	getLeftContent() Get the left content
String	getRightContent() Gets the right content
String	getUnixDiffString() Gets the difference between the left and right as a Unix Diff
void	init() initialise the bean.
void	setLeftContent(String leftContent) Sets the left content i.e. the old content.
void	setRightContent(String rightContent) Sets the right content i.e. the new content

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericDiffBean

public GenericDiffBean(String leftContent,
               String rightContent)

Create a GenericDiffBean for the given left and right content

Parameters:

leftContent - the left content i.e. the old content

rightContent - the right content i.e. the new content

GenericDiffBean

public GenericDiffBean()

Method Detail

init

public void init()

initialise the bean. To be called after the leftContent and rightContent have been set.

getColorDiffTable

public String getColorDiffTable()

Creates the rows for an XHTML table representing the differences between the left and right revision contents. This table is created using ColorDiffTableRevisionVisitor

Returns:

String representing rows of an XHTML table

See Also:

GenericDiffBean.ColorDiffTableRevisionVisitor

getColorDiffString

public String getColorDiffString()

Creates a string containing XHTML representing the differences between the left and right revision contents. This method uses the ColorDiffRevisionVisitor

Returns:

String representation of XHTML div

See Also:

GenericDiffBean.ColorDiffRevisionVisitor

getUnixDiffString

public String getUnixDiffString()

Gets the difference between the left and right as a Unix Diff

Returns:

String representing the unix diff

getLeftContent

public String getLeftContent()

Get the left content

Returns:

the left content (with normalized line endings)

setLeftContent

public void setLeftContent(String leftContent)

Sets the left content i.e. the old content.

Parameters:

leftContent - A non null string representing the left content

getRightContent

public String getRightContent()

Gets the right content

Returns:

the right content (with normalized line endings)

setRightContent

public void setRightContent(String rightContent)

Sets the right content i.e. the new content

Parameters:

rightContent - A non null string representing the right content

getDifference

public org.apache.commons.jrcs.diff.Revision getDifference()

Gets a JRCS Revision representing the difference between the left and right content

Returns:

non-null Revision (if init has been called)