org.apache.commons.jxpath.ri.model.dynabeans
Class DynaBeanPropertyPointer

java.lang.Object
  |
  +--org.apache.commons.jxpath.ri.model.NodePointer
        |
        +--org.apache.commons.jxpath.ri.model.beans.PropertyPointer
              |
              +--org.apache.commons.jxpath.ri.model.dynabeans.DynaBeanPropertyPointer
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Comparable, Pointer, java.io.Serializable

public class DynaBeanPropertyPointer
extends PropertyPointer

Pointer pointing to a property of a DynaBean.

Version:
$Revision: 1.7 $ $Date: 2003/03/11 00:59:29 $
Author:
Dmitri Plotnikov
See Also:
Serialized Form

Fields inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyPointer
bean, propertyIndex, UNSPECIFIED_PROPERTY
 
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
 
Constructor Summary
DynaBeanPropertyPointer(NodePointer parent, org.apache.commons.beanutils.DynaBean dynaBean)
           
 
Method Summary
 java.lang.Object getBaseValue()
          Returns the value represented by the pointer before indexing.
 java.lang.Object getImmediateNode()
          If index == WHOLE_COLLECTION, the value of the property, otherwise the value of the index'th element of the collection represented by the property.
 int getPropertyCount()
          Number of the DP object's properties.
 int getPropertyIndex()
          Index of the currently selected property in the list of all properties sorted alphabetically.
 java.lang.String getPropertyName()
          Returns the name of the currently selected property or "*" if none has been selected.
 java.lang.String[] getPropertyNames()
          Names of all properties, sorted alphabetically
protected  boolean isActualProperty()
          Returns true if the bean has the currently selected property
 boolean isContainer()
          This type of node is auxiliary.
protected  boolean isIndexedProperty()
           
 void remove()
          Remove the node of the object graph this pointer points to.
 void setPropertyIndex(int index)
          Index a property by its index in the list of all properties sorted alphabetically.
 void setPropertyName(java.lang.String propertyName)
          Select a property by name.
 void setValue(java.lang.Object value)
          If index == WHOLE_COLLECTION, change the value of the property, otherwise change the value of the index'th element of the collection represented by the property.
 
Methods inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyPointer
compareChildNodePointers, createChild, createChild, createPath, createPath, equals, getBean, getImmediateValuePointer, getLength, getName, hashCode, isActual, isCollection, isLeaf
 
Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
asPath, attributeIterator, childIterator, clone, compareTo, createAttribute, getDefaultNamespaceURI, getExpandedName, getIndex, getLocale, getNamespaceURI, getNamespaceURI, getNode, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setIndex, testNode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DynaBeanPropertyPointer

public DynaBeanPropertyPointer(NodePointer parent,
                               org.apache.commons.beanutils.DynaBean dynaBean)
Method Detail

getBaseValue

public java.lang.Object getBaseValue()
Description copied from class: NodePointer
Returns the value represented by the pointer before indexing. So, if the node represents an element of a collection, this method returns the collection itself.
Overrides:
getBaseValue in class NodePointer

isContainer

public boolean isContainer()
This type of node is auxiliary.
Overrides:
isContainer in class NodePointer

getPropertyCount

public int getPropertyCount()
Number of the DP object's properties.
Overrides:
getPropertyCount in class PropertyPointer

getPropertyNames

public java.lang.String[] getPropertyNames()
Names of all properties, sorted alphabetically
Overrides:
getPropertyNames in class PropertyPointer

getPropertyName

public java.lang.String getPropertyName()
Returns the name of the currently selected property or "*" if none has been selected.
Overrides:
getPropertyName in class PropertyPointer

setPropertyName

public void setPropertyName(java.lang.String propertyName)
Select a property by name.
Overrides:
setPropertyName in class PropertyPointer

getPropertyIndex

public int getPropertyIndex()
Index of the currently selected property in the list of all properties sorted alphabetically.
Overrides:
getPropertyIndex in class PropertyPointer

setPropertyIndex

public void setPropertyIndex(int index)
Index a property by its index in the list of all properties sorted alphabetically.
Overrides:
setPropertyIndex in class PropertyPointer

getImmediateNode

public java.lang.Object getImmediateNode()
If index == WHOLE_COLLECTION, the value of the property, otherwise the value of the index'th element of the collection represented by the property. If the property is not a collection, index should be zero and the value will be the property itself.
Overrides:
getImmediateNode in class PropertyPointer

isActualProperty

protected boolean isActualProperty()
Returns true if the bean has the currently selected property
Overrides:
isActualProperty in class PropertyPointer

isIndexedProperty

protected boolean isIndexedProperty()

setValue

public void setValue(java.lang.Object value)
If index == WHOLE_COLLECTION, change the value of the property, otherwise change the value of the index'th element of the collection represented by the property.
Overrides:
setValue in class NodePointer

remove

public void remove()
Description copied from class: NodePointer
Remove the node of the object graph this pointer points to.
Overrides:
remove in class NodePointer


Copyright © 2001-2003 Apache Software Foundation. All Rights Reserved.