org.apache.commons.jxpath.ri.model.beans
Class NullPropertyPointer

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

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable, Pointer

public class NullPropertyPointer

extends PropertyPointer

Version:

$Revision: 1.5 $ $Date: 2002/05/08 23:05:05 $

Author:

Dmitri Plotnikov

Field Summary

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

NullPropertyPointer(NodePointer parent)

Method Summary

java.lang.String	asPath() Returns an XPath that maps to this Pointer.
NodePointer	createChild(JXPathContext context, QName name, int index) Called by a child pointer when it needs to create a parent object for a non-existent collection element.
NodePointer	createChild(JXPathContext context, QName name, int index, java.lang.Object value) Called by a child pointer if that child needs to assign the value supplied in the createPath(context, value) call to a non-existent node.
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 represented by the pointer before indexing.
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.
java.lang.Object	getNodeValue() Returns the object the pointer points to; does not convert it to a "canonical" type.
int	getPropertyCount()
java.lang.String	getPropertyName()
java.lang.String[]	getPropertyNames()
NodePointer	getValuePointer() Returns a NodePointer that can be used to access the currently selected property value.
boolean	isActual() An actual pointer points to an existing part of an object graph, even if it is null.
protected boolean	isActualProperty()
boolean	isCollection() Returns true if the value of the pointer is an array or a Collection.
boolean	isNode() If false, this node is axiliary and can only be used as an intermediate in the chain of pointers.
void	setDynamic(boolean flag)
void	setPropertyIndex(int index)
void	setPropertyName(java.lang.String propertyName)
void	setValue(java.lang.Object value) Converts the value to the required type and changes the corresponding object to that value.

Methods inherited from class org.apache.commons.jxpath.ri.model.beans.PropertyPointer

compareChildNodePointers, equals, getBean, getPropertyIndex, hashCode

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

attributeIterator, childIterator, clone, compareTo, getDefaultNamespaceURI, getExpandedName, getIndex, getLocale, getNamespaceURI, getNamespaceURI, getParent, getPointerByID, getPointerByKey, getValue, isDefaultNamespace, isLanguage, isLeaf, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, remove, setIndex, testNode, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

NullPropertyPointer

public NullPropertyPointer(NodePointer parent)

Method Detail

getName

public QName getName()

Description copied from class: NodePointer

Returns the name of this node. Can be null.

Overrides:

getName in class PropertyPointer

setPropertyIndex

public void setPropertyIndex(int index)

Overrides:

setPropertyIndex in class PropertyPointer

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

Overrides:

getLength in class NodePointer

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

getNodeValue

public java.lang.Object getNodeValue()

Description copied from class: NodePointer

Returns the object the pointer points to; does not convert it to a "canonical" type.

Overrides:

getNodeValue in class PropertyPointer

getValuePointer

public NodePointer getValuePointer()

Description copied from class: PropertyPointer

Returns a NodePointer that can be used to access the currently selected property value.

Overrides:

getValuePointer in class PropertyPointer

isActualProperty

protected boolean isActualProperty()

Specified by:

isActualProperty in class PropertyPointer

isActual

public boolean isActual()

Description copied from class: NodePointer

An actual pointer points to an existing part of an object graph, even if it is null. A non-actual pointer represents a part that does not exist at all. For instance consider the pointer "/address/street". If both address and street are not null, the pointer is actual. If address is not null, but street is null, the pointer is still actual. If address is null, the pointer is not actual. (In JavaBeans) if address is not a property of the root bean, a Pointer for this path cannot be obtained at all - actual or otherwise.

Overrides:

isActual in class PropertyPointer

isNode

public boolean isNode()

Description copied from class: NodePointer

If false, this node is axiliary and can only be used as an intermediate in the chain of pointers.

Overrides:

isNode in class NodePointer

setValue

public void setValue(java.lang.Object value)

Description copied from class: NodePointer

Converts the value to the required type and changes the corresponding object to that value.

Specified by:

setValue in interface Pointer

Specified by:

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 NodePointer

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 NodePointer

createChild

public NodePointer createChild(JXPathContext context,
                               QName name,
                               int index,
                               java.lang.Object value)

Description copied from class: NodePointer

Called by a child pointer if that child needs to assign the value supplied in the createPath(context, value) call to a non-existent node. This method must may have to expand the collection in order to assign the element.

Overrides:

createChild in class NodePointer

createChild

public NodePointer createChild(JXPathContext context,
                               QName name,
                               int index)

Description copied from class: NodePointer

Called by a child pointer when it needs to create a parent object for a non-existent collection element. It may have to expand the collection, then create an element object and return a new pointer describing the newly created element.

Overrides:

createChild in class NodePointer

getPropertyName

public java.lang.String getPropertyName()

Specified by:

getPropertyName in class PropertyPointer

setPropertyName

public void setPropertyName(java.lang.String propertyName)

Specified by:

setPropertyName in class PropertyPointer

setDynamic

public void setDynamic(boolean flag)

isCollection

public boolean isCollection()

Description copied from class: NodePointer

Returns true if the value of the pointer is an array or a Collection.

Overrides:

isCollection in class PropertyPointer

getPropertyCount

public int getPropertyCount()

Specified by:

getPropertyCount in class PropertyPointer

getPropertyNames

public java.lang.String[] getPropertyNames()

Specified by:

getPropertyNames in class PropertyPointer

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