BaseBean (Schema2beans repackaged as an OSGI bundle 6.6 API)

java.lang.Object
- org.netbeans.modules.schema2beans.BaseBean

All Implemented Interfaces:

Cloneable, Bean
```
public abstract class BaseBean
extends Object
implements Cloneable, Bean
```
This class is the base class for any generated bean. This class provides the property book-keeping and access as a set of dynamic creation/accessor property methods. BaseBean is the class that any generated schema2beans class extends. The generated code implements the specific accessors methods while the BaseBean class provides the generic ones. For example, a generated bean would have public String getDescription() { return (String)this.getValue(DESCRIPTION); } BaseBean handles any value as an Object, where the generated schema2beans class handles a specific class/scalar type depending on its corresponding DTD element (and optional mdd values. See user document for mdd info). The idea of BaseBean is to provide the unique schema2beans java bean on which all generated schema2beans class rely. This is the user entry point of the schema2beans runtime. This is where you find all the generic methods that apply to all schema2beans classes: merge, find, clone, get/set attributes, etc. If we had to draw a gereric overview of the schema2beans architecture, we would draw three parts: BaseBean, BeanProp and DOMBinding. This is where most of the schema2beans runtime is implemented. There is one BaseBean instance per schema2beans node (one non final element of the DTD has one generated class that extends BaseBean). Each BaseBean holds its properties as BeanProp objects. For each property, BaseBean has one instance of BeanProp. For example, if we have as a DTD: The we would have two classes that would extend BaseBean: Book and Chapter. The book BaseBean would handle two instance of BeanProp, one for the property chapter and one of summary. The BeanProp for summary would handle a single String property, and the BeanProp for chapter would handle an indexed property of Chapter classes. Also, the chapter BaseBean (one instance for each element of the indexed property), would have one instance of BeanProp, that would handle the String indexed property line. The internal graph representation of the XML document is handled using a DOM tree. DOMBinding is the class that takes care of linking the BeanProp instances to the DOM nodes.

Property Summary

All Methods Instance Methods Concrete Methods
Type Property and Description

boolean isChoice
Gets the value of the property choiceProperty.

All Methods Instance Methods Concrete Methods
Type	Property and Description
`boolean`	`isChoice` Gets the value of the property choiceProperty.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class BaseBean.IterateChoiceProperties

Nested Classes
Modifier and Type	Class and Description
`class`	`BaseBean.IterateChoiceProperties`

Field Summary

Fields
Modifier and Type	Field and Description
`protected DOMBinding`	`binding`
`protected GraphManager`	`graphManager`
`static int`	`MERGE_COMPARE`
`static int`	`MERGE_INTERSECT`
`static int`	`MERGE_NONE` Merge the bean tree with ourself Let's define: G1 the current graph and G2 the new graph we want to merge E1 the set of element of G1 that don't exist anymore in G2.
`static int`	`MERGE_UNION`
`static int`	`MERGE_UPDATE`

Constructor Summary

Constructors
Constructor and Description

BaseBean(Vector comps, Version version)

Constructors
Constructor and Description
`BaseBean(Vector comps, Version version)`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`Bean`	`_getParent()`
`Bean`	`_getRoot()` Return the root of the graph.
`String`	`_getXPathExpr()`
`String`	`_getXPathExpr(Object childObj)`
`void`	`_setChanged(boolean changed)`
`void`	`addBeanComparator(BeanComparator cmp)`
`Comment`	`addComment(String comment)` The new comment will be added to the first of the bean's children.
`protected void`	`addKnownValue(String name, Object value)`
`void`	`addPropertyChangeListener(PropertyChangeListener l)`
`void`	`addPropertyChangeListener(String n, PropertyChangeListener l)`
`protected int`	`addValue(BeanProp prop, Object value)`
`int`	`addValue(String name, Object value)` Add a value to the indexed property named name.
`BeanProp`	`beanProp()` Return the BeanProp object where this bean belongs.
`BeanProp`	`beanProp(int order)` Return the internal object representation of the property.
`BeanProp`	`beanProp(String name)` Return the internal object representation of the property.
`BeanProp[]`	`beanProps()` Returns the list of properties of this bean as an array.
`protected Iterator`	`beanPropsIterator()` Returns the list of properties of this bean as an array.
`protected void`	`buildPathName(StringBuffer str)` Build the current path up to the root node.
`void`	`changeDocType(String publicId, String systemId)`
`BaseBean[]`	`childBeans(boolean recursive)`
`void`	`childBeans(boolean recursive, List beans)` Store all child beans into @param beans.
`Object`	`clone()` Process a deep clone() of the current bean
`Comment[]`	`comments()`
`protected void`	`copyProperty(BeanProp prop, BaseBean bean, int index, Object value)`
`void`	`createAttribute(String dtdName, String name, int type, String[] values, String defValue)` Create a new attribute on the current bean.
`void`	`createAttribute(String propName, String dtdName, String name, int type, String[] values, String defValue)` Create a new attribute for the property propertyName.
`void`	`createBean(Node node, GraphManager mgr)`
`static BaseBean`	`createGraph(Class clazz, InputStream in)` Create the schema2beans graph of root bean clazz, from the input stream.
`static BaseBean`	`createGraph(Class clazz, InputStream in, boolean validate)` Create the schema2beans graph of root bean clazz, from the input stream in using the validate option.
`static BaseBean`	`createGraph(Class clazz, InputStream in, boolean validate, EntityResolver er)` Create the schema2beans graph of root bean clazz, from the input stream in using the validate option and the entity resolver er.
`static BaseBean`	`createGraph(Class clazz, InputStream in, boolean validate, EntityResolver er, ErrorHandler eh)` Create the schema2beans graph of root bean clazz, from the input stream in and using the validate, er and sh options.
`void`	`createProperty(String dtdName, String beanName, Class type)` Create a new property for the current bean, selecting default option values.
`void`	`createProperty(String dtdName, String beanName, int option, Class type)` Create a new property for the current bean.
`void`	`createRoot(String dtdName, String beanName, int option, Class type)` Create the root element of the graph
`protected DOMBinding`	`domBinding()`
`String`	`dtdName()` Return the DTD name of this schema2beans graph node.
`abstract void`	`dump(StringBuffer str, String indent)`
`void`	`dumpAttributes(String name, int index, StringBuffer str, String indent)`
`String`	`dumpBeanNode()`
`String`	`dumpDomNode()`
`String`	`dumpDomNode(int depth)`
`String`	`dumpDomNode(String nodeName, int depth)` Dump the DOM content of this bean.
`void`	`dumpXml()`
`String[]`	`findAttributeValue(String attrName, String value)` Search for a specific attribute name/value.
`String[]`	`findPropertyValue(String propName, Object value)` Search for a specfic property name/value.
`String[]`	`findValue(Object value)` Search for any property or attribute of the specified value.
`String`	`fullName()` Return the path name of this element in the graph.
`String[]`	`getAttributeNames()` Return the list of all known attribute names for the current bean
`String[]`	`getAttributeNames(String propName)` Return the list of all known attribute names for this property (even if they are not set).
`String`	`getAttributeValue(String name)` Get the attribute value on the current property bean.
`String`	`getAttributeValue(String propName, int index, String name)` Get the attribute value (see BeanProp class)
`String`	`getAttributeValue(String propName, String name)` Get the attribute value (see BeanProp class)
`String`	`getDefaultNamespace()`
`BaseProperty`	`getProperty()` Return the BaseProperty object for the current bean
`BaseProperty`	`getProperty(String propName)` Return the BaseProperty object for the specified property
`Object`	`getValue(String name)` Return the value of the single property named name.
`Object`	`getValue(String name, int index)` Return one element of the indexed property named name.
`Object`	`getValueById(String name, int id)` Return one element of the index property using the internal id index value.
`Object[]`	`getValues(String name)` Return the values of the indexed property named name.
`GraphManager`	`graphManager()` Return the unique graphManager instance of the schema2beans graph
`protected boolean`	`hasDomNode()`
`boolean`	`hasName(String name)`
`int`	`idToIndex(String name, int id)` Convert an unique internal index value into the user visible index value.
`int`	`indexOf(String name, Object value)` Returns the position of the indexed property element.
`int`	`indexToId(String name, int index)` Convert the user index value into the internal unique index value.
`protected void`	`init(Vector comps, Version version)`
`protected void`	`initPropertyTables(int propertyCount)`
`boolean`	`isChoiceProperty()` Gets the value of the property choiceProperty.
`boolean`	`isChoiceProperty(String name)` Return true if the property name is a choice property (defined in the DTD with the \| char, such as (a \| b \| c ...)
`boolean`	`isEqualTo(Object obj)` Perform a deep recursive comparison.
`boolean`	`isNull(String name)` Return true if this property is null
`boolean`	`isNull(String name, int index)` Return true if this property is null
`boolean`	`isRoot()` Return true if this element is the root of the schema2beans tree.
`Object[]`	`knownValues(String name)` Return the known values as declared in the mdd file.
`BaseAttribute[]`	`listAttributes()` Return the list of all known attribute names for the current bean
`BaseAttribute[]`	`listAttributes(String propName)` Return the list of all known attribute names for this property (even if they are not set).
`Iterator`	`listChoiceProperties()` Returns an iterator on the list of the sets of choice properties.
`BaseProperty[]`	`listChoiceProperties(String name)` If the property name is a choice property, returns the list of all the properties associated to this property (this one included).
`BaseProperty[]`	`listProperties()` Return the list of the properties
`void`	`merge(BaseBean bean)` Merge the bean tree with the current graph using the default merging option.
`void`	`merge(BaseBean bean, int mode)` Merge the specified bean schema2beans graph into the current graph using the specified mode.
`void`	`mergeUpdate(BaseBean sourceBean)` Same as merge(BaseBean bean).
`String`	`name()` Return the bean name of this schema2beans graph node.
`String`	`nameChild(Object childObj)`
`String`	`nameChild(Object childObj, boolean returnConstName, boolean returnSchemaName)`
`String`	`nameChild(Object childObj, boolean returnConstName, boolean returnSchemaName, boolean returnXPathName)`
`String`	`nameSelf()`
`BaseBean`	`newInstance(String name)` Return a new instance of the specified bean property
`BaseBean`	`parent()` Return the BaseBean parent of the current bean.
`Bean`	`propertyById(String name, int id)` Get the bean using its unique identifier.
`void`	`reindent()` Rearrange the internal whitespace so that when it gets printed out, it looks pretty.
`void`	`reindent(String indent)`
`void`	`removeBeanComparator(BeanComparator cmp)`
`void`	`removeComment(Comment comment)` Remove @param comment from this bean.
`void`	`removePropertyChangeListener(PropertyChangeListener l)`
`void`	`removePropertyChangeListener(String n, PropertyChangeListener l)`
`protected void`	`removeValue(BeanProp prop, int index)`
`protected int`	`removeValue(BeanProp prop, Object value)`
`void`	`removeValue(String name, int index)` Remove a value from the indexed property named name.
`int`	`removeValue(String name, Object value)` Remove a value from the indexed property named name.
`void`	`setAttributeValue(String propName, int index, String name, String value)` Set the value of the attribute (see the BeanClass class)
`void`	`setAttributeValue(String name, String value)` Set the attribute value on the current property bean
`void`	`setAttributeValue(String propName, String name, String value)` Set the value of the attribute (see the BeanClass class)
`void`	`setDefaultNamespace(String namespace)`
`protected void`	`setDomBinding(DOMBinding binding)`
`protected void`	`setGraphManager(GraphManager graphMgr)`
`protected void`	`setValue(BeanProp prop, int index, Object value)`
`void`	`setValue(String name, int index, Object value)` Set the value of an element for the indexed property named name.
`void`	`setValue(String name, Object value)` Set the value for the single property named name.
`void`	`setValue(String name, Object[] value)` Set the values for the indexed property named name.
`void`	`setValueById(String name, int id, Object value)` Set the value of an element for the indexed property named name, using the unique internal index.
`int`	`size(String name)` Return the size of the indexed property named name (the size might be greater than the number of elements if the indexed property array contains null elements).
`String`	`toString()`
`void`	`write(File f)`
`void`	`write(OutputStream out)` Write the current schema2beans graph as an XML document.
`void`	`write(OutputStream out, String encoding)` Write the current schema2beans graph as an XML document.
`void`	`write(Writer w)` If you call this method, you're responsible for setting up the right encoding for the Writer @param w.
`void`	`write(Writer w, String encoding)` If you call this method, you're responsible for setting up the right encoding for the Writer @param w.
`void`	`writeNode(Writer out)`
`void`	`writeNoReindent(OutputStream out)`

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

- Property Detail
  - isChoice
```
public boolean isChoiceProperty
```
    Gets the value of the property choiceProperty.
- Field Detail
  - binding
```
protected DOMBinding binding
```
  - graphManager
```
protected GraphManager graphManager
```
  - MERGE_NONE
```
public static final int MERGE_NONE
```
    Merge the bean tree with ourself Let's define: G1 the current graph and G2 the new graph we want to merge E1 the set of element of G1 that don't exist anymore in G2. E2 the set of new elements of G2 that don't exist in G1. Then, UPDATE is G1 - E1 + E2 (G1 becomes G2) UNION is G1 U G2 <=> G1 + E2 INTERSECT is G1 n G2 <=> (G1 U G2) - E1 - E2
    
    See Also:
    
    Constant Field Values
  - MERGE_INTERSECT
```
public static final int MERGE_INTERSECT
```
    See Also:
    
    Constant Field Values
  - MERGE_UNION
```
public static final int MERGE_UNION
```
    See Also:
    
    Constant Field Values
  - MERGE_UPDATE
```
public static final int MERGE_UPDATE
```
    See Also:
    
    Constant Field Values
  - MERGE_COMPARE
```
public static final int MERGE_COMPARE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - BaseBean
```
public BaseBean(Vector comps,
                Version version)
```
    Parameters:
    
    comps - the comparators to use. Can be null
    
    version - which runtime version to be compatible with. This should be the version of the generated beans.
- Method Detail
  - init
```
protected void init(Vector comps,
                    Version version)
```
  - initPropertyTables
```
protected void initPropertyTables(int propertyCount)
```
  - addBeanComparator
```
public void addBeanComparator(BeanComparator cmp)
```
  - removeBeanComparator
```
public void removeBeanComparator(BeanComparator cmp)
```
  - createProperty
```
public void createProperty(String dtdName,
                           String beanName,
                           Class type)
```
    Create a new property for the current bean, selecting default option values.
  - createRoot
```
public void createRoot(String dtdName,
                       String beanName,
                       int option,
                       Class type)
                throws Schema2BeansRuntimeException
```
    Create the root element of the graph
    
    Throws:
    
    Schema2BeansRuntimeException
  - createProperty
```
public void createProperty(String dtdName,
                           String beanName,
                           int option,
                           Class type)
                    throws Schema2BeansRuntimeException
```
    Create a new property for the current bean. This creates a BeanProp object (which is the internal representation of a single/indexed property) and adds it to the bean property hash table. This property is later accessed by its bean name.
    
    Throws:
    
    Schema2BeansRuntimeException
  - setDefaultNamespace
```
public void setDefaultNamespace(String namespace)
```
  - getDefaultNamespace
```
public String getDefaultNamespace()
```
  - beanProps
```
public BeanProp[] beanProps()
```
    Returns the list of properties of this bean as an array.
  - beanPropsIterator
```
protected Iterator beanPropsIterator()
```
    Returns the list of properties of this bean as an array.
  - beanProp
```
public BeanProp beanProp(String name)
```
    Return the internal object representation of the property. This method cannot return null. If there is no object available for the specified property name, an exception is thrown.
    
    Specified by:
    
    beanProp in interface Bean
    
    Returns:
    
    a representation of the property. This method does not return null. If there is no object available for the specified property name, an exception is thrown.
  - beanProp
```
public BeanProp beanProp(int order)
```
    Return the internal object representation of the property. This method cannot return null. If there is no object available for the specified property name, an exception is thrown.
  - getValue
```
public Object getValue(String name)
```
    Return the value of the single property named name.
    
    Specified by:
    
    getValue in interface Bean
  - getValue
```
public Object getValue(String name,
                       int index)
```
    Return one element of the indexed property named name.
    
    Specified by:
    
    getValue in interface Bean
  - getValueById
```
public Object getValueById(String name,
                           int id)
```
    Return one element of the index property using the internal id index value. This index is unique and doesn't change over the time of the graph life. This method allows to get an element of an indexed property without keeping track of index shifting, and other elements removal.
    
    Specified by:
    
    getValueById in interface Bean
  - idToIndex
```
public int idToIndex(String name,
                     int id)
```
    Convert an unique internal index value into the user visible index value. The property name specified must be an indexed property. This method may return -1 if we cannot figure out the index.
    
    Specified by:
    
    idToIndex in interface Bean
  - indexToId
```
public int indexToId(String name,
                     int index)
```
    Convert the user index value into the internal unique index value. The property name specified must be an indexed property.
    
    Specified by:
    
    indexToId in interface Bean
  - isNull
```
public boolean isNull(String name)
```
    Return true if this property is null
  - isNull
```
public boolean isNull(String name,
                      int index)
```
    Return true if this property is null
  - getValues
```
public Object[] getValues(String name)
```
    Return the values of the indexed property named name. The result can be cast as an array of the property type.
    
    Specified by:
    
    getValues in interface Bean
  - setValue
```
public void setValue(String name,
                     Object value)
```
    Set the value for the single property named name.
    
    Specified by:
    
    setValue in interface Bean
  - setValue
```
public void setValue(String name,
                     int index,
                     Object value)
```
    Set the value of an element for the indexed property named name.
    
    Specified by:
    
    setValue in interface Bean
  - setValue
```
protected void setValue(BeanProp prop,
                        int index,
                        Object value)
```
  - addValue
```
protected int addValue(BeanProp prop,
                       Object value)
```
  - removeValue
```
protected int removeValue(BeanProp prop,
                          Object value)
```
  - removeValue
```
protected void removeValue(BeanProp prop,
                           int index)
```
  - setValueById
```
public void setValueById(String name,
                         int id,
                         Object value)
```
    Set the value of an element for the indexed property named name, using the unique internal index.
    
    Specified by:
    
    setValueById in interface Bean
  - setValue
```
public void setValue(String name,
                     Object[] value)
```
    Set the values for the indexed property named name.
  - addValue
```
public int addValue(String name,
                    Object value)
```
    Add a value to the indexed property named name.
    
    Specified by:
    
    addValue in interface Bean
  - removeValue
```
public int removeValue(String name,
                       Object value)
```
    Remove a value from the indexed property named name.
    
    Specified by:
    
    removeValue in interface Bean
  - removeValue
```
public void removeValue(String name,
                        int index)
```
    Remove a value from the indexed property named name.
  - indexOf
```
public int indexOf(String name,
                   Object value)
            throws Schema2BeansRuntimeException
```
    Returns the position of the indexed property element. If the type of the property is a bean, use the == comparison, else use the equals() method. If the element is not found, return -1.
    
    Throws:
    
    Schema2BeansRuntimeException
  - size
```
public int size(String name)
```
    Return the size of the indexed property named name (the size might be greater than the number of elements if the indexed property array contains null elements).
  - isChoiceProperty
```
public boolean isChoiceProperty(String name)
```
    Return true if the property name is a choice property (defined in the DTD with the | char, such as (a | b | c ...)
  - isChoiceProperty
```
public boolean isChoiceProperty()
```
    Gets the value of the property choiceProperty.
  - listChoiceProperties
```
public BaseProperty[] listChoiceProperties(String name)
```
    If the property name is a choice property, returns the list of all the properties associated to this property (this one included). Return null otherwise.
  - listChoiceProperties
```
public Iterator listChoiceProperties()
```
    Returns an iterator on the list of the sets of choice properties. Each object of the returned iterator is an array of BaseProperty. The returned value is never null be can be empty.
  - listProperties
```
public BaseProperty[] listProperties()
```
    Return the list of the properties
    
    Specified by:
    
    listProperties in interface Bean
  - getProperty
```
public BaseProperty getProperty()
```
    Return the BaseProperty object for the current bean
    
    Specified by:
    
    getProperty in interface Bean
  - getProperty
```
public BaseProperty getProperty(String propName)
```
    Return the BaseProperty object for the specified property
    
    Specified by:
    
    getProperty in interface Bean
  - knownValues
```
public Object[] knownValues(String name)
```
    Return the known values as declared in the mdd file.
  - addKnownValue
```
protected void addKnownValue(String name,
                             Object value)
```
  - createAttribute
```
public void createAttribute(String dtdName,
                            String name,
                            int type,
                            String[] values,
                            String defValue)
```
    Create a new attribute on the current bean.
  - createAttribute
```
public void createAttribute(String propName,
                            String dtdName,
                            String name,
                            int type,
                            String[] values,
                            String defValue)
```
    Create a new attribute for the property propertyName. This creates the attribute within the BeanProp associated to the property.
  - setAttributeValue
```
public void setAttributeValue(String propName,
                              String name,
                              String value)
```
    Set the value of the attribute (see the BeanClass class)
  - setAttributeValue
```
public void setAttributeValue(String name,
                              String value)
```
    Set the attribute value on the current property bean
  - getAttributeValue
```
public String getAttributeValue(String name)
```
    Get the attribute value on the current property bean. If there is no current attribute (or element for that matter), then null is returned.
  - getAttributeValue
```
public String getAttributeValue(String propName,
                                String name)
```
    Get the attribute value (see BeanProp class)
  - setAttributeValue
```
public void setAttributeValue(String propName,
                              int index,
                              String name,
                              String value)
```
    Set the value of the attribute (see the BeanClass class)
  - getAttributeValue
```
public String getAttributeValue(String propName,
                                int index,
                                String name)
```
    Get the attribute value (see BeanProp class)
  - getAttributeNames
```
public String[] getAttributeNames(String propName)
```
    Return the list of all known attribute names for this property (even if they are not set).
  - getAttributeNames
```
public String[] getAttributeNames()
```
    Return the list of all known attribute names for the current bean
  - listAttributes
```
public BaseAttribute[] listAttributes(String propName)
```
    Return the list of all known attribute names for this property (even if they are not set).
  - listAttributes
```
public BaseAttribute[] listAttributes()
```
    Return the list of all known attribute names for the current bean
  - findAttributeValue
```
public String[] findAttributeValue(String attrName,
                                   String value)
```
    Search for a specific attribute name/value.
  - findPropertyValue
```
public String[] findPropertyValue(String propName,
                                  Object value)
```
    Search for a specfic property name/value.
  - findValue
```
public String[] findValue(Object value)
```
    Search for any property or attribute of the specified value.
  - write
```
public void write(File f)
           throws IOException,
                  Schema2BeansRuntimeException
```
    Throws:
    
    IOException
    
    Schema2BeansRuntimeException
  - write
```
public void write(OutputStream out)
           throws IOException,
                  Schema2BeansRuntimeException
```
    Write the current schema2beans graph as an XML document.
    
    Throws:
    
    IOException
    
    Schema2BeansRuntimeException
  - write
```
public void write(OutputStream out,
                  String encoding)
           throws IOException,
                  Schema2BeansException
```
    Write the current schema2beans graph as an XML document. The parameter @param encoding tells us to write to @param out using that encoding.
    
    Throws:
    
    IOException
    
    Schema2BeansException
  - write
```
public void write(Writer w)
           throws IOException,
                  Schema2BeansException
```
    If you call this method, you're responsible for setting up the right encoding for the Writer @param w.
    
    Throws:
    
    IOException
    
    Schema2BeansException
  - write
```
public void write(Writer w,
                  String encoding)
           throws IOException,
                  Schema2BeansException
```
    If you call this method, you're responsible for setting up the right encoding for the Writer @param w. The @param encoding parameter is there to let us know which encoding you picked so that it can be written to the header.
    
    Throws:
    
    IOException
    
    Schema2BeansException
  - writeNoReindent
```
public void writeNoReindent(OutputStream out)
                     throws IOException,
                            Schema2BeansException
```
    Throws:
    
    IOException
    
    Schema2BeansException
  - writeNode
```
public void writeNode(Writer out)
               throws IOException
```
    Throws:
    
    IOException
  - reindent
```
public void reindent()
```
    Rearrange the internal whitespace so that when it gets printed out, it looks pretty.
  - reindent
```
public void reindent(String indent)
```
  - hasDomNode
```
protected boolean hasDomNode()
```
  - domBinding
```
protected DOMBinding domBinding()
```
  - setDomBinding
```
protected void setDomBinding(DOMBinding binding)
```
  - graphManager
```
public GraphManager graphManager()
```
    Return the unique graphManager instance of the schema2beans graph
  - setGraphManager
```
protected void setGraphManager(GraphManager graphMgr)
```
  - buildPathName
```
protected void buildPathName(StringBuffer str)
```
    Build the current path up to the root node. See the BeanProp object for more details.
  - clone
```
public Object clone()
```
    Process a deep clone() of the current bean
    
    Overrides:
    
    clone in class Object
  - merge
```
public void merge(BaseBean bean,
                  int mode)
```
    Merge the specified bean schema2beans graph into the current graph using the specified mode.
  - merge
```
public void merge(BaseBean bean)
```
    Merge the bean tree with the current graph using the default merging option.
  - mergeUpdate
```
public void mergeUpdate(BaseBean sourceBean)
```
    Same as merge(BaseBean bean). It's possible to override this method and make it more efficient, than the generic one.
  - copyProperty
```
protected void copyProperty(BeanProp prop,
                            BaseBean bean,
                            int index,
                            Object value)
```
  - isEqualTo
```
public boolean isEqualTo(Object obj)
```
    Perform a deep recursive comparison. Return true if the two graphs are equals, false otherwise. The comparison is using the comparators and therfore returns a result wrt to the comparators. That means a true return value only means that the graphs are logically equals depending on the comparator implementation. Note that the default comparator compares every property value.
  - propertyById
```
public Bean propertyById(String name,
                         int id)
```
    Get the bean using its unique identifier. This identifier is not the indexed position of the element in the array but a unique id associated to the DOMBinding object (see the BeanProp and DOMBinding classes)
    
    Specified by:
    
    propertyById in interface Bean
  - beanProp
```
public BeanProp beanProp()
```
    Return the BeanProp object where this bean belongs.
  - parent
```
public BaseBean parent()
```
    Return the BaseBean parent of the current bean. This might return null either because this is the root of the graph or because this node is not part of a schema2beans graph yet.
  - _getParent
```
public Bean _getParent()
```
    Specified by:
    
    _getParent in interface Bean
  - _getRoot
```
public Bean _getRoot()
```
    Return the root of the graph. If the graph is not connected to a generated root, then the topmost bean is returned.
    
    Specified by:
    
    _getRoot in interface Bean
  - fullName
```
public String fullName()
```
    Return the path name of this element in the graph.
  - hasName
```
public boolean hasName(String name)
```
    Specified by:
    
    hasName in interface Bean
  - isRoot
```
public boolean isRoot()
```
    Return true if this element is the root of the schema2beans tree.
    
    Specified by:
    
    isRoot in interface Bean
  - name
```
public String name()
```
    Return the bean name of this schema2beans graph node.
    
    Specified by:
    
    name in interface Bean
  - dtdName
```
public String dtdName()
```
    Return the DTD name of this schema2beans graph node.
    
    Specified by:
    
    dtdName in interface Bean
    
    Returns:
    
    the schema name of this bean as define by this bean's parent.
  - createBean
```
public void createBean(Node node,
                       GraphManager mgr)
                throws Schema2BeansRuntimeException
```
    Throws:
    
    Schema2BeansRuntimeException
  - newInstance
```
public BaseBean newInstance(String name)
```
    Return a new instance of the specified bean property
  - dump
```
public abstract void dump(StringBuffer str,
                          String indent)
```
  - dumpDomNode
```
public String dumpDomNode(String nodeName,
                          int depth)
```
    Dump the DOM content of this bean. If nodeName is specified, dump only from the subname named nodeName.
  - dumpDomNode
```
public String dumpDomNode(int depth)
```
  - dumpDomNode
```
public String dumpDomNode()
```
  - dumpBeanNode
```
public String dumpBeanNode()
```
  - dumpAttributes
```
public void dumpAttributes(String name,
                           int index,
                           StringBuffer str,
                           String indent)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - dumpXml
```
public void dumpXml()
```
  - createGraph
```
public static BaseBean createGraph(Class clazz,
                                   InputStream in)
                            throws Schema2BeansException
```
    Create the schema2beans graph of root bean clazz, from the input stream.
    
    Throws:
    
    Schema2BeansException
  - createGraph
```
public static BaseBean createGraph(Class clazz,
                                   InputStream in,
                                   boolean validate)
                            throws Schema2BeansException
```
    Create the schema2beans graph of root bean clazz, from the input stream in using the validate option.
    
    Throws:
    
    Schema2BeansException
  - createGraph
```
public static BaseBean createGraph(Class clazz,
                                   InputStream in,
                                   boolean validate,
                                   EntityResolver er)
                            throws Schema2BeansException
```
    Create the schema2beans graph of root bean clazz, from the input stream in using the validate option and the entity resolver er.
    
    Throws:
    
    Schema2BeansException
  - createGraph
```
public static BaseBean createGraph(Class clazz,
                                   InputStream in,
                                   boolean validate,
                                   EntityResolver er,
                                   ErrorHandler eh)
                            throws Schema2BeansException
```
    Create the schema2beans graph of root bean clazz, from the input stream in and using the validate, er and sh options.
    
    Throws:
    
    Schema2BeansException
  - addPropertyChangeListener
```
public void addPropertyChangeListener(PropertyChangeListener l)
```
    Specified by:
    
    addPropertyChangeListener in interface Bean
  - removePropertyChangeListener
```
public void removePropertyChangeListener(PropertyChangeListener l)
```
    Specified by:
    
    removePropertyChangeListener in interface Bean
  - addPropertyChangeListener
```
public void addPropertyChangeListener(String n,
                                      PropertyChangeListener l)
```
  - removePropertyChangeListener
```
public void removePropertyChangeListener(String n,
                                         PropertyChangeListener l)
```
  - comments
```
public Comment[] comments()
```
    Returns:
    
    all Comment nodes found in this particular bean. If there are no comments, then a 0 sized array will be returned. null will never be returned. If you want to change a comment, use Comment.setData().
  - addComment
```
public Comment addComment(String comment)
```
    The new comment will be added to the first of the bean's children.
    
    Returns:
    
    the newly added Comment
    
    Throws:
    
    NullPointerException - if this is a nonroot bean that is not part of a rooted graph yet.
  - removeComment
```
public void removeComment(Comment comment)
```
    Remove @param comment from this bean.
  - childBeans
```
public BaseBean[] childBeans(boolean recursive)
```
    Returns:
    
    child beans.
  - childBeans
```
public void childBeans(boolean recursive,
                       List beans)
```
    Store all child beans into @param beans.
    
    Specified by:
    
    childBeans in interface Bean
  - nameSelf
```
public String nameSelf()
```
  - nameChild
```
public String nameChild(Object childObj)
```
  - nameChild
```
public String nameChild(Object childObj,
                        boolean returnConstName,
                        boolean returnSchemaName)
```
  - nameChild
```
public String nameChild(Object childObj,
                        boolean returnConstName,
                        boolean returnSchemaName,
                        boolean returnXPathName)
```
  - changeDocType
```
public void changeDocType(String publicId,
                          String systemId)
```
  - _setChanged
```
public void _setChanged(boolean changed)
```
  - _getXPathExpr
```
public String _getXPathExpr()
```
  - _getXPathExpr
```
public String _getXPathExpr(Object childObj)
```

Class BaseBean

Property Summary

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

isChoice

Field Detail

binding

graphManager

MERGE_NONE

MERGE_INTERSECT

MERGE_UNION

MERGE_UPDATE

MERGE_COMPARE

Constructor Detail

BaseBean

Method Detail

init

initPropertyTables

addBeanComparator

removeBeanComparator

createProperty

createRoot

createProperty

setDefaultNamespace

getDefaultNamespace

beanProps

beanPropsIterator

beanProp

beanProp

getValue

getValue

getValueById

idToIndex

indexToId

isNull

isNull

getValues

setValue

setValue

setValue

addValue

removeValue

removeValue

setValueById

setValue

addValue

removeValue

removeValue

indexOf

size

isChoiceProperty

isChoiceProperty

listChoiceProperties

listChoiceProperties

listProperties

getProperty

getProperty

knownValues

addKnownValue

createAttribute

createAttribute

setAttributeValue

setAttributeValue

getAttributeValue

getAttributeValue

setAttributeValue

getAttributeValue

getAttributeNames

getAttributeNames

listAttributes

listAttributes

findAttributeValue

findPropertyValue

findValue

write

write