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.io.Serializable
,java.lang.Cloneable
,java.lang.Comparable
,Pointer
public class NullPropertyPointer extends PropertyPointer
- Version:
- $Revision: 652884 $ $Date: 2008-05-02 15:02:00 -0500 (Fri, 02 May 2008) $
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
byNameAttribute
private java.lang.String
propertyName
private static long
serialVersionUID
-
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
Constructors Constructor Description NullPropertyPointer(NodePointer parent)
Create a new NullPropertyPointer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
asPath()
Returns an XPath that maps to this Pointer.private JXPathAbstractFactoryException
createBadFactoryException(AbstractFactory factory)
Create a "bad factory" JXPathAbstractFactoryException for the specified AbstractFactory.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.java.lang.Object
getImmediateNode()
Returns the object the pointer points to; does not convert it to a "canonical" type.int
getLength()
If the property contains a collection, then the length of that collection, otherwise - 1.QName
getName()
Returns the name of this node.int
getPropertyCount()
Count the number of properties represented.java.lang.String
getPropertyName()
Get the property name.java.lang.String[]
getPropertyNames()
Get the names of the included properties.NodePointer
getValuePointer()
If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents.boolean
isActual()
An actual pointer points to an existing part of an object graph, even if it is null.protected boolean
isActualProperty()
Learn whether this pointer references an actual property.boolean
isCollection()
Returnstrue
if the value of the pointer is an array or a Collection.boolean
isContainer()
If true, this node is auxiliary and can only be used as an intermediate in the chain of pointers.boolean
isLeaf()
If true, this node does not have childrenvoid
setNameAttributeValue(java.lang.String attributeValue)
Set the name attribute.void
setPropertyIndex(int index)
Set the property index.void
setPropertyName(java.lang.String propertyName)
Set the property name.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, getImmediateValuePointer, getPropertyIndex, hashCode
-
Methods inherited from class org.apache.commons.jxpath.ri.model.NodePointer
attributeIterator, childIterator, clone, compareTo, createAttribute, escape, getAbstractFactory, getDefaultNamespaceURI, getImmediateParentPointer, getIndex, getLocale, getNamespaceResolver, getNamespaceURI, getNamespaceURI, getNode, getNodeSetByKey, getNodeValue, getParent, getPointerByID, getPointerByKey, getRootNode, getValue, isAttribute, isDefaultNamespace, isLanguage, isNode, isRoot, namespaceIterator, namespacePointer, newChildNodePointer, newNodePointer, printPointerChain, remove, setAttribute, setIndex, setNamespaceResolver, testNode, toString
-
-
-
-
Field Detail
-
propertyName
private java.lang.String propertyName
-
byNameAttribute
private boolean byNameAttribute
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
NullPropertyPointer
public NullPropertyPointer(NodePointer parent)
Create a new NullPropertyPointer.- Parameters:
parent
- pointer
-
-
Method Detail
-
getName
public QName getName()
Description copied from class:NodePointer
Returns the name of this node. Can be null.- Overrides:
getName
in classPropertyPointer
- Returns:
- QName
-
setPropertyIndex
public void setPropertyIndex(int index)
Description copied from class:PropertyPointer
Set the property index.- Overrides:
setPropertyIndex
in classPropertyPointer
- Parameters:
index
- property index
-
getLength
public int getLength()
Description copied from class:PropertyPointer
If the property contains a collection, then the length of that collection, otherwise - 1.- Overrides:
getLength
in classPropertyPointer
- Returns:
- int length
-
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 classNodePointer
- 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 classPropertyPointer
- Returns:
- Object node
-
isLeaf
public boolean isLeaf()
Description copied from class:NodePointer
If true, this node does not have children- Overrides:
isLeaf
in classPropertyPointer
- Returns:
- boolean
-
getValuePointer
public NodePointer getValuePointer()
Description copied from class:NodePointer
If this pointer manages a transparent container, like a variable, this method returns the pointer to the contents. Only an auxiliary (non-node) pointer can (and should) return a value pointer other than itself. Note that you probably don't want to overridegetValuePointer()
directly. Override thegetImmediateValuePointer()
method instead. ThegetValuePointer()
method is callsgetImmediateValuePointer()
and, if the result is notthis
, invokesgetValuePointer()
recursively. The idea here is to open all nested containers. Let's say we have a container within a container within a container. ThegetValuePointer()
method should then open all those containers and return the pointer to the ultimate contents. It does so with the above recursion.- Overrides:
getValuePointer
in classNodePointer
- Returns:
- NodePointer
-
isActualProperty
protected boolean isActualProperty()
Description copied from class:PropertyPointer
Learn whether this pointer references an actual property.- Specified by:
isActualProperty
in classPropertyPointer
- Returns:
- true if actual
-
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 classPropertyPointer
- Returns:
- boolean
-
isContainer
public boolean isContainer()
Description copied from class:NodePointer
If true, this node is auxiliary and can only be used as an intermediate in the chain of pointers.- Overrides:
isContainer
in classNodePointer
- Returns:
- boolean
-
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 interfacePointer
- Specified by:
setValue
in classNodePointer
- Parameters:
value
- the value to set
-
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 classPropertyPointer
- Parameters:
context
- the owning JXPathContext- Returns:
- created 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 classPropertyPointer
- Parameters:
context
- the owning JXPathContextvalue
- the new value to set- Returns:
- created 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 classPropertyPointer
- Parameters:
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.- Returns:
- created 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 may have to expand the collection in order to assign the element.- Overrides:
createChild
in classPropertyPointer
- Parameters:
context
- the owning JXPathCOntextname
- the QName at which a child should be createdindex
- child index.value
- node value to set- Returns:
- created NodePointer
-
getPropertyName
public java.lang.String getPropertyName()
Description copied from class:PropertyPointer
Get the property name.- Specified by:
getPropertyName
in classPropertyPointer
- Returns:
- String property name.
-
setPropertyName
public void setPropertyName(java.lang.String propertyName)
Description copied from class:PropertyPointer
Set the property name.- Specified by:
setPropertyName
in classPropertyPointer
- Parameters:
propertyName
- property name to set.
-
setNameAttributeValue
public void setNameAttributeValue(java.lang.String attributeValue)
Set the name attribute.- Parameters:
attributeValue
- value to set
-
isCollection
public boolean isCollection()
Description copied from class:NodePointer
Returnstrue
if the value of the pointer is an array or a Collection.- Overrides:
isCollection
in classPropertyPointer
- Returns:
- boolean
-
getPropertyCount
public int getPropertyCount()
Description copied from class:PropertyPointer
Count the number of properties represented.- Specified by:
getPropertyCount
in classPropertyPointer
- Returns:
- int
-
getPropertyNames
public java.lang.String[] getPropertyNames()
Description copied from class:PropertyPointer
Get the names of the included properties.- Specified by:
getPropertyNames
in classPropertyPointer
- Returns:
- String[]
-
asPath
public java.lang.String asPath()
Description copied from class:NodePointer
Returns an XPath that maps to this Pointer.- Specified by:
asPath
in interfacePointer
- Overrides:
asPath
in classNodePointer
- Returns:
- String xpath expression
-
createBadFactoryException
private JXPathAbstractFactoryException createBadFactoryException(AbstractFactory factory)
Create a "bad factory" JXPathAbstractFactoryException for the specified AbstractFactory.- Parameters:
factory
- AbstractFactory- Returns:
- JXPathAbstractFactoryException
-
-