public class Xholon2Json extends AbstractXholon2ExternalFormat implements IXholon2ExternalFormat, IXholon2Xml
STRING_WRITER
XHATTR_TO_NULL, XHATTR_TO_XMLATTR, XHATTR_TO_XMLELEMENT
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 and Description |
---|
Xholon2Json()
Constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
findAnnotation(IXholon xhNode)
Try to find an annotation for the node.
|
IXholon |
get2XmlRoot()
Get the root of the Xholon subtree being transformed into XML.
|
java.lang.String |
getModelName() |
java.lang.String |
getNameTemplate()
Get template to use when writing out node names.
|
java.lang.String |
getOutFileName() |
java.lang.String |
getOutPath() |
IXholon |
getRoot() |
boolean |
getXhAttrReturnAll()
Get whether to return only the attributes of the immediate concrete class (false),
or attributes from all concrete classes in the inheritance hierarchy that extend
from Xholon or XholonWithPorts (true).
|
int |
getXhAttrStyle()
Get how Xholon/Java attributes should be transformed.
|
boolean |
initialize(java.lang.String mmFileName,
java.lang.String modelName,
IXholon root)
Initialize.
|
boolean |
isShouldPrettyPrint() |
boolean |
isShouldQuoteLabels() |
boolean |
isShouldShowStateMachineEntities() |
boolean |
isWriteAnnotations()
Get whether annotation should be written when available for the node.
|
boolean |
isWriteAttributes()
Get whether attributes should be written out for each node.
|
boolean |
isWritePorts()
Get whether ports should be written out for each node.
|
boolean |
isWriteStandardAttributes()
Get whether standard attributes should be written out for each node.
|
boolean |
isWriteStartDocument()
Get whether the XML Declaration should be written at the start of a new XML document.
|
boolean |
isWriteXholonId()
Get whether the Xholon ID should be written out as an XML attribute for each node.
|
boolean |
isWriteXholonRoleName()
Get whether the Xholon roleName should be written out as an XML attribute for each node.
|
void |
setModelName(java.lang.String modelName) |
void |
setNameTemplate(java.lang.String nameTemplate)
Set template to use when writing out node names.
|
void |
setOutFileName(java.lang.String outFileName) |
void |
setOutPath(java.lang.String outPath) |
void |
setRoot(IXholon root) |
void |
setShouldPrettyPrint(boolean shouldPrettyPrint) |
void |
setShouldQuoteLabels(boolean shouldQuoteLabels) |
void |
setShouldShowStateMachineEntities(boolean shouldShowStateMachineEntities) |
void |
setWriteAnnotations(boolean writeAnnotations)
Set whether annotation should be written when available for the node.
|
void |
setWriteAttributes(boolean writeAttributes)
Set whether attributes should be written out for each node.
|
void |
setWritePorts(boolean writePorts)
Set whether ports should be written out for each node.
|
void |
setWriteStandardAttributes(boolean writeStandardAttributes)
Set whether standard attributes should be written out for each node.
|
void |
setWriteStartDocument(boolean writeStartDocument)
Set whether the XML Declaration should be written at the start of a new XML document.
|
void |
setWriteXholonId(boolean writeXholonId)
Set whether the Xholon ID should be written out as an XML attribute for each node.
|
void |
setWriteXholonRoleName(boolean writeXholonRoleName)
Set whether the Xholon roleName should be written out as an XML attribute for each node.
|
void |
setXhAttrReturnAll(boolean xhAttrReturnAll)
Set whether to return only the attributes of the immediate concrete class (false),
or attributes from all concrete classes in the inheritance hierarchy that extend
from Xholon or XholonWithPorts (true).
|
void |
setXhAttrStyle(int xhAttrStyle)
Set how Xholon/Java attributes should be transformed.
|
void |
writeAll()
Write out all parts of the external-format file.
|
void |
writeSpecial(IXholon node)
Write something special for the current node.
|
java.lang.Object |
xholon2Writer(IXholon xhNode,
java.lang.Object out)
Transform a Xholon subtree using a specified Writer.
|
void |
xholon2XmlFile(IXholon xhNode,
java.lang.String fileName)
Transform a Xholon subtree into an XML File.
|
java.lang.String |
xholon2XmlString(IXholon xhNode)
Transform a Xholon subtree into an XML String.
|
adjustOptions, adjustOptionsNative, canAdjustOptions, getEfParamsAsJsonString, setEfParamsFromJsonString
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
getClass, hashCode, notify, notifyAll, wait, wait, wait
adjustOptions, canAdjustOptions, getEfParamsAsJsonString, setEfParamsFromJsonString
public boolean initialize(java.lang.String mmFileName, java.lang.String modelName, IXholon root)
IXholon2ExternalFormat
initialize
in interface IXholon2ExternalFormat
mmFileName
- Name of the output file.modelName
- Name of the model.root
- Root of the hierarchy to write out (composite or inheritance structure).public void writeAll()
IXholon2ExternalFormat
writeAll
in interface IXholon2ExternalFormat
public java.lang.Object xholon2Writer(IXholon xhNode, java.lang.Object out)
out
- An instance of Writer.public java.lang.String xholon2XmlString(IXholon xhNode)
IXholon2Xml
xholon2XmlString
in interface IXholon2Xml
xhNode
- The Xholon node to transform.public void xholon2XmlFile(IXholon xhNode, java.lang.String fileName)
IXholon2Xml
xholon2XmlFile
in interface IXholon2Xml
xhNode
- The Xholon node and/or sub-tree to transform.fileName
- The path and name of the XML file.public java.lang.String findAnnotation(IXholon xhNode)
IXholon2Xml
findAnnotation
in interface IXholon2Xml
xhNode
- A Xholon node that might have an annotation.public boolean isWriteAnnotations()
IXholon2Xml
isWriteAnnotations
in interface IXholon2Xml
public void setWriteAnnotations(boolean writeAnnotations)
IXholon2Xml
setWriteAnnotations
in interface IXholon2Xml
writeAnnotations
- true or falsepublic java.lang.String getOutFileName()
public void setOutFileName(java.lang.String outFileName)
public java.lang.String getModelName()
public void setModelName(java.lang.String modelName)
public IXholon getRoot()
public void setRoot(IXholon root)
public boolean isShouldShowStateMachineEntities()
public void setShouldShowStateMachineEntities(boolean shouldShowStateMachineEntities)
public java.lang.String getNameTemplate()
IXholon2Xml
getNameTemplate
in interface IXholon2Xml
public void setNameTemplate(java.lang.String nameTemplate)
IXholon2Xml
setNameTemplate
in interface IXholon2Xml
nameTemplate
- ex: "r:C^^^"public java.lang.String getOutPath()
public void setOutPath(java.lang.String outPath)
public boolean isShouldQuoteLabels()
public void setShouldQuoteLabels(boolean shouldQuoteLabels)
public int getXhAttrStyle()
IXholon2Xml
getXhAttrStyle
in interface IXholon2Xml
public void setXhAttrStyle(int xhAttrStyle)
IXholon2Xml
setXhAttrStyle
in interface IXholon2Xml
public boolean getXhAttrReturnAll()
IXholon2Xml
getXhAttrReturnAll
in interface IXholon2Xml
public void setXhAttrReturnAll(boolean xhAttrReturnAll)
IXholon2Xml
setXhAttrReturnAll
in interface IXholon2Xml
xhAttrReturnAll
- true or falsepublic boolean isWriteStartDocument()
IXholon2Xml
isWriteStartDocument
in interface IXholon2Xml
public void setWriteStartDocument(boolean writeStartDocument)
IXholon2Xml
setWriteStartDocument
in interface IXholon2Xml
writeStartDocument
- true or falsepublic boolean isWriteXholonId()
IXholon2Xml
isWriteXholonId
in interface IXholon2Xml
public void setWriteXholonId(boolean writeXholonId)
IXholon2Xml
setWriteXholonId
in interface IXholon2Xml
writeXholonId
- true or falsepublic boolean isWriteXholonRoleName()
IXholon2Xml
isWriteXholonRoleName
in interface IXholon2Xml
public void setWriteXholonRoleName(boolean writeXholonRoleName)
IXholon2Xml
setWriteXholonRoleName
in interface IXholon2Xml
writeXholonRoleName
- true or falsepublic boolean isWritePorts()
IXholon2Xml
isWritePorts
in interface IXholon2Xml
public void setWritePorts(boolean writePorts)
IXholon2Xml
setWritePorts
in interface IXholon2Xml
writePorts
- true or falsepublic boolean isShouldPrettyPrint()
public void setShouldPrettyPrint(boolean shouldPrettyPrint)
public IXholon get2XmlRoot()
IXholon2Xml
get2XmlRoot
in interface IXholon2Xml
public boolean isWriteAttributes()
IXholon2Xml
isWriteAttributes
in interface IXholon2Xml
public void setWriteAttributes(boolean writeAttributes)
IXholon2Xml
setWriteAttributes
in interface IXholon2Xml
writeAttributes
- true or falsepublic boolean isWriteStandardAttributes()
IXholon2Xml
isWriteStandardAttributes
in interface IXholon2Xml
public void setWriteStandardAttributes(boolean writeStandardAttributes)
IXholon2Xml
setWriteStandardAttributes
in interface IXholon2Xml
writeStandardAttributes
- true or falsepublic void writeSpecial(IXholon node)
IXholon2Xml
writeSpecial
in interface IXholon2Xml
node
- The current IXholon node.