All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class xm.xm_NodeTypeElement

java.lang.Object
   |
   +----com.sun.java.swing.tree.DefaultMutableTreeNode
           |
           +----xg.xg_Node
                   |
                   +----xg.xg_Element
                           |
                           +----xm.xm_NodeTypeElement

public class xm_NodeTypeElement
extends xg_Element
An XML element which defines an entry in the node type registry. When verify() is called during parsing, this entry is immediately registered, which allows the classes named in the entry to be used when parsing an entity of this type directly afterwards (even if it is the next entity in the XML source).


Variable Index

 o CustomizerClassAttName
The name of the attribute which holds the name of the customizer class.
 o DescriptionAttName
The name of the attribute which holds the description of this entry.
 o NameAttName
The name of the attribute which holds the name of the node to which this registry entry relates.
 o NodeClassAttName
The name of the attribute which holds the name of the node class.
 o ParserClassAttName
The name of the attribute which holds the name of the parser class.
 o RegisteredName
The element type name normally used in XML for this sort of element.
 o ViewClassAttName
The name of the attribute which holds the name of the view class.

Constructor Index

 o xm_NodeTypeElement()
Construct a node type registry entry element with no name.
 o xm_NodeTypeElement(String)
Construct a node type registry entry element with a name.

Method Index

 o checkClassExistence(String, String)
Check that the class exists.
 o getSummaryString()
Get a summary descriptive string suitable for display in the tree view or elsewhere.
 o toString()
Return a string representation of the element (intended for use as debug output).
 o verify()

Verify that this node is correct (ie.

Variables

 o RegisteredName
 public static final String RegisteredName
The element type name normally used in XML for this sort of element.

 o NameAttName
 public static final String NameAttName
The name of the attribute which holds the name of the node to which this registry entry relates.

 o DescriptionAttName
 public static final String DescriptionAttName
The name of the attribute which holds the description of this entry.

 o NodeClassAttName
 public static final String NodeClassAttName
The name of the attribute which holds the name of the node class.

 o ParserClassAttName
 public static final String ParserClassAttName
The name of the attribute which holds the name of the parser class.

 o CustomizerClassAttName
 public static final String CustomizerClassAttName
The name of the attribute which holds the name of the customizer class.

 o ViewClassAttName
 public static final String ViewClassAttName
The name of the attribute which holds the name of the view class.

Constructors

 o xm_NodeTypeElement
 public xm_NodeTypeElement()
Construct a node type registry entry element with no name.

 o xm_NodeTypeElement
 public xm_NodeTypeElement(String InputNodeName)
Construct a node type registry entry element with a name.

Parameters:
InputNodeName - The name of the element

Methods

 o verify
 public void verify() throws xg_VerificationException

Verify that this node is correct (ie. internally correct and/or consistent with other nodes - such as its parent). The node is OK if it possesses a 'Name' attribute which names a valid node type registry entry class.

Throws: xg_VerificationException
Description of verification problem
Overrides:
verify in class xg_Node
 o checkClassExistence
 public String checkClassExistence(String InputAttName,
                                   String InputClassTypeDescription) throws xg_VerificationException
Check that the class exists.

Parameters:
InputClassName - The name of the class to be checked
InputClassTypeDescription - A snippet of text to place in any exception to explain the type of class which could not be found
Returns:
The name of the class from the attribute named InputAttName
Throws: xg_VerificationException
The named class does not exist
 o getSummaryString
 public String getSummaryString()
Get a summary descriptive string suitable for display in the tree view or elsewhere.

Returns:
A description suitable for display in the tree view
Overrides:
getSummaryString in class xg_Node
 o toString
 public String toString()
Return a string representation of the element (intended for use as debug output).

Returns:
String representation of the node
Overrides:
toString in class xg_Element

All Packages  Class Hierarchy  This Package  Previous  Next  Index