com.bbn.swede.core.dom
Class XMLComment

java.lang.Object
  extended bycom.bbn.swede.core.dom.OASTNode
      extended bycom.bbn.swede.core.dom.TextNode
          extended bycom.bbn.swede.core.dom.XMLComment

public class XMLComment
extends TextNode

Custom text node implementation for XML comments.

Author:
jlerner

Nested Class Summary
 
Nested classes inherited from class com.bbn.swede.core.dom.OASTNode
OASTNode.NodeCleanupVisitor, OASTNode.NodeInitVisitor
 
Field Summary
 
Fields inherited from class com.bbn.swede.core.dom.TextNode
_sText
 
Fields inherited from class com.bbn.swede.core.dom.OASTNode
_iLength, _iOffset, _nodeParent, _tree, AS_OWL, AS_RDF, AS_RDFS, BASE, COMMENT, DOCTYPE, DOCUMENT, GENERICATTRIBUTE, GENERICPREDICATE, GENERICTHING, LITERAL, NAMESPACE, OWL, OWL_ALLDIFFERENT, OWL_ALLVALUESFROM, OWL_ANNOTATIONPROPERTY, OWL_BACKWARDCOMPATIBLEWITH, OWL_CARDINALITY, OWL_CLASS, OWL_COMPLEMENTOF, OWL_DATARANGE, OWL_DATATYPEPROPERTY, OWL_DEPRECATEDCLASS, OWL_DEPRECATEDPROPERTY, OWL_DIFFERENTFROM, OWL_DISJOINTWITH, OWL_DISTINCTMEMBERS, OWL_EQUIVALENTCLASS, OWL_EQUIVALENTPROPERTY, OWL_FUNCTIONALPROPERTY, OWL_HASVALUE, OWL_IMPORTS, OWL_INCOMPATIBLEWITH, OWL_INTERSECTIONOF, OWL_INVERSEFUNCTIONALPROPERTY, OWL_INVERSEOF, OWL_MAXCARDINALITY, OWL_MINCARDINALITY, OWL_NOTHING, OWL_OBJECTPROPERTY, OWL_ONEOF, OWL_ONPROPERTY, OWL_ONTOLOGY, OWL_ONTOLOGYPROPERTY, OWL_PRIORVERSION, OWL_RESTRICTION, OWL_SAMEAS, OWL_SOMEVALUESFROM, OWL_SYMMETRICPROPERTY, OWL_THING, OWL_TRANSITIVEPROPERTY, OWL_UNIONOF, OWL_VERSIONINFO, PROCESSING_INSTRUCTION, RDF, RDF_ABOUT, RDF_ALT, RDF_BAG, RDF_DATATYPE, RDF_DESCRIPTION, RDF_FIRST, RDF_ID, RDF_LIST, RDF_NODEID, RDF_OBJECT, RDF_PARSETYPE, RDF_PREDICATE, RDF_PROPERTY, RDF_RDF, RDF_RESOURCE, RDF_REST, RDF_SEQ, RDF_STATEMENT, RDF_SUBJECT, RDF_TYPE, RDF_VALUE, RDF_XMLLITERAL, RDFS, RDFS_CLASS, RDFS_COMMENT, RDFS_CONTAINER, RDFS_CONTAINERMEMBERSHIPPROPERTY, RDFS_DATATYPE, RDFS_DOMAIN, RDFS_ISDEFINEDBY, RDFS_LABEL, RDFS_LITERAL, RDFS_MEMBER, RDFS_RANGE, RDFS_RESOURCE, RDFS_SEEALSO, RDFS_SUBCLASSOF, RDFS_SUBPROPERTYOF, S_OWL_URI, S_RDF_URI, S_RDFS_URI, S_XSD_URI, UNPARSEABLE, XML_VERSION
 
Constructor Summary
XMLComment(String sText)
          Creates a new XML comment node.
 
Method Summary
protected  int[] allowedChildren()
          Returns an array of node types indicating what is allowed as a child of the node.
 String generateNodeText()
          Subclasses must implement this method to provide text representing the contents of the node and its children.
 int getNodeType()
          Returns an integer indicating a node's type.
 IRegion[] simplePartitioning()
          Returns a rough partitioning of the node based on the node's tag structure; child nodes are not taken into account.
 String toString()
          Returns a string representation of the node.
 
Methods inherited from class com.bbn.swede.core.dom.TextNode
clone, create, duplicateType, getName, getNamespace, getQName, getText, setText
 
Methods inherited from class com.bbn.swede.core.dom.OASTNode
accept, appendChild, attach, cleanup, createChild, createChildAttribute, detach, displace, displace, endsBefore, findCommonAncestor, findXmlBase, getChildren, getContainingChild, getDefaultNamespace, getFirstChild, getLastAttribute, getLength, getLevel, getLockObject, getNamespaces, getNextChild, getNodesOfType, getNodesOfType, getOffset, getOWLAbstractSyntaxTree, getOWLDocument, getParent, getPreviousChild, getQName, getRoot, getUri, getXmlBase, init, insert, match, remove, replace, setLength, setOffset, startsAfter
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XMLComment

public XMLComment(String sText)
Creates a new XML comment node.

Parameters:
sText - The full text of the comment.
Method Detail

allowedChildren

protected int[] allowedChildren()
Description copied from class: OASTNode
Returns an array of node types indicating what is allowed as a child of the node. Node types are defined as public static fields in OASTNode. This method is not currently used, but will eventually become important for real-time syntax checking.

Specified by:
allowedChildren in class OASTNode
Returns:
An array of allowed node types.

getNodeType

public int getNodeType()
Description copied from class: OASTNode
Returns an integer indicating a node's type. Subclasses must override this method to return one of the node types defined as public static fields in OASTNode. There is a distinct node type for each langauge element as well as several additional types for generics and XML constructs.

Specified by:
getNodeType in class OASTNode
Returns:
The type of this node

generateNodeText

public String generateNodeText()
Description copied from class: OASTNode
Subclasses must implement this method to provide text representing the contents of the node and its children. This method is only used by the editor for inserting an extrnally-constructed node (i.e., as a result of a New... wizard) into the text. The formatting of the generated text is thus unimportant, as it will likely be modified by the Auto-Indent Strategy and Content Formatter anyway.

Overrides:
generateNodeText in class TextNode

simplePartitioning

public IRegion[] simplePartitioning()
Description copied from class: OASTNode

Returns a rough partitioning of the node based on the node's tag structure; child nodes are not taken into account. Partitioning should be as follows:

Overrides:
simplePartitioning in class TextNode

toString

public String toString()
Description copied from class: OASTNode
Returns a string representation of the node. The default implementation just returns the node's qname, but subclasses may override it to supply something more appropriate.

Overrides:
toString in class TextNode


Copyright © 2004-2005 BBN Technologies. All Rights Reserved.