org.ceryle.wiki.visualizer.core.model
Class WikiPage

java.lang.Object
  org.ceryle.wiki.visualizer.core.model.WikiPage

All Implemented Interfaces:

Serializable, ReferenceInfoProvider

public class WikiPage
extends Object
implements ReferenceInfoProvider, Serializable

WikiPage.

TODO

See Also:

Serialized Form

Method Summary

Color	getActiveBackgroundColor() Returns the background color.
Collection	getAllPages()
String	getAuthor()
String	getFinalPageName(String pageName)
NumberAdornment	getHiddenLinkAdornment()
NumberAdornment	getHiddenPageAdornment()
Collection	getInboundLinks() Should this MAYBE return an unmodifiable Collection? Hmm, concurrency?
WikiModel	getModel()
Date	getModificationDate()
String	getName()
WikiNode	getNode() A WikiPage knows its WikiNode, just like a WikiModel knows its WikiGraph.
Collection	getOutboundLinks() Should this MAYBE return an unmodifiable Collection? Hmm, concurrency?
Collection	getReferredBy(String page)
Collection	getRefersTo(String page)
boolean	getShouldGraph()
int	getSignature() This 'signature' can be used to determine if there were any modifications made to the underlying to and by maps of the ReferenceManager.
String	getText()
String	getToolTipText()
int	getVersion()
void	hide()
boolean	isHidden()
boolean	isInQueryResults()
boolean	isUnreferenced()
void	openEditUrl() Opens this page for edit in a browser window.
void	openViewUrl() Opens a this page in a browser window.
void	setInQueryResults(boolean state)
void	show()
void	showHiddenLinks()

Methods inherited from class java.lang.Object

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

Method Detail

getAllPages

public Collection getAllPages()

Specified by:

getAllPages in interface ReferenceInfoProvider

getSignature

public int getSignature()

Description copied from interface: ReferenceInfoProvider

This 'signature' can be used to determine if there were any modifications made to the underlying to and by maps of the ReferenceManager. This method traps and retries if a concurrent modifcaition occurs. The maps of the ReferenceManager are not synchronized, so someone could add/remove entries in them while the hashCodes are being computed.

Specified by:

getSignature in interface ReferenceInfoProvider

Returns:

Sum of the hashCodes for the to and by maps of the ReferenceManager

isUnreferenced

public boolean isUnreferenced()

Returns:

true if page is unreferenced, i.e. no in or out links or all in's are same as out's.

getNode

public WikiNode getNode()

A WikiPage knows its WikiNode, just like a WikiModel knows its WikiGraph. The act of asking for a WikiNode for a page creates one.

Returns:

The node to be used on the graph for his page.

getName

public String getName()

getToolTipText

public String getToolTipText()

getText

public String getText()

Returns:

The full wiki text of the page.

getAuthor

public String getAuthor()

Returns:

Returns the author.

getModificationDate

public Date getModificationDate()

Returns:

Returns the modificationDate.

getVersion

public int getVersion()

Returns:

Returns the version.

getOutboundLinks

public Collection getOutboundLinks()

Should this MAYBE return an unmodifiable Collection? Hmm, concurrency?

Returns:

the Collection of outbound links

getInboundLinks

public Collection getInboundLinks()

Should this MAYBE return an unmodifiable Collection? Hmm, concurrency?

Returns:

the Collection of inbound links

openViewUrl

public void openViewUrl()

Opens a this page in a browser window.

openEditUrl

public void openEditUrl()

Opens this page for edit in a browser window.

getFinalPageName

public String getFinalPageName(String pageName)

getRefersTo

public Collection getRefersTo(String page)

Specified by:

getRefersTo in interface ReferenceInfoProvider

getReferredBy

public Collection getReferredBy(String page)

Specified by:

getReferredBy in interface ReferenceInfoProvider

setInQueryResults

public void setInQueryResults(boolean state)

Parameters:

state -

getShouldGraph

public boolean getShouldGraph()

isHidden

public boolean isHidden()

hide

public void hide()

show

public void show()

showHiddenLinks

public void showHiddenLinks()

isInQueryResults

public boolean isInQueryResults()

getModel

public WikiModel getModel()

getHiddenLinkAdornment

public NumberAdornment getHiddenLinkAdornment()

Returns:

Returns the hiddenLinkAdornment.

getHiddenPageAdornment

public NumberAdornment getHiddenPageAdornment()

Returns:

Returns the hiddenPageAdornment.

getActiveBackgroundColor

public Color getActiveBackgroundColor()

Returns the background color. The color adornment is envisioned to have multiple colors for animated color cycling when a node has been decorated with more than one color, a scheme to have all nodes lockstep animated is needed (i.e. all RED's flash together, then all BLUE's, etc) the animation and gui update method needs fleshed out as well, timer based, what have you... Lots of work to be done in the whole decorator/adornment area. TODO