org.apache.commons.jxpath.ri.model.dynamic
Class DynamicPropertyPointer

java.lang.Object
  |
  +--org.apache.commons.jxpath.ri.model.NodePointer
        |
        +--org.apache.commons.jxpath.ri.model.beans.PropertyPointer
              |
              +--org.apache.commons.jxpath.ri.model.dynamic.DynamicPropertyPointer

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, Pointer, java.io.Serializable

public class DynamicPropertyPointer

extends PropertyPointer

Pointer pointing to a property of an object with dynamic properties.

Version:

$Revision: 1.4 $ $Date: 2003/03/11 00:59:30 $

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

DynamicPropertyPointer(NodePointer parent, DynamicPropertyHandler handler)

Method Summary

java.lang.String	asPath() Returns an XPath that maps to this Pointer.
NodePointer	createPath(JXPathContext context) Called by a child pointer when it needs to create a parent object.
NodePointer	createPath(JXPathContext context, java.lang.Object value) Called directly by JXPathContext.
java.lang.Object	getBaseValue() Returns the value of the property, not an element of the collection represented by the property, if any.
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() A dynamic property is always considered actual - all keys are apparently existing with possibly the value of null.
boolean	isContainer() This type of node is auxiliary.
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, equals, getBean, getImmediateValuePointer, getLength, getName, hashCode, isActual, isCollection, isLeaf

Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer

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

DynamicPropertyPointer

public DynamicPropertyPointer(NodePointer parent,
                              DynamicPropertyHandler handler)

Method Detail

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. If the supplied name is not one of the object's existing properties, it implicitly adds this name to the object's property name list. It does not set the property value though. In order to set the property value, call setValue().

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

getBaseValue

public java.lang.Object getBaseValue()

Returns the value of the property, not an element of the collection represented by the property, if any.

Overrides:

getBaseValue in class NodePointer

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()

A dynamic property is always considered actual - all keys are apparently existing with possibly the value of null.

Overrides:

isActualProperty in class PropertyPointer

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

createPath

public NodePointer createPath(JXPathContext context)

Description copied from class: NodePointer

Called by a child pointer when it needs to create a parent object. Must create an object described by this pointer and return a new pointer that properly describes the new object.

Overrides:

createPath in class PropertyPointer

createPath

public NodePointer createPath(JXPathContext context,
                              java.lang.Object value)

Description copied from class: NodePointer

Called directly by JXPathContext. Must create path and set value.

Overrides:

createPath in class PropertyPointer

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

asPath

public java.lang.String asPath()

Description copied from class: NodePointer

Returns an XPath that maps to this Pointer.

Overrides:

asPath in class NodePointer