org.primordion.ef.d3

Class Xholon2Cloud

java.lang.Object

org.primordion.xholon.base.Xholon

org.primordion.ef.AbstractXholon2ExternalFormat

org.primordion.ef.d3.Xholon2Cloud

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable, IXholon, XholonMarker, IXholon2ExternalFormat

public class Xholon2Cloud
extends AbstractXholon2ExternalFormat
implements IXholon2ExternalFormat

Export a Xholon model in D3 cloud layout format. The result is a tag cloud that can be displayed on the app page.

Since:

0.9.1 (Created on June 22, 2014)

See Also:

Xholon Project website, d3-cloud, online generation, Serialized Form

Field Summary

Fields inherited from interface org.primordion.xholon.service.ef.IXholon2ExternalFormat

STRING_WRITER

Fields inherited from interface org.primordion.xholon.base.IXholon

DEFAULT_SIZE_MSG_Q, DEFAULT_SIZE_SYSTEM_MSG_Q, GETNAME_DEFAULT, GETNAME_LOCALPART_ID, GETNAME_NOROLENAME, GETNAME_ROLENAME_OR_CLASSNAME, GETNAME_ROLENAMESEP_, GETNAME_SIZE_TEMPLATE, NINCLUDE_PSC, NINCLUDE_PSx, NINCLUDE_PxC, NINCLUDE_Pxx, NINCLUDE_xSC, NINCLUDE_xSx, NINCLUDE_xxC, NINCLUDE_xxx, XHOLON_ID_DEFAULT, XHOLON_ID_NULL

Constructor Summary

Constructors

Constructor and Description
Xholon2Cloud() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAngle()
java.lang.String	getFontFamily()
int	getHeight()
java.lang.String	getModelName()
java.lang.String	getNameTemplate()
java.lang.String	getOutFileName()
java.lang.String	getOutPath()
int	getPadding()
IXholon	getRoot()
int	getSizeIncrementer()
int	getSizeMultiplier()
int	getTranslateX()
int	getTranslateY()
int	getWidth()
boolean	initialize(java.lang.String mmFileName, java.lang.String modelName, IXholon root) Initialize.
boolean	isShouldShowRootNode()
boolean	isShouldShowStateMachineEntities()
void	setModelName(java.lang.String modelName)
void	setOutFileName(java.lang.String outFileName)
void	setOutPath(java.lang.String outPath)
void	setRoot(IXholon root)
void	setShouldShowStateMachineEntities(boolean shouldShowStateMachineEntities)
void	writeAll() Write out all parts of the external-format file.

Methods inherited from class org.primordion.ef.AbstractXholon2ExternalFormat

adjustOptions, adjustOptionsNative, canAdjustOptions, getEfParamsAsJsonString, setEfParamsFromJsonString

Methods inherited from class org.primordion.xholon.base.Xholon

act, actNr, appendChild, appendChild, appendChild, appendsOwnChildren, bindPorts, cleanup, compareTo, configure, configure, consoleLog, decVal, decVal, depth, doAction, equals, findFirstChildWithXhClass, findFirstChildWithXhClass, forwardMessage, forwardSyncMessage, getActionList, getAllPorts, getAnnotation, getApp, getAttributeNodeXh, getAttributeXh, getChildNodes, getClassNode, getClassNode, getFactory, getFirstChild, getFirstSibling, getId, getInteraction, getInteractionsEnabled, getIQueueImplName, getLastChild, getLastSibling, getLogger, getMsgQ, getName, getName, getNeighbors, getNextSibling, getNthChild, getNthSibling, getNumChildren, getNumLevels, getNumSiblings, getParentNode, getPort, getPort, getPreviousSibling, getRoleName, getRootNode, getSelfAndSiblings, getSelfAndSiblingsIndex, getService, getSiblings, getSystemMsgQ, getUid, getUri, getVal_boolean, getVal_byte, getVal_char, getVal_double, getVal_float, getVal_int, getVal_long, getVal_Object, getVal_short, getVal_String, getVal, getXhc, getXhcId, getXhcName, getXholon2Xml, getXhType, getXml2Xholon, getXPath, handleNodeSelection, handleNodeSelection, hasAncestor, hasAnnotation, hasAttributeXh, hasChildNodes, hasChildOrSiblingNodes, hasNextSibling, hasParentNode, hasSiblingNodes, height, incVal, incVal, initialize, initStatics, inOrderPrint, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertFirstChild, isActiveObject, isAttributeHandler, isBound, isContainer, isExternal, isInternal, isLeaf, isPassiveObject, isRootNode, isUniqueSibling, isUniqueSiblingRoleName, performActivity, performActivity, performBooleanActivity, performBooleanActivity, performDoubleActivity, performGuard, performVoidActivity, postAct, postConfigure, postOrderPrint, postReconfigure, preAct, preConfigure, preOrderPrint, preReconfigure, print, println, processMessageQ, processReceivedMessage, processReceivedSyncMessage, processSystemMessageQ, reconfigure, registerMessageForwardee, remove, removeAttributeNodeXh, removeAttributeXh, removeChild, replaceNode, searchForReferencingNodes, searchForReferencingNodesRecurse, sendMessage, sendMessage, sendMessage, sendSyncMessage, sendSyncMessage, sendSyncMessage, sendSystemMessage, sendSystemMessage, setActionList, setAnnotation, setApp, setAttributeNodeXh, setAttributeVal, setAttributeXh, setFirstChild, setId, setName, setNextSibling, setParentChildLinks, setParentNode, setParentSiblingLinks, setPort, setPort, setPorts, setRoleName, setUid, setUri, setVal_boolean, setVal_byte, setVal_char, setVal_double, setVal_float, setVal_int, setVal_long, setVal_Object, setVal_short, setVal_String, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setVal, setXhc, showAnnotation, swapNode, terminate, toString, toXml, toXmlAttribute, toXmlAttributes, toXmlText, treeSize, visit

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.primordion.xholon.service.ef.IXholon2ExternalFormat

adjustOptions, canAdjustOptions, getEfParamsAsJsonString, setEfParamsFromJsonString

Constructor Detail

Xholon2Cloud

public Xholon2Cloud()

Constructor.

Method Detail

initialize

public boolean initialize(java.lang.String mmFileName,
                 java.lang.String modelName,
                 IXholon root)

Description copied from interface: IXholon2ExternalFormat

Initialize.

Specified by:

initialize in interface IXholon2ExternalFormat

Parameters:

mmFileName - Name of the output file.

modelName - Name of the model.

root - Root of the hierarchy to write out (composite or inheritance structure).

Returns:

Whether or not the initialization succeeded.

writeAll

public void writeAll()

Description copied from interface: IXholon2ExternalFormat

Write out all parts of the external-format file.

Specified by:

writeAll in interface IXholon2ExternalFormat

isShouldShowRootNode

public boolean isShouldShowRootNode()

getNameTemplate

public java.lang.String getNameTemplate()

getWidth

public int getWidth()

getHeight

public int getHeight()

getFontFamily

public java.lang.String getFontFamily()

getAngle

public int getAngle()

getSizeIncrementer

public int getSizeIncrementer()

getSizeMultiplier

public int getSizeMultiplier()

getTranslateX

public int getTranslateX()

getTranslateY

public int getTranslateY()

getPadding

public int getPadding()

getOutFileName

public java.lang.String getOutFileName()

setOutFileName

public void setOutFileName(java.lang.String outFileName)

getModelName

public java.lang.String getModelName()

setModelName

public void setModelName(java.lang.String modelName)

getRoot

public IXholon getRoot()

setRoot

public void setRoot(IXholon root)

isShouldShowStateMachineEntities

public boolean isShouldShowStateMachineEntities()

setShouldShowStateMachineEntities

public void setShouldShowStateMachineEntities(boolean shouldShowStateMachineEntities)

getOutPath

public java.lang.String getOutPath()

setOutPath

public void setOutPath(java.lang.String outPath)