org.netbeans.modules.schema2beansdev

Class TreeBuilder

java.lang.Object

org.netbeans.modules.schema2beansdev.TreeBuilder

All Implemented Interfaces:

DocDefHandler, HasPrefixGuesser, TreeParser

public class TreeBuilder
extends Object
implements DocDefHandler, TreeParser, HasPrefixGuesser

This class implements the Document Definition handler in order to build the internal tree representation of the DD DTD.

Method Summary

Modifier and Type	Method and Description
void	addExtraDataCurLink(Object data)
void	addExtraDataCurLink(Object[] data)
void	addExtraDataNode(String uniqueName, String typeName, Object data)
void	addExtraDataNode(String uniqueName, String typeName, Object[] data)
void	character(char c) Called each time a character | is found.
boolean	doesElementExist(String typeName) Does this element exist at this point? Either thru a startElement() creation, or thru an element() reference.
String	dump()
void	element(String uniqueName, String typeName, int instance)
void	element(String uniqueName, String typeName, String attrName, String attrNamespace, int instance, boolean externalType, String defaultValue) Called for each word found in a DTD definition.
void	endDocument() Called when the DTD parsing is over.
void	endElement() Done with an element
void	endGroupElements(int instance) We are done creating the elements of a same group, set the current link to the parent of the group.
String	getDefaultNamespace() Get the namespace that will be used by default in the documents.
GraphNode	getNode(String uniqueName) Return a specific GraphNode.
GraphNode[]	getNodes() TreeParser interface.
PrefixGuesser	getPrefixGuesser()
GraphNode	getRoot() Return the root of the DTD object graph.
void	javaType(String uniqueName, String name, String javaType) Called to request that the graph node named name be of a certain Java class.
void	nillable(boolean value)
void	setAbstract(String uniqueName, String name, boolean value)
void	setDefaultNamespace(String ns) Set the namespace that will be used by default in the documents.
void	setExtendedProperty(String uniqueName, String typeName, String propertyName, Object value) set an extended property on a GraphNode
void	setExtension(String uniqueName, String typeName, String extendsName)
void	setPrefixGuesser(PrefixGuesser guesser) Establish a prefix guesser
void	setUnion(String uniqueName, String typeName, boolean value)
void	startDocument(String root) Called once, when the DTD is started to be parsed.
void	startElement(String uniqueName, String typeName, int type) Called each time a DTD
void	startGroupElements() Called when a parenthese is found, meaning that the following elements (element() calls) should be considered as semantically grouped.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

startDocument

public void startDocument(String root)

Called once, when the DTD is started to be parsed. Create the GraphNode root element.

Specified by:

startDocument in interface DocDefHandler

Parameters:

root - root elemement name of the document (as the DOCTYPE specifies in the XML document)

endDocument

public void endDocument()

Called when the DTD parsing is over. At this time, the DTD object graph is entirely built. The method checks the consitency of the built graph, and cleans things up a bit.

Specified by:

endDocument in interface DocDefHandler

startElement

public void startElement(String uniqueName,
                         String typeName,
                         int type)

Called each time a DTD

Specified by:

startElement in interface DocDefHandler

Parameters:

name - the name of the element

typeName - is the name to use for the attribute

type - the type (as a constant) of the element (for example ELEMENT or ATTLIST)

doesElementExist

public boolean doesElementExist(String typeName)

Description copied from interface: DocDefHandler

Does this element exist at this point? Either thru a startElement() creation, or thru an element() reference.

Specified by:

doesElementExist in interface DocDefHandler

endElement

public void endElement()

Done with an element

Specified by:

endElement in interface DocDefHandler

character

public void character(char c)

Called each time a character | is found.

Specified by:

character in interface DocDefHandler

element

public void element(String uniqueName,
                    String typeName,
                    String attrName,
                    String attrNamespace,
                    int instance,
                    boolean externalType,
                    String defaultValue)

Called for each word found in a DTD definition. This can be a comment, element or attlist definition. For example, this method is called for each name element found within the scope of an element (. The first element name doesn't generate a call to this method (@see startElement). This is where the subtree of the element definition is built. The element to add might be a child or sibling to the previous element. If the element is preceded by a '(', this is child (@see startGroupElements), otherwise the element is a sibling.

Specified by:

element in interface DocDefHandler

Parameters:

name - the name of the element defined within the declaration.

instance - has one of the three values: TYPE_0_1, TYPE_1, TYPE_0_N, TYPE_1_N

element

public void element(String uniqueName,
                    String typeName,
                    int instance)

Specified by:

element in interface DocDefHandler

addExtraDataNode

public void addExtraDataNode(String uniqueName,
                             String typeName,
                             Object data)
                      throws Schema2BeansException

Specified by:

addExtraDataNode in interface DocDefHandler

Throws:

Schema2BeansException

addExtraDataCurLink

public void addExtraDataCurLink(Object data)

Specified by:

addExtraDataCurLink in interface DocDefHandler

addExtraDataNode

public void addExtraDataNode(String uniqueName,
                             String typeName,
                             Object[] data)
                      throws Schema2BeansException

Throws:

Schema2BeansException

setUnion

public void setUnion(String uniqueName,
                     String typeName,
                     boolean value)
              throws Schema2BeansException

Specified by:

setUnion in interface DocDefHandler

Throws:

Schema2BeansException

addExtraDataCurLink

public void addExtraDataCurLink(Object[] data)

nillable

public void nillable(boolean value)

Specified by:

nillable in interface DocDefHandler

setAbstract

public void setAbstract(String uniqueName,
                        String name,
                        boolean value)

Specified by:

setAbstract in interface DocDefHandler

setExtendedProperty

public void setExtendedProperty(String uniqueName,
                                String typeName,
                                String propertyName,
                                Object value)
                         throws Schema2BeansException

set an extended property on a GraphNode

Specified by:

setExtendedProperty in interface DocDefHandler

Throws:

Schema2BeansException

javaType

public void javaType(String uniqueName,
                     String name,
                     String javaType)

Called to request that the graph node named name be of a certain Java class. If the current element type is an attribute, then we set the javaType of that attribute instead.

Specified by:

javaType in interface DocDefHandler

Parameters:

javaType - is the name of a Java class (eg, "java.lang.Integer", or "int").

setExtension

public void setExtension(String uniqueName,
                         String typeName,
                         String extendsName)
                  throws Schema2BeansException

Specified by:

setExtension in interface DocDefHandler

Throws:

Schema2BeansException

startGroupElements

public void startGroupElements()

Called when a parenthese is found, meaning that the following elements (element() calls) should be considered as semantically grouped. Creates a child GraphLink from the current link to group all the further elements of this group. If any propriety is defined for this group (as *, ? or + or |) this will be set later on the current link (as the parent of any of the elements graph link objects).

Specified by:

startGroupElements in interface DocDefHandler

endGroupElements

public void endGroupElements(int instance)

We are done creating the elements of a same group, set the current link to the parent of the group. This will allow either to start creating siblings (if element() is called) or go the next parent level (if this same method is called again).

Specified by:

endGroupElements in interface DocDefHandler

setDefaultNamespace

public void setDefaultNamespace(String ns)

Description copied from interface: DocDefHandler

Set the namespace that will be used by default in the documents.

Specified by:

setDefaultNamespace in interface DocDefHandler

getDefaultNamespace

public String getDefaultNamespace()

Description copied from interface: TreeParser

Get the namespace that will be used by default in the documents.

Specified by:

getDefaultNamespace in interface TreeParser

getNodes

public GraphNode[] getNodes()

TreeParser interface. This is what the BeanBuilder uses to get elements of the tree. The goal is to try to keep separated the object graph implementation from its usage. Not sure, this is very useful though, since the tree builder knows the gory details of the graph. Just a gentle way to ask for the graph.

Specified by:

getNodes in interface TreeParser

getNode

public GraphNode getNode(String uniqueName)

Description copied from interface: TreeParser

Return a specific GraphNode.

Specified by:

getNode in interface TreeParser

getRoot

public GraphNode getRoot()

Description copied from interface: TreeParser

Return the root of the DTD object graph.

Specified by:

getRoot in interface TreeParser

dump

public String dump()

setPrefixGuesser

public void setPrefixGuesser(PrefixGuesser guesser)

Description copied from interface: DocDefHandler

Establish a prefix guesser

Specified by:

setPrefixGuesser in interface DocDefHandler

getPrefixGuesser

public PrefixGuesser getPrefixGuesser()

Specified by:

getPrefixGuesser in interface HasPrefixGuesser