org.netbeans.modules.schema2beans

Class BeanProp

java.lang.Object

org.netbeans.modules.schema2beans.BeanProp

All Implemented Interfaces:

BaseProperty

Direct Known Subclasses:

ReflectiveBeanProp

public class BeanProp
extends Object
implements BaseProperty

The BeanProp class is the internal representation of a schema2beans property. The three main classes that make the schema2beans architecture are: BaseBean, BeanProp and DOMBinding. BaseBean is the schema2beans java beans that maps a tag DTD element (BaseBean is the class extended by the generated code, specific to the DTD names). BaseBean contains as much as BeanProp object instances as it containes properties (element tags). A BeanProp handle both single and array properties. A single property is represented by one BeanProp instance that will be of type 'single' (TYPE_0_1 or TYPE_1). An array property is represented also by one BeanProp instance, but of type 'array' (TYPE_0_N or TYPE_1_N). The BeanProp class is handling properties, and is acting between the BaseBean (user view) and the DOMBinding (access to the DOM tree). The events, add/change/remove code and logic is on the BeanProp class.

Property Summary

Type	Property and Description
boolean	isChoice Gets the value of the property choiceProperty.

Nested Class Summary

Nested classes/interfaces inherited from interface org.netbeans.modules.schema2beans.BaseProperty

BaseProperty.VetoException

Field Summary

Fields

Modifier and Type	Field and Description
String	beanName
String	dtdName
Class	propClass
int	type

Fields inherited from interface org.netbeans.modules.schema2beans.BaseProperty

INSTANCE_MANDATORY_ARRAY, INSTANCE_MANDATORY_ELT, INSTANCE_OPTIONAL_ARRAY, INSTANCE_OPTIONAL_ELT

Constructor Summary

Constructors

Constructor and Description
BeanProp(BaseBean bean, String dtdName, String beanName, int type, Class propClass)
BeanProp(BaseBean bean, String dtdName, String beanName, int type, Class propClass, boolean isRoot)
BeanProp(BaseBean bean, String dtdName, String beanName, int type, Class propClass, boolean isRoot, int initialCapacity)
BeanProp(BaseBean bean, String dtdName, String beanName, int type, Class propClass, int initialCapacity)

Method Summary

Modifier and Type	Method and Description
protected void	addKnownValue(Object value)
void	addPCListener(PropertyChangeListener l) Book-keeping of the listeners
int	addValue(Object value) Add a value at the end of the indexed property
void	addVCListener(VetoableChangeListener l)
protected int	bindingsSize()
void	createAttribute(String dtdName, String name, int type, String[] values, String defValue) Attributes definition live in the BeanProp object while attribute values live in the DOMBinding objects.
void	createTransientAttribute(String dtdName) When the bean tree is built from an XML document and an attribute not defined in the DTD is found, the attribute is dynamically added to the list of defined attribute with the TRANSIENT status.
String[]	getAttributeNames() Misc: returns an array of the attribute names
BaseAttribute[]	getAttributes() Misc: convert the ArrayList into an array of AttrProp
String	getAttributeValue(int index, String name) Get the attribute value
AttrProp	getAttrProp(String name) Misc: return the property of name 'name'
AttrProp	getAttrProp(String name, boolean quiet) Return the property name AttrProp
BaseBean	getBean()
String	getBeanName()
BaseProperty[]	getChoiceProperties() If this property is a choice property, returns all other choice properties associated to this one (including this one).
String	getDtdName() Return the dtd name of the property, as it appears in the DTD file.
String	getFullName()
String	getFullName(int index) Returns the full path name of the property (unique String name identifying the property for the lifetime of the graph).
int	getInstanceType() Returns the instanciation type of the property.
String	getName() Return the name of the property as it is used in the bean class.
protected Object[]	getObjectArray(int extraElements)
BaseBean	getParent() Return the BaseBean for this property if there is one
Class	getPropClass()
Class	getPropertyClass() Return the class type of the property.
int	getType()
Object	getValue(int index)
Object	getValueById(int id) Return the element which as the unique DOMBinding identifier id (Every DOMBinding has a unique identifier which identifies uniquely the DOM element referenced by the DOMBinding object.
Object[]	getValues() If the property is an indexed property, return all the values as an array of its type.
boolean	hasName(String name) Return true if the name is either equals to getName() or getDtdName()
int	idToIndex(int id) Convert a unique DOMBinding Id into a relative index value This method may return -1 if we cannot figure out the index.
int	indexToId(int index) Convert the relative index value (the property index value) into the unique DOMBinding id.
void	initialize() Called by the BaseBean class when the property is fully created.
boolean	isBean() Return true if the property is a bean (a node in the graph).
boolean	isChoiceProperty() Gets the value of the property choiceProperty.
boolean	isIndexed() Return true if the property is an indexed property.
boolean	isKey() Return true if this property matters when schema2beans compare graphs
boolean	isRoot() Return true if this is the root property
Object[]	knownValues()
DOMBinding	registerDomNode(Node node, DOMBinding binding, BaseBean bean) This method is called to associate this bean property to a DOM Node.
void	removePCListener(PropertyChangeListener l)
void	removeValue(int index)
int	removeValue(Object value) Remove the object that have the bean value (.equals call) removeValue do not leave null slots as the setValue does.
void	removeVCListener(VetoableChangeListener l)
void	setAttributeValue(int index, String name, String value) Set the value of the attribute
protected int	setElement(int index, Object value, boolean add) Different cases might happen in this method, depending on the type of the property, if the property is an array or not, and also depending on the type of the value parameter.
void	setValue(int index, Object value) Set the value for one element of an indexed property
void	setValue(Object[] value) Set the whole index property.
int	size() If the property is an indexed property, return the number of element (might contain null elements).
String	toString()

Methods inherited from class java.lang.Object

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

Property Detail

isChoice

public boolean isChoiceProperty

Gets the value of the property choiceProperty.

Specified by:

isChoiceProperty in interface BaseProperty

Field Detail

dtdName

public String dtdName

beanName

public String beanName

type

public int type

propClass

public Class propClass

Constructor Detail

BeanProp

public BeanProp(BaseBean bean,
                String dtdName,
                String beanName,
                int type,
                Class propClass)

BeanProp

public BeanProp(BaseBean bean,
                String dtdName,
                String beanName,
                int type,
                Class propClass,
                int initialCapacity)

BeanProp

public BeanProp(BaseBean bean,
                String dtdName,
                String beanName,
                int type,
                Class propClass,
                boolean isRoot)

BeanProp

public BeanProp(BaseBean bean,
                String dtdName,
                String beanName,
                int type,
                Class propClass,
                boolean isRoot,
                int initialCapacity)

Method Detail

initialize

public void initialize()

Called by the BaseBean class when the property is fully created. (no more creation work needs to be done in the BaseBean for this property.). This is where any extra initialization work should take place if this couldn't be done in the constructor.

getPropClass

public Class getPropClass()

getType

public int getType()

getBeanName

public String getBeanName()

getBean

public BaseBean getBean()

getParent

public BaseBean getParent()

Description copied from interface: BaseProperty

Return the BaseBean for this property if there is one

Specified by:

getParent in interface BaseProperty

bindingsSize

protected int bindingsSize()

getValue

public Object getValue(int index)

getValueById

public Object getValueById(int id)

Return the element which as the unique DOMBinding identifier id (Every DOMBinding has a unique identifier which identifies uniquely the DOM element referenced by the DOMBinding object. This id is, for example, used to build the absolute name of an elt of the graph)

indexToId

public int indexToId(int index)

Convert the relative index value (the property index value) into the unique DOMBinding id.

idToIndex

public int idToIndex(int id)

Convert a unique DOMBinding Id into a relative index value This method may return -1 if we cannot figure out the index.

getObjectArray

protected Object[] getObjectArray(int extraElements)

getValues

public Object[] getValues()

If the property is an indexed property, return all the values as an array of its type.

setValue

public void setValue(Object[] value)

Set the whole index property. Element might have changed, been removed added or just mixed.

setValue

public void setValue(int index,
                     Object value)

Set the value for one element of an indexed property

addValue

public int addValue(Object value)

Add a value at the end of the indexed property

removeValue

public int removeValue(Object value)

Remove the object that have the bean value (.equals call) removeValue do not leave null slots as the setValue does. Remove tries first to find out the same object reference within the list of properties values. If not, it tries to find out an object which is equal.

removeValue

public void removeValue(int index)

setElement

protected int setElement(int index,
                         Object value,
                         boolean add)

Different cases might happen in this method, depending on the type of the property, if the property is an array or not, and also depending on the type of the value parameter. If the property is a single property, the value replaces the previous value. If the property is an indexed value, the operation is not allowed. If the propery didn't have any value (no DOM node yet), a DOMBinding is created and takes care of setting the new value.

knownValues

public Object[] knownValues()

addKnownValue

protected void addKnownValue(Object value)

createAttribute

public void createAttribute(String dtdName,
                            String name,
                            int type,
                            String[] values,
                            String defValue)

Attributes definition live in the BeanProp object while attribute values live in the DOMBinding objects.

createTransientAttribute

public void createTransientAttribute(String dtdName)

When the bean tree is built from an XML document and an attribute not defined in the DTD is found, the attribute is dynamically added to the list of defined attribute with the TRANSIENT status.

getAttributes

public BaseAttribute[] getAttributes()

Misc: convert the ArrayList into an array of AttrProp

Specified by:

getAttributes in interface BaseProperty

getAttributeNames

public String[] getAttributeNames()

Misc: returns an array of the attribute names

Specified by:

getAttributeNames in interface BaseProperty

getAttrProp

public AttrProp getAttrProp(String name,
                            boolean quiet)

Return the property name AttrProp

getAttrProp

public AttrProp getAttrProp(String name)

Misc: return the property of name 'name'

setAttributeValue

public void setAttributeValue(int index,
                              String name,
                              String value)

Set the value of the attribute

getAttributeValue

public String getAttributeValue(int index,
                                String name)

Get the attribute value

addPCListener

public void addPCListener(PropertyChangeListener l)

Book-keeping of the listeners

removePCListener

public void removePCListener(PropertyChangeListener l)

addVCListener

public void addVCListener(VetoableChangeListener l)

removeVCListener

public void removeVCListener(VetoableChangeListener l)

registerDomNode

public DOMBinding registerDomNode(Node node,
                                  DOMBinding binding,
                                  BaseBean bean)
                           throws Schema2BeansException

This method is called to associate this bean property to a DOM Node. When the bean graph is built from the DOM graph, the DOM graph is parsed while trying to match the element names of the DOM graph with the property names of the bean graph. When a match is found between a bean property name and a DOM element name, this method is called to associate the DOM node to the bean. The bean property might be a simple String (#PCDATA in DTD) as the leaf of the bean graph, or a bean object, containing other beans. (One node of the bean graph). Whatever the case is, there is a DOM Node that correspond to this property. Also, the propery might be either a single value property or an array. In the first case, only one Node of the DOM graph can match the property (if not, this is fatal error in building the bean graph). In the second case, this property contains an array referencing the DOM graph. Note that the property might be of type: optional, mandatory, an array possibly empty or an array with at least one element. The verify() method might be called to check the consistency of the type of the property, especially after the bean graph is built or before a modified bean graph has to be saved. See also the DOMBinding class comments.

Throws:

Schema2BeansException

toString

public String toString()

Overrides:

toString in class Object

isRoot

public boolean isRoot()

Description copied from interface: BaseProperty

Return true if this is the root property

Specified by:

isRoot in interface BaseProperty

getName

public String getName()

Description copied from interface: BaseProperty

Return the name of the property as it is used in the bean class.

Specified by:

getName in interface BaseProperty

getDtdName

public String getDtdName()

Description copied from interface: BaseProperty

Return the dtd name of the property, as it appears in the DTD file.

Specified by:

getDtdName in interface BaseProperty

isIndexed

public boolean isIndexed()

Description copied from interface: BaseProperty

Return true if the property is an indexed property.

Specified by:

isIndexed in interface BaseProperty

getPropertyClass

public Class getPropertyClass()

Description copied from interface: BaseProperty

Return the class type of the property. If a wrapper is defined for the class, the class of the wrapper is returned instead of the java.lang.String class.

Specified by:

getPropertyClass in interface BaseProperty

isBean

public boolean isBean()

Description copied from interface: BaseProperty

Return true if the property is a bean (a node in the graph). Any object of the graph which is a bean is a subclass of BaseBean.

Specified by:

isBean in interface BaseProperty

size

public int size()

Description copied from interface: BaseProperty

If the property is an indexed property, return the number of element (might contain null elements).

Specified by:

size in interface BaseProperty

getFullName

public String getFullName(int index)

Description copied from interface: BaseProperty

Returns the full path name of the property (unique String name identifying the property for the lifetime of the graph).

Specified by:

getFullName in interface BaseProperty

getFullName

public String getFullName()

Specified by:

getFullName in interface BaseProperty

getInstanceType

public int getInstanceType()

Description copied from interface: BaseProperty

Returns the instanciation type of the property. This might be one of the following: INSTANCE_OPTIONAL_ELT INSTANCE_MANDATORY_ELT INSTANCE_OPTIONAL_ARRAY INSTANCE_MANDATORY_ARRAY

Specified by:

getInstanceType in interface BaseProperty

isChoiceProperty

public boolean isChoiceProperty()

Gets the value of the property choiceProperty.

Specified by:

isChoiceProperty in interface BaseProperty

getChoiceProperties

public BaseProperty[] getChoiceProperties()

Description copied from interface: BaseProperty

If this property is a choice property, returns all other choice properties associated to this one (including this one). If the current property is not a choice property, returns null.

Specified by:

getChoiceProperties in interface BaseProperty

hasName

public boolean hasName(String name)

Description copied from interface: BaseProperty

Return true if the name is either equals to getName() or getDtdName()

Specified by:

hasName in interface BaseProperty

isKey

public boolean isKey()

Description copied from interface: BaseProperty

Return true if this property matters when schema2beans compare graphs

Specified by:

isKey in interface BaseProperty