NXNodeMapper

java.lang.Object
- org.nexusformat.nxvalidate.NXNodeMapper

All Implemented Interfaces:: javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode

public class NXNodeMapper
extends java.lang.Object
implements javax.swing.tree.MutableTreeNode

Constructor Summary

Constructors
Constructor and Description
`NXNodeMapper(org.w3c.dom.Node node, boolean isDocument, java.io.File nxsFile)`
`NXNodeMapper(org.w3c.dom.Node node, boolean isDocument, java.lang.String nodeName)`
`NXNodeMapper(java.lang.String nodeName)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`checkBadChildren()` A method to check to see if any of a nodes children are bad.
`void`	`checkBadNode()` A convenience method to force the checking if a node is bad (failed schematron tests).
`void`	`checkValidatedNode()` A convenience method to force the checking if a node has been validated .
`void`	`checkWarnNode()` A convenience method to force the checking if a node has warnings .
`java.util.Enumeration`	`children()`
`boolean`	`getAllowsChildren()`
`java.lang.String[]`	`getAttributeList()` Each node of the reduced XML document may have attributes associated with it, this method provides a list of the attributes.
`boolean`	`getBadNode()` If a node in the reduced XML document fails one of the schematron tests then the node can be marked as a bad node with a boolean flag.
`NXNodeMapper`	`getChildAt(int searchIndex)`
`int`	`getChildCount()`
`org.w3c.dom.Node`	`getDomNode()` Get the W3C DOM node corresponding to this tree node.
`int`	`getIndex(javax.swing.tree.TreeNode child1)`
`java.util.ArrayList<java.lang.String>`	`getNodeDiagAtts()`
`java.util.ArrayList<java.lang.String>`	`getNodeDiags()` This is a list of text strings which correspond to the schematron diagnostic errors.
`java.util.ArrayList<java.lang.String>`	`getNodeTests()` This is a list of text strings which correspond to the schematron test descriptions.
`java.util.ArrayList<java.lang.String>`	`getNodeTexts()` This is a list of text strings which correspond to the error message results of the schematron tests.
`java.io.File`	`getNXDLFile()` Get the NXDL file belonging to the root node.
`java.io.File`	`getNXSFile()` Get the NXS file belonging to the root node.
`java.util.ArrayList<NXNodeMapper>`	`getOpenNodes()` Returns a list of nodes that represent the Nexus documents that are open i.e.
`javax.swing.tree.TreeNode`	`getParent()`
`org.w3c.dom.Document`	`getReducedDoc()` Initially the Nexus file is converted to a reduced (all data removed) XML document via the Nexus convert command.
`java.io.File`	`getReducedFile()` Get the resultant file produced after NXConvert has been run on the NXS file (reduced to XML).
`org.w3c.dom.Document`	`getResultsDoc()` Get the resultant DOM document produced after the validation procedure has been performed.
`java.io.File`	`getResultsFile()` Get the resultant file produced after the validation procedure has been performed.
`NXNodeMapper`	`getRoot()`
`boolean`	`getValidatedNode()` If a node has been validated then we can indicate the fact with a boolean flag.
`java.lang.String`	`getValue()` Each node of the reduced XML document may have a value associated with it.
`boolean`	`getWarnNode()` If a node in the reduced XML document fails one of the schematron report tests then the node can be marked as a warning node with a boolean flag.
`boolean`	`hasBadChildren()` Check to see if the node has any vary bad kids, return true if it has.
`void`	`insert(javax.swing.tree.MutableTreeNode child, int index)`
`boolean`	`isDocument()` Check to see if this node is a document, i.e the list of nodes directly under the root node that are the open NXS documents.
`boolean`	`isLeaf()`
`boolean`	`isRoot()` Check to see if this node is the root node.
`void`	`remove(int index)`
`void`	`remove(javax.swing.tree.MutableTreeNode node)`
`void`	`removeAllNodes()` Removes the list of nodes that represent the Nexus documents that are open i.e.
`void`	`removeFromParent()`
`void`	`resetNode()` Resets the various properties of a node, i.e flag to indicate that it is a bad node, the text for the tests that failed etc.
`void`	`setBadNode(boolean badNode)` If a node in the reduced XML document fails one of the schematron tests then the node can be marked as a bad node with a boolean flag.
`void`	`setDocument(boolean isDocument)` Set the flag that says that this node is a documents node i.e.
`void`	`setNXDLFile(java.io.File nxdlFile)` Set the NXDL file belonging to the root node.
`void`	`setParent(javax.swing.tree.MutableTreeNode newParent)`
`void`	`setReducedDoc(org.w3c.dom.Document reducedDoc)` Initially the Nexus file is converted to a reduced (all data removed) XML document via the Nexus convert command.
`void`	`setReducedFile(java.io.File reducedFile)` Set the resultant file produced after NXConvert has been run on the NXS file.
`void`	`setResultsDoc(org.w3c.dom.Document resultsDoc)` Get the resultant DOM document produced after the validation procedure has been performed.
`void`	`setResultsFile(java.io.File resultsFile)` Get the resultant file produced after the validation procedure has been performed.
`void`	`setRoot(NXNodeMapper root)` Set the root node that this node belongs to.
`void`	`setUserObject(java.lang.Object object)`
`void`	`setValidatedNode(boolean validatedNode)` If a node has been validated then we can indicate the fact with a boolean flag.
`void`	`setWarnNode(boolean warnNode)` If a node in the reduced XML document fails one of the schematron report tests then the node can be marked as a warning node with a boolean flag.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NXNodeMapper
```
public NXNodeMapper(org.w3c.dom.Node node,
            boolean isDocument,
            java.io.File nxsFile)
```
  - NXNodeMapper
```
public NXNodeMapper(org.w3c.dom.Node node,
            boolean isDocument,
            java.lang.String nodeName)
```
  - NXNodeMapper
```
public NXNodeMapper(java.lang.String nodeName)
```
- Method Detail
  - isRoot
```
public boolean isRoot()
```
    Check to see if this node is the root node.
    
    Returns:
    true is it is the root node, false otherwise.
  - isDocument
```
public boolean isDocument()
```
    Check to see if this node is a document, i.e the list of nodes directly under the root node that are the open NXS documents.
    
    Returns:
    true if the node is a document node.
  - setDocument
```
public void setDocument(boolean isDocument)
```
    Set the flag that says that this node is a documents node i.e. one of the list of nodes directly under the root node that are the open NXS documents.
    
    Parameters:
    isDocument - a flag which is true if the node is a document node.
  - setRoot
```
public void setRoot(NXNodeMapper root)
```
    Set the root node that this node belongs to.
    
    Parameters:
    root - the root node.
  - getNXSFile
```
public java.io.File getNXSFile()
```
    Get the NXS file belonging to the root node. Any other node should return null
    
    Returns:
    the NXS file as a File object.
  - getNXDLFile
```
public java.io.File getNXDLFile()
```
    Get the NXDL file belonging to the root node. Any other node should return null
    
    Returns:
    the NXDL file as a File object.
  - setNXDLFile
```
public void setNXDLFile(java.io.File nxdlFile)
```
    Set the NXDL file belonging to the root node. Should not be set.
    
    Parameters:
    nxdlFile - the NXDL file as a File object.
  - getReducedFile
```
public java.io.File getReducedFile()
```
    Get the resultant file produced after NXConvert has been run on the NXS file (reduced to XML).
    
    Returns:
    the NXConvert reduced file.
  - setReducedFile
```
public void setReducedFile(java.io.File reducedFile)
```
    Set the resultant file produced after NXConvert has been run on the NXS file.
    
    Parameters:
    reducedFile - the NXConvert reduced file.
  - getResultsFile
```
public java.io.File getResultsFile()
```
    Get the resultant file produced after the validation procedure has been performed.
    
    Returns:
    the validation results file.
  - setResultsFile
```
public void setResultsFile(java.io.File resultsFile)
```
    Get the resultant file produced after the validation procedure has been performed.
    
    Parameters:
    resultsFile - the validation results file.
  - getResultsDoc
```
public org.w3c.dom.Document getResultsDoc()
```
    Get the resultant DOM document produced after the validation procedure has been performed.
    
    Returns:
    the validation results DOM document.
  - setResultsDoc
```
public void setResultsDoc(org.w3c.dom.Document resultsDoc)
```
    Get the resultant DOM document produced after the validation procedure has been performed.
    
    Parameters:
    resultsDoc - the validation results DOM document.
  - getReducedDoc
```
public org.w3c.dom.Document getReducedDoc()
```
    Initially the Nexus file is converted to a reduced (all data removed) XML document via the Nexus convert command. This method gets the W3C DOM document of the reduced XML file.
    
    Returns:
    the W3C DOM document of the reduced XML file.
  - setReducedDoc
```
public void setReducedDoc(org.w3c.dom.Document reducedDoc)
```
    Initially the Nexus file is converted to a reduced (all data removed) XML document via the Nexus convert command. This method sets the W3C DOM document of the reduced XML file.
    
    Parameters:
    reducedDoc - the W3C DOM document of the reduced XML file.
  - setBadNode
```
public void setBadNode(boolean badNode)
```
    If a node in the reduced XML document fails one of the schematron tests then the node can be marked as a bad node with a boolean flag. The flag is set to true if the node failed one of the tests.
    
    Parameters:
    badNode - true if the node failed one of the schematron tests.
  - getBadNode
```
public boolean getBadNode()
```
    If a node in the reduced XML document fails one of the schematron tests then the node can be marked as a bad node with a boolean flag. The flag is set to true if the node failed one of the tests.
    
    Returns:
    true if the node failed one of the schematron tests.
  - setWarnNode
```
public void setWarnNode(boolean warnNode)
```
    If a node in the reduced XML document fails one of the schematron report tests then the node can be marked as a warning node with a boolean flag. The flag is set to true if the node failed one of the tests.
    
    Parameters:
    warnNode - true if the node failed one of the schematron tests.
  - getWarnNode
```
public boolean getWarnNode()
```
    If a node in the reduced XML document fails one of the schematron report tests then the node can be marked as a warning node with a boolean flag. The flag is set to true if the node failed one of the tests.
    
    Returns:
    true if the node failed one of the schematron tests.
  - setValidatedNode
```
public void setValidatedNode(boolean validatedNode)
```
    If a node has been validated then we can indicate the fact with a boolean flag. The flag is set to true if the node has been validated.
    
    Parameters:
    validatedNode - true if the node has been validated.
  - getValidatedNode
```
public boolean getValidatedNode()
```
    If a node has been validated then we can indicate the fact with a boolean flag. The flag is set to true if the node has been validated.
    
    Returns:
    true if the node failed one of the schematron tests.
  - getDomNode
```
public org.w3c.dom.Node getDomNode()
```
    Get the W3C DOM node corresponding to this tree node.
    
    Returns:
    the W3C DOM node corresponding to this tree node.
  - checkBadNode
```
public void checkBadNode()
```
    A convenience method to force the checking if a node is bad (failed schematron tests). Sets the flag to indicate the node is bad.
  - checkWarnNode
```
public void checkWarnNode()
```
    A convenience method to force the checking if a node has warnings . Sets the flag to indicate the node has warnings.
  - checkValidatedNode
```
public void checkValidatedNode()
```
    A convenience method to force the checking if a node has been validated . Sets the flag to indicate the node has warnings.
  - checkBadChildren
```
public boolean checkBadChildren()
```
    A method to check to see if any of a nodes children are bad.
    
    Returns:
    true if there are any bad children
  - resetNode
```
public void resetNode()
```
    Resets the various properties of a node, i.e flag to indicate that it is a bad node, the text for the tests that failed etc.
  - getNodeTexts
```
public java.util.ArrayList<java.lang.String> getNodeTexts()
```
    This is a list of text strings which correspond to the error message results of the schematron tests.
    
    Returns:
    list of text strings corresponding to the schematron test results.
  - getNodeTests
```
public java.util.ArrayList<java.lang.String> getNodeTests()
```
    This is a list of text strings which correspond to the schematron test descriptions.
    
    Returns:
    list of text strings corresponding to the schematron test descriptions.
  - getNodeDiags
```
public java.util.ArrayList<java.lang.String> getNodeDiags()
```
    This is a list of text strings which correspond to the schematron diagnostic errors.
    
    Returns:
    list of text strings corresponding to the schematron diagnostic errors.
  - getNodeDiagAtts
```
public java.util.ArrayList<java.lang.String> getNodeDiagAtts()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getIndex
```
public int getIndex(javax.swing.tree.TreeNode child1)
```
    Specified by:
    
    getIndex in interface javax.swing.tree.TreeNode
  - getChildAt
```
public NXNodeMapper getChildAt(int searchIndex)
```
    Specified by:
    
    getChildAt in interface javax.swing.tree.TreeNode
  - getChildCount
```
public int getChildCount()
```
    Specified by:
    
    getChildCount in interface javax.swing.tree.TreeNode
  - children
```
public java.util.Enumeration children()
```
    Specified by:
    
    children in interface javax.swing.tree.TreeNode
  - isLeaf
```
public boolean isLeaf()
```
    Specified by:
    
    isLeaf in interface javax.swing.tree.TreeNode
  - getAllowsChildren
```
public boolean getAllowsChildren()
```
    Specified by:
    
    getAllowsChildren in interface javax.swing.tree.TreeNode
  - getParent
```
public javax.swing.tree.TreeNode getParent()
```
    Specified by:
    
    getParent in interface javax.swing.tree.TreeNode
  - getRoot
```
public NXNodeMapper getRoot()
```
  - getAttributeList
```
public java.lang.String[] getAttributeList()
```
    Each node of the reduced XML document may have attributes associated with it, this method provides a list of the attributes. Each string contains the attribute name and the value.
    
    Returns:
    a list of the attributes and their values.
  - getValue
```
public java.lang.String getValue()
```
    Each node of the reduced XML document may have a value associated with it. This method returns that value as a string.
    
    Returns:
    the value of the XML node.
  - getOpenNodes
```
public java.util.ArrayList<NXNodeMapper> getOpenNodes()
```
    Returns a list of nodes that represent the Nexus documents that are open i.e. that have been reduced.
    
    Returns:
    a list of Nexus document nodes.
  - removeAllNodes
```
public void removeAllNodes()
```
    Removes the list of nodes that represent the Nexus documents that are open i.e. that have been reduced.
  - hasBadChildren
```
public boolean hasBadChildren()
```
    Check to see if the node has any vary bad kids, return true if it has.
    
    Returns:
    true if the kids are bad.
  - insert
```
public void insert(javax.swing.tree.MutableTreeNode child,
          int index)
```
    Specified by:
    
    insert in interface javax.swing.tree.MutableTreeNode
  - remove
```
public void remove(int index)
```
    Specified by:
    
    remove in interface javax.swing.tree.MutableTreeNode
  - remove
```
public void remove(javax.swing.tree.MutableTreeNode node)
```
    Specified by:
    
    remove in interface javax.swing.tree.MutableTreeNode
  - removeFromParent
```
public void removeFromParent()
```
    Specified by:
    
    removeFromParent in interface javax.swing.tree.MutableTreeNode
  - setParent
```
public void setParent(javax.swing.tree.MutableTreeNode newParent)
```
    Specified by:
    
    setParent in interface javax.swing.tree.MutableTreeNode
  - setUserObject
```
public void setUserObject(java.lang.Object object)
```
    Specified by:
    
    setUserObject in interface javax.swing.tree.MutableTreeNode

Class NXNodeMapper

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NXNodeMapper

NXNodeMapper

NXNodeMapper

Method Detail

isRoot

isDocument

setDocument

setRoot

getNXSFile

getNXDLFile

setNXDLFile

getReducedFile

setReducedFile

getResultsFile

setResultsFile

getResultsDoc

setResultsDoc

getReducedDoc

setReducedDoc

setBadNode

getBadNode

setWarnNode

getWarnNode

setValidatedNode

getValidatedNode

getDomNode

checkBadNode

checkWarnNode

checkValidatedNode

checkBadChildren

resetNode

getNodeTexts

getNodeTests

getNodeDiags

getNodeDiagAtts

toString

getIndex

getChildAt

getChildCount

children

isLeaf

getAllowsChildren

getParent

getRoot

getAttributeList

getValue

getOpenNodes

removeAllNodes

hasBadChildren

insert

remove

remove

removeFromParent

setParent

setUserObject