org.netbeans.modules.schema2beans

Class GraphManager

java.lang.Object

org.netbeans.modules.schema2beans.GraphManager

public class GraphManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GraphManager.Factory
static interface	GraphManager.Writer

Constructor Summary

Constructors

Constructor and Description
GraphManager(BaseBean root)

Method Summary

Modifier and Type	Method and Description
void	completeRootBinding(BaseBean beanRoot, Node doc)
void	createRootBinding(BaseBean beanRoot, BeanProp prop, Node doc) This method is called by the createRoot() method of the root bean (part of the BaseBean class).
static Node	createRootElementNode(String name)
static Document	createXmlDocument(InputSource in, boolean validate)
static Document	createXmlDocument(InputSource in, boolean validate, EntityResolver er, ErrorHandler eh)
static Document	createXmlDocument(InputStream in, boolean validate) Creates a DOM document from the input stream.
static Document	createXmlDocument(InputStream in, boolean validate, EntityResolver er) Creates a DOM document from the input stream.
static void	debug(boolean d)
Object	defaultScalarValue(int type)
void	fillProperties(BeanProp[] prop, Node node) This method is called by the generated beans when they are building themselves from a DOM tree.
String	getAttributeName(String name) Return the name of the attribute if this is the name of an attribute, return null otherwise.
BaseBean	getBeanRoot() Return the root of the bean graph
protected XMLUtil.DOMWriter	getDOMWriter()
static Node	getElementNode(String name, Node doc) Parse the DOM tree until the element named 'name' is found.
static String	getKeyPropertyName(Bean theRoot, String propName, String[] prop, String[] key, boolean keyName)
String	getKeyPropertyName(String propName)
String	getKeyPropertyName(String propName, String[] prop, String[] key)
String	getKeyPropertyName(String propName, String[] prop, String[] key, boolean keyName) Return the bean holding the property 'name' as a BaseBean object
NodeFactory	getNodeFactory() Return the DOM node factory
static int	getPropertyIndex(Bean theRoot, String name)
int	getPropertyIndex(String name) If the property is an indexed property, return the index of the property.
static String	getPropertyName(String name) Return the name of the property of the PropertyChangeEvent named name.
static Bean	getPropertyParent(Bean theRoot, String name)
BaseBean	getPropertyParent(String name) Return the bean holding the property 'name' as a BaseBean object
static String	getPropertyParentName(String name) Return the name of the bean holding the property 'name'
Document	getXmlDocument() This returns the DOM Document object, root of the current DOM graph.
boolean	isAttribute(String name) Return true if this is the name of an attribute
protected static void	printLevel(OutputStream out, int level, String indent, String text)
protected static void	printLevel(StringBuffer out, int level, String indent)
protected static void	printLevel(StringBuffer out, int level, String indent, String text)
protected static void	printLevel(Writer out, int level, String indent) Indent by 2 spaces for every @level.
protected static void	printLevel(Writer out, int level, String indent, String text)
void	reindent(String indent) Take the current DOM tree and readjust whitespace so that it looks pretty.
void	setDoctype(String publicId, String systemId)
static void	setFactory(InputStream in, GraphManager.Factory factory) Associate a factory to a stream
static void	setFactory(InputStream in, GraphManager.Factory factory, GraphManager.Writer writer) Set an external factory to use instead of the default one
void	setNodeFactory(Document doc) This method sets the DOM nodes factory.
void	setWriteCData(boolean value)
void	setWriter(GraphManager.Writer writer) Set an external writer to use instead of the default one
void	setXmlDocument(Node doc)
static String	trimPropertyName(String propName) Return the bean holding the property 'name' as a BaseBean object
protected void	write(OutputStream out, String encoding)
protected void	write(Writer out)
void	write(Writer out, Node node)
protected void	write(Writer out, String encoding)

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphManager

public GraphManager(BaseBean root)

Method Detail

setFactory

public static void setFactory(InputStream in,
                              GraphManager.Factory factory)
                       throws Schema2BeansException

Associate a factory to a stream

Throws:

Schema2BeansException

setFactory

public static void setFactory(InputStream in,
                              GraphManager.Factory factory,
                              GraphManager.Writer writer)
                       throws Schema2BeansException

Set an external factory to use instead of the default one

Throws:

Schema2BeansException

setWriter

public void setWriter(GraphManager.Writer writer)

Set an external writer to use instead of the default one

setWriteCData

public void setWriteCData(boolean value)

createRootElementNode

public static Node createRootElementNode(String name)
                                  throws Schema2BeansRuntimeException

Throws:

Schema2BeansRuntimeException

setXmlDocument

public void setXmlDocument(Node doc)
                    throws Schema2BeansRuntimeException

Throws:

Schema2BeansRuntimeException

getXmlDocument

public Document getXmlDocument()

This returns the DOM Document object, root of the current DOM graph. Operations that cause structural modifications to the DOM graph are not allowed. Indeed, modifying the DOM graph directly would cause the bean graph and its internal representation to be out of sync.

setDoctype

public void setDoctype(String publicId,
                       String systemId)

getElementNode

public static Node getElementNode(String name,
                                  Node doc)

Parse the DOM tree until the element named 'name' is found. Return the node of the name or null if not found. This method is used by the root bean generated class to get the root element of the DOM tree and start building the bean graph from here.

createRootBinding

public void createRootBinding(BaseBean beanRoot,
                              BeanProp prop,
                              Node doc)
                       throws Schema2BeansException

This method is called by the createRoot() method of the root bean (part of the BaseBean class). The doc might not be available at the time of this call. In such a case, the method completeRootBinding is called afterwards with the doc value to complete the setup of the root. This makes sure that the root element of the object bindings between the beans and the DOM Nodes is created, before that the recursing creation of the graph begins.

Throws:

Schema2BeansException

completeRootBinding

public void completeRootBinding(BaseBean beanRoot,
                                Node doc)

setNodeFactory

public void setNodeFactory(Document doc)

This method sets the DOM nodes factory.

getNodeFactory

public NodeFactory getNodeFactory()

Return the DOM node factory

getBeanRoot

public BaseBean getBeanRoot()

Return the root of the bean graph

write

protected void write(OutputStream out,
                     String encoding)
              throws IOException

Throws:

IOException

write

protected void write(Writer out)
              throws IOException

Throws:

IOException

write

protected void write(Writer out,
                     String encoding)
              throws IOException

Throws:

IOException

write

public void write(Writer out,
                  Node node)
           throws IOException,
                  Schema2BeansException

Throws:

IOException

Schema2BeansException

getDOMWriter

protected XMLUtil.DOMWriter getDOMWriter()

reindent

public void reindent(String indent)

Take the current DOM tree and readjust whitespace so that it looks pretty.

printLevel

protected static void printLevel(Writer out,
                                 int level,
                                 String indent)
                          throws IOException

Indent by 2 spaces for every @level.

Throws:

IOException

printLevel

protected static void printLevel(StringBuffer out,
                                 int level,
                                 String indent)

printLevel

protected static void printLevel(Writer out,
                                 int level,
                                 String indent,
                                 String text)
                          throws IOException

Throws:

IOException

printLevel

protected static void printLevel(OutputStream out,
                                 int level,
                                 String indent,
                                 String text)
                          throws IOException

Throws:

IOException

printLevel

protected static void printLevel(StringBuffer out,
                                 int level,
                                 String indent,
                                 String text)

createXmlDocument

public static Document createXmlDocument(InputStream in,
                                         boolean validate)
                                  throws Schema2BeansRuntimeException

Creates a DOM document from the input stream.

Throws:

Schema2BeansRuntimeException

createXmlDocument

public static Document createXmlDocument(InputStream in,
                                         boolean validate,
                                         EntityResolver er)
                                  throws Schema2BeansRuntimeException

Creates a DOM document from the input stream.

Throws:

Schema2BeansRuntimeException

createXmlDocument

public static Document createXmlDocument(InputSource in,
                                         boolean validate)
                                  throws Schema2BeansException

Throws:

Schema2BeansException

createXmlDocument

public static Document createXmlDocument(InputSource in,
                                         boolean validate,
                                         EntityResolver er,
                                         ErrorHandler eh)
                                  throws Schema2BeansException

Throws:

Schema2BeansException

fillProperties

public void fillProperties(BeanProp[] prop,
                           Node node)
                    throws Schema2BeansException

This method is called by the generated beans when they are building themselves from a DOM tree. Typically, the first root bean calls this method with the DOM root node and the list of the properties that are expected under this node. This method parses the DOM sub-node of the node and matches their names with the names of the properties. When a match is found, the bean property object is called with the node found. If the node has no match in the bean properties, the node is ignored but the event is logged as it might reveal a problem in the bean tree (DTD element missing in the bean class graph).

Throws:

Schema2BeansException

getPropertyParent

public BaseBean getPropertyParent(String name)

Return the bean holding the property 'name' as a BaseBean object

getPropertyParent

public static Bean getPropertyParent(Bean theRoot,
                                     String name)

getKeyPropertyName

public String getKeyPropertyName(String propName,
                                 String[] prop,
                                 String[] key)

getKeyPropertyName

public String getKeyPropertyName(String propName)

getKeyPropertyName

public String getKeyPropertyName(String propName,
                                 String[] prop,
                                 String[] key,
                                 boolean keyName)

Return the bean holding the property 'name' as a BaseBean object

getKeyPropertyName

public static String getKeyPropertyName(Bean theRoot,
                                        String propName,
                                        String[] prop,
                                        String[] key,
                                        boolean keyName)

trimPropertyName

public static String trimPropertyName(String propName)

Return the bean holding the property 'name' as a BaseBean object

getPropertyParentName

public static String getPropertyParentName(String name)

Return the name of the bean holding the property 'name'

getPropertyName

public static String getPropertyName(String name)

Return the name of the property of the PropertyChangeEvent named name. Any index or attribute is removed from the name of the event. single property: /Book/Chapter.2/Comment -> Comment indexed property: /Book/Chapter.4 -> Chapter attribute: /Book/Chapter.2:title -> Chapter

getAttributeName

public String getAttributeName(String name)

Return the name of the attribute if this is the name of an attribute, return null otherwise. single property: /Book/Chapter.2/Comment -> null indexed property: /Book/Chapter.4 -> null attribute: /Book/Chapter.2:title -> title

isAttribute

public boolean isAttribute(String name)

Return true if this is the name of an attribute

getPropertyIndex

public int getPropertyIndex(String name)

If the property is an indexed property, return the index of the property.

getPropertyIndex

public static int getPropertyIndex(Bean theRoot,
                                   String name)

debug

public static void debug(boolean d)

defaultScalarValue

public Object defaultScalarValue(int type)