org.sdmlib.storyboards

Class StoryboardImpl

java.lang.Object

org.sdmlib.storyboards.StoryboardImpl

All Implemented Interfaces:

de.uniks.networkparser.interfaces.SendableEntity, PropertyChangeInterface

public class StoryboardImpl
extends java.lang.Object
implements PropertyChangeInterface, de.uniks.networkparser.interfaces.SendableEntity

A Storyboard collects entries for the generation of an html page from e.g. a JUnit test. This html page will be named like the story, i.e. like the method that created the Storyboard. It will be added to the refs.html and thus become part of the index.html. All these html files are stored in an directory "doc" located in the project root directory.

See Also:

dumpHTML(), SDMLib Storyboards, ProjectBoard.java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StoryboardImpl.RestrictToFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTIVE
static java.lang.String	BACKLOG
static java.lang.String	DONE
static java.lang.String	IMPLEMENTATION
protected java.beans.PropertyChangeSupport	listeners
static java.lang.String	MODELING
static java.lang.String	PROPERTY_MODELROOTDIR
static java.lang.String	PROPERTY_ROOTDIR
static java.lang.String	PROPERTY_STEPCOUNTER
static java.lang.String	PROPERTY_STEPDONECOUNTER
static java.lang.String	PROPERTY_STORYBOARDSTEPS
static java.lang.String	PROPERTY_WALL

Constructor Summary

Constructors

Constructor and Description
StoryboardImpl()
StoryboardImpl(java.lang.String rootDir) Deprecated. Storyboards search for their root dir (like src or src/test/java) themself. Thus use the version without parameters.
StoryboardImpl(java.lang.String rootDir, java.lang.String name) Deprecated. Storyboards search for their root dir (like src or src/test/java) themself. Similarly, Storyboards get their name from the method they are used in. Name that method appropriately. Use the version without parameters.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String string)
void	addClassDiagram(ClassModel model) Add a class diagram to the generated html page.
void	addCode()
void	addCode(java.lang.String rootDir)
void	addGenericObjectDiag(GenericGraph graph)
void	addGenericObjectDiag(GenericGraph graph, GenericObjectSet hiddenObjects)
void	addGenericObjectDiag(java.lang.String diagramName, GenericGraph graph)
void	addGenericObjectDiag(java.lang.String diagramName, GenericGraph graph, GenericObjectSet hiddenObjects)
void	addImage(java.lang.String imageFile)
void	addObjectDiagram(java.lang.Object... elems)
void	addObjectDiagramWith(java.lang.Object... elems)
void	addPattern(Pattern pattern, boolean showMatch)
void	addPattern(PatternObject patternObject, boolean showMatch)
void	addPreformatted(java.lang.String expandedText)
boolean	addPropertyChangeListener(java.beans.PropertyChangeListener listener)
boolean	addPropertyChangeListener(java.lang.String propertyName, java.beans.PropertyChangeListener listener) Adds the property change listener.
void	addReferenceToJavaDoc(java.lang.String classUnderTestName, java.lang.String methodUnderTestName, java.lang.String testFileName)
StoryboardImpl	addStep(java.lang.String txt)
void	addTable(Table table)
void	addText(java.lang.String string)
boolean	addToStoryboardSteps(StoryboardStep value)
void	assertEquals(java.lang.String message, double expected, double actual, double delta)
void	assertEquals(java.lang.String message, int expected, int actual)
void	assertEquals(java.lang.String message, java.lang.Object expected, java.lang.Object actual)
void	assertFalse(java.lang.String message, boolean condition)
void	assertNotNull(java.lang.String message, java.lang.Object obj)
void	assertNull(java.lang.String message, java.lang.Object obj)
void	assertTrue(java.lang.String message, boolean condition)
void	coverage4GeneratedModelCode(java.lang.Object root)
void	coverSeldomModelMethods(de.uniks.networkparser.IdMap copyMap)
void	coverSetAndPOClasses(de.uniks.networkparser.IdMap copyMap)
StoryboardStep	createStoryboardSteps()
void	dumpDiagram(PatternObject<?,?> po, java.lang.String name)
void	dumpHTML() Generate an html page from this story.
java.lang.String	findRootDir()
GuiAdapter	getAdapter()
java.lang.String	getJavaTestFileName()
java.lang.String	getMethodText(java.lang.String rootDir, java.lang.String className, java.lang.String methodSignature)
java.lang.String	getModelRootDir()
java.lang.String	getName()
java.beans.PropertyChangeSupport	getPropertyChangeSupport() Get the propertyChangeSupport attribute of the PropertyChangeInterface object
java.lang.String	getRootDir() one one Storyboard ----------------------------------- StoryboardWall storyboard wall
int	getStepCounter()
int	getStepDoneCounter()
StoryboardStepSet	getStoryboardSteps() one many Storyboard ----------------------------------- StoryboardStep storyboard storyboardSteps
java.io.ByteArrayOutputStream	getSystemOut()
void	markCodeStart()
void	recordSystemOut()
java.lang.String	refForFile(java.lang.String filename)
void	removeAllFromStoryboardSteps()
boolean	removeFromStoryboardSteps(StoryboardStep value)
boolean	removePropertyChangeListener(java.beans.PropertyChangeListener listener)
boolean	removePropertyChangeListener(java.lang.String property, java.beans.PropertyChangeListener listener)
void	removeYou()
boolean	searchDirectoryTree(java.io.File projectDir)
void	setJavaTestFileName(java.lang.String javaTestFileName)
void	setModelRootDir(java.lang.String value)
void	setName(java.lang.String name)
void	setRootDir(java.lang.String value)
void	setStepCounter(int value)
void	setStepDoneCounter(int value)
java.lang.String	toString()
StoryboardImpl	with(java.lang.String string)
StoryboardImpl	withAdapter(GuiAdapter adapter)
StoryboardImpl	withDocDirName(java.lang.String name)
StoryboardImpl	withJsonIdMap(de.uniks.networkparser.IdMap jsonIdMap)
StoryboardImpl	withMap(de.uniks.networkparser.IdMap map)
StoryboardImpl	withModelRootDir(java.lang.String value)
StoryboardImpl	withName(java.lang.String name)
StoryboardImpl	withoutStoryboardSteps(StoryboardStep... value)
StoryboardImpl	withRootDir(java.lang.String value)
StoryboardImpl	withStepCounter(int value)
StoryboardImpl	withStepDoneCounter(int value)
StoryboardImpl	withStoryboardSteps(StoryboardStep... value)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_STEPDONECOUNTER

public static final java.lang.String PROPERTY_STEPDONECOUNTER

See Also:

Constant Field Values

PROPERTY_STEPCOUNTER

public static final java.lang.String PROPERTY_STEPCOUNTER

See Also:

Constant Field Values

PROPERTY_MODELROOTDIR

public static final java.lang.String PROPERTY_MODELROOTDIR

See Also:

Constant Field Values

PROPERTY_ROOTDIR

public static final java.lang.String PROPERTY_ROOTDIR

See Also:

Constant Field Values

PROPERTY_WALL

public static final java.lang.String PROPERTY_WALL

See Also:

Constant Field Values

PROPERTY_STORYBOARDSTEPS

public static final java.lang.String PROPERTY_STORYBOARDSTEPS

See Also:

Constant Field Values

MODELING

public static final java.lang.String MODELING

See Also:

Constant Field Values

ACTIVE

public static final java.lang.String ACTIVE

See Also:

Constant Field Values

DONE

public static final java.lang.String DONE

See Also:

Constant Field Values

IMPLEMENTATION

public static final java.lang.String IMPLEMENTATION

See Also:

Constant Field Values

BACKLOG

public static final java.lang.String BACKLOG

See Also:

Constant Field Values

listeners

protected java.beans.PropertyChangeSupport listeners

Constructor Detail

StoryboardImpl

public StoryboardImpl()

StoryboardImpl

@Deprecated
public StoryboardImpl(java.lang.String rootDir)

Deprecated. Storyboards search for their root dir (like src or src/test/java) themself. Thus use the version without parameters.

Parameters:

rootDir - The RootDir of Sources

StoryboardImpl

@Deprecated
public StoryboardImpl(java.lang.String rootDir,
                                  java.lang.String name)

Deprecated. Storyboards search for their root dir (like src or src/test/java) themself. Similarly, Storyboards get their name from the method they are used in. Name that method appropriately. Use the version without parameters.

Parameters:

rootDir - The RootDir of Sources

name - Name of the html file and page title to be generated.

Method Detail

getJavaTestFileName

public java.lang.String getJavaTestFileName()

setJavaTestFileName

public void setJavaTestFileName(java.lang.String javaTestFileName)

withJsonIdMap

public StoryboardImpl withJsonIdMap(de.uniks.networkparser.IdMap jsonIdMap)

getAdapter

public GuiAdapter getAdapter()

withAdapter

public StoryboardImpl withAdapter(GuiAdapter adapter)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

withName

public StoryboardImpl withName(java.lang.String name)

findRootDir

public java.lang.String findRootDir()

searchDirectoryTree

public boolean searchDirectoryTree(java.io.File projectDir)

addStep

public StoryboardImpl addStep(java.lang.String txt)

add

public void add(java.lang.String string)

addText

public void addText(java.lang.String string)

addTable

public void addTable(Table table)

withMap

public StoryboardImpl withMap(de.uniks.networkparser.IdMap map)

coverage4GeneratedModelCode

public void coverage4GeneratedModelCode(java.lang.Object root)

coverSeldomModelMethods

public void coverSeldomModelMethods(de.uniks.networkparser.IdMap copyMap)
                             throws java.lang.NoSuchMethodException,
                                    java.lang.IllegalAccessException,
                                    java.lang.reflect.InvocationTargetException

Throws:

java.lang.NoSuchMethodException

java.lang.IllegalAccessException

java.lang.reflect.InvocationTargetException

coverSetAndPOClasses

public void coverSetAndPOClasses(de.uniks.networkparser.IdMap copyMap)
                          throws java.lang.NoSuchMethodException,
                                 java.lang.SecurityException

Throws:

java.lang.NoSuchMethodException

java.lang.SecurityException

addClassDiagram

public void addClassDiagram(ClassModel model)

Add a class diagram to the generated html page.

Parameters:

model - The ClassModel for drawing

See Also:

TableModel.java

addObjectDiagramWith

public void addObjectDiagramWith(java.lang.Object... elems)

addObjectDiagram

public void addObjectDiagram(java.lang.Object... elems)

addImage

public void addImage(java.lang.String imageFile)

getSystemOut

public java.io.ByteArrayOutputStream getSystemOut()

markCodeStart

public void markCodeStart()

addCode

public void addCode()

addCode

public void addCode(java.lang.String rootDir)

recordSystemOut

public void recordSystemOut()

getMethodText

public java.lang.String getMethodText(java.lang.String rootDir,
                                      java.lang.String className,
                                      java.lang.String methodSignature)

addGenericObjectDiag

public void addGenericObjectDiag(GenericGraph graph)

addGenericObjectDiag

public void addGenericObjectDiag(GenericGraph graph,
                                 GenericObjectSet hiddenObjects)

addGenericObjectDiag

public void addGenericObjectDiag(java.lang.String diagramName,
                                 GenericGraph graph)

addGenericObjectDiag

public void addGenericObjectDiag(java.lang.String diagramName,
                                 GenericGraph graph,
                                 GenericObjectSet hiddenObjects)

with

public StoryboardImpl with(java.lang.String string)

dumpHTML

public void dumpHTML()

Generate an html page from this story. This html file will be named like the story, i.e. like the method that created the Storyboard. It will be added to the refs.html and thus become part of the index.html. All these html files are stored in an directory "doc" located in the project root directory.

See Also:

SDMLib Storyboards, TableModel.java

withDocDirName

public StoryboardImpl withDocDirName(java.lang.String name)

refForFile

public java.lang.String refForFile(java.lang.String filename)

assertEquals

public void assertEquals(java.lang.String message,
                         double expected,
                         double actual,
                         double delta)

assertEquals

public void assertEquals(java.lang.String message,
                         java.lang.Object expected,
                         java.lang.Object actual)

assertTrue

public void assertTrue(java.lang.String message,
                       boolean condition)

assertFalse

public void assertFalse(java.lang.String message,
                        boolean condition)

assertEquals

public void assertEquals(java.lang.String message,
                         int expected,
                         int actual)

assertNotNull

public void assertNotNull(java.lang.String message,
                          java.lang.Object obj)

assertNull

public void assertNull(java.lang.String message,
                       java.lang.Object obj)

getPropertyChangeSupport

public java.beans.PropertyChangeSupport getPropertyChangeSupport()

Description copied from interface: PropertyChangeInterface

Get the propertyChangeSupport attribute of the PropertyChangeInterface object

Specified by:

getPropertyChangeSupport in interface PropertyChangeInterface

Returns:

The propertyChangeSupport value

addPropertyChangeListener

public boolean addPropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

addPropertyChangeListener in interface de.uniks.networkparser.interfaces.SendableEntity

addPropertyChangeListener

public boolean addPropertyChangeListener(java.lang.String propertyName,
                                         java.beans.PropertyChangeListener listener)

Description copied from interface: de.uniks.networkparser.interfaces.SendableEntity

Adds the property change listener.

Specified by:

addPropertyChangeListener in interface de.uniks.networkparser.interfaces.SendableEntity

Parameters:

propertyName - the property name

listener - the listener

Returns:

boolean if add the PropertyChangeListener

removePropertyChangeListener

public boolean removePropertyChangeListener(java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface de.uniks.networkparser.interfaces.SendableEntity

removePropertyChangeListener

public boolean removePropertyChangeListener(java.lang.String property,
                                            java.beans.PropertyChangeListener listener)

Specified by:

removePropertyChangeListener in interface de.uniks.networkparser.interfaces.SendableEntity

removeYou

public void removeYou()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getStoryboardSteps

public StoryboardStepSet getStoryboardSteps()

              one                       many
 Storyboard ----------------------------------- StoryboardStep
              storyboard                   storyboardSteps
 

Returns:

The StoryboardWall

addToStoryboardSteps

public boolean addToStoryboardSteps(StoryboardStep value)

removeFromStoryboardSteps

public boolean removeFromStoryboardSteps(StoryboardStep value)

withStoryboardSteps

public StoryboardImpl withStoryboardSteps(StoryboardStep... value)

withoutStoryboardSteps

public StoryboardImpl withoutStoryboardSteps(StoryboardStep... value)

removeAllFromStoryboardSteps

public void removeAllFromStoryboardSteps()

createStoryboardSteps

public StoryboardStep createStoryboardSteps()

getRootDir

public java.lang.String getRootDir()

              one                       one
 Storyboard ----------------------------------- StoryboardWall
              storyboard                   wall
 

Returns:

The StoryboardWall

setRootDir

public void setRootDir(java.lang.String value)

withRootDir

public StoryboardImpl withRootDir(java.lang.String value)

getModelRootDir

public java.lang.String getModelRootDir()

setModelRootDir

public void setModelRootDir(java.lang.String value)

withModelRootDir

public StoryboardImpl withModelRootDir(java.lang.String value)

getStepCounter

public int getStepCounter()

setStepCounter

public void setStepCounter(int value)

withStepCounter

public StoryboardImpl withStepCounter(int value)

getStepDoneCounter

public int getStepDoneCounter()

setStepDoneCounter

public void setStepDoneCounter(int value)

withStepDoneCounter

public StoryboardImpl withStepDoneCounter(int value)

addPreformatted

public void addPreformatted(java.lang.String expandedText)

addPattern

public void addPattern(PatternObject patternObject,
                       boolean showMatch)

addPattern

public void addPattern(Pattern pattern,
                       boolean showMatch)

dumpDiagram

public void dumpDiagram(PatternObject<?,?> po,
                        java.lang.String name)

addReferenceToJavaDoc

public void addReferenceToJavaDoc(java.lang.String classUnderTestName,
                                  java.lang.String methodUnderTestName,
                                  java.lang.String testFileName)