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

java.lang.Object
  extended by org.apache.commons.jxpath.ri.model.NodePointer
      extended by org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer
          extended by org.apache.commons.jxpath.ri.model.dynabeans.DynaBeanPointer
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.lang.Comparable, Pointer

public class DynaBeanPointer
extends PropertyOwnerPointer

A Pointer that points to a DynaBean. If the target DynaBean is Serializable, so should this instance be.

Version:
$Revision: 668329 $ $Date: 2008-06-16 16:59:48 -0500 (Mon, 16 Jun 2008) $
Author:
Dmitri Plotnikov
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.commons.jxpath.ri.model.NodePointer
index, locale, parent, UNKNOWN_NAMESPACE, WHOLE_COLLECTION
 
Constructor Summary
DynaBeanPointer(NodePointer parent, QName name, org.apache.commons.beanutils.DynaBean dynaBean)
          Create a new DynaBeanPointer.
DynaBeanPointer(QName name, org.apache.commons.beanutils.DynaBean dynaBean, java.util.Locale locale)
          Create a new DynaBeanPointer.
 
Method Summary
 java.lang.String asPath()
          Returns an XPath that maps to this Pointer.
 boolean equals(java.lang.Object object)
           
 java.lang.Object getBaseValue()
          Returns the value represented by the pointer before indexing.
 java.lang.Object getImmediateNode()
          Returns the object the pointer points to; does not convert it to a "canonical" type.
 int getLength()
          If the pointer represents a collection (or collection element), returns the length of the collection.
 QName getName()
          Returns the name of this node.
 PropertyPointer getPropertyPointer()
          Get a PropertyPointer for this PropertyOwnerPointer.
 int hashCode()
           
 boolean isCollection()
          Returns true if the value of the pointer is an array or a Collection.
 boolean isLeaf()
          If true, this node does not have children
 
Methods inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer
attributeIterator, childIterator, compareChildNodePointers, createNodeIterator, isDynamicPropertyDeclarationSupported, isValidProperty, remove, setIndex, setValue
 
Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
clone, compareTo, createAttribute, createChild, createChild, createPath, createPath, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getImmediateValuePointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, getValuePointer, isActual, isAttribute, isContainer, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, setAttribute, setNamespaceResolver, testNode, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DynaBeanPointer

public DynaBeanPointer(QName name,
                       org.apache.commons.beanutils.DynaBean dynaBean,
                       java.util.Locale locale)
Create a new DynaBeanPointer.

Parameters:
name - is the name given to the first node
dynaBean - pointed
locale - Locale

DynaBeanPointer

public DynaBeanPointer(NodePointer parent,
                       QName name,
                       org.apache.commons.beanutils.DynaBean dynaBean)
Create a new DynaBeanPointer.

Parameters:
parent - pointer
name - is the name given to the first node
dynaBean - pointed
Method Detail

getPropertyPointer

public PropertyPointer getPropertyPointer()
Description copied from class: PropertyOwnerPointer
Get a PropertyPointer for this PropertyOwnerPointer.

Specified by:
getPropertyPointer in class PropertyOwnerPointer
Returns:
PropertyPointer

getName

public QName getName()
Description copied from class: NodePointer
Returns the name of this node. Can be null.

Specified by:
getName in class PropertyOwnerPointer
Returns:
QName

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.

Specified by:
getBaseValue in class NodePointer
Returns:
Object value

getImmediateNode

public java.lang.Object getImmediateNode()
Description copied from class: NodePointer
Returns the object the pointer points to; does not convert it to a "canonical" type.

Overrides:
getImmediateNode in class PropertyOwnerPointer
Returns:
Object node

isCollection

public boolean isCollection()
Description copied from class: NodePointer
Returns true if the value of the pointer is an array or a Collection.

Specified by:
isCollection in class NodePointer
Returns:
boolean

getLength

public int getLength()
Description copied from class: NodePointer
If the pointer represents a collection (or collection element), returns the length of the collection. Otherwise returns 1 (even if the value is null).

Specified by:
getLength in class NodePointer
Returns:
int

isLeaf

public boolean isLeaf()
Description copied from class: NodePointer
If true, this node does not have children

Specified by:
isLeaf in class NodePointer
Returns:
boolean

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)
Overrides:
equals in class java.lang.Object

asPath

public java.lang.String asPath()
Description copied from class: NodePointer
Returns an XPath that maps to this Pointer.

Specified by:
asPath in interface Pointer
Overrides:
asPath in class NodePointer
Returns:
String xpath expression


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