dmitri 2002/10/19 20:44:18
Added: jxpath/src/java/org/apache/commons/jxpath/ri/model/dynabeans
DynaBeanPropertyPointer.java
DynaBeanPointerFactory.java DynaBeanPointer.java
Log:
Added support for DynaBeans
Revision Changes Path
1.1
jakarta-commons/jxpath/src/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPropertyPointer.java
Index: DynaBeanPropertyPointer.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-commons/jxpath/src/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPropertyPointer.java,v
1.1 2002/10/20 03:44:18 dmitri Exp $
* $Revision: 1.1 $
* $Date: 2002/10/20 03:44:18 $
*
* ====================================================================
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2001, Plotnix, Inc,
* <http://www.plotnix.com/>.
* For more information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.commons.jxpath.ri.model.dynabeans;
import java.util.Arrays;
import org.apache.commons.beanutils.DynaBean;
import org.apache.commons.beanutils.DynaClass;
import org.apache.commons.beanutils.DynaProperty;
import org.apache.commons.jxpath.AbstractFactory;
import org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer;
import org.apache.commons.jxpath.JXPathContext;
import org.apache.commons.jxpath.JXPathException;
import org.apache.commons.jxpath.JXPathIntrospector;
import org.apache.commons.jxpath.ri.QName;
import org.apache.commons.jxpath.ri.model.beans.PropertyPointer;
import org.apache.commons.jxpath.ri.model.NodePointer;
import org.apache.commons.jxpath.util.TypeConverter;
import org.apache.commons.jxpath.util.TypeUtils;
import org.apache.commons.jxpath.util.ValueUtils;
/**
* Pointer pointing to a property of a DynaBean.
*
* @author Dmitri Plotnikov
* @version $Revision: 1.1 $ $Date: 2002/10/20 03:44:18 $
*/
public class DynaBeanPropertyPointer extends PropertyPointer {
private DynaBean dynaBean;
private String name;
private String[] names;
public DynaBeanPropertyPointer(NodePointer parent, DynaBean dynaBean){
super(parent);
this.dynaBean = dynaBean;
}
public Object getBaseValue(){
return dynaBean.get(getPropertyName());
}
/**
* This type of node is auxiliary.
*/
public boolean isNode(){
return false;
}
/**
* Number of the DP object's properties.
*/
public int getPropertyCount(){
return getPropertyNames().length;
}
/**
* Names of all properties, sorted alphabetically
*
* @todo do something about the sorting
*/
public String[] getPropertyNames(){
if (names == null){
DynaClass dynaClass = dynaBean.getDynaClass();
DynaProperty properties[] = dynaClass.getDynaProperties();
int count = properties.length;
boolean hasClass = dynaClass.getDynaProperty("class") != null;
if (hasClass){
count --; // Exclude "class" from properties
}
names = new String[count];
for (int i = 0, j = 0; i < properties.length; i++){
String name = properties[i].getName();
if (!hasClass || !name.equals("class")){
names[j++] = name;
}
}
Arrays.sort(names);
// System.err.println("D.PROPERTIES: " + Arrays.asList(names));
}
return names;
}
/**
* Returns the name of the currently selected property or "*"
* if none has been selected.
*/
public String getPropertyName(){
if (name == null){
String names[] = getPropertyNames();
if (propertyIndex >=0 && propertyIndex < names.length){
name = names[propertyIndex];
}
else {
name = "*";
}
}
return name;
}
/**
* Select a property by name.
*/
public void setPropertyName(String propertyName){
setPropertyIndex(UNSPECIFIED_PROPERTY);
this.name = propertyName;
}
/**
* Index of the currently selected property in the list of all
* properties sorted alphabetically.
*/
public int getPropertyIndex(){
if (propertyIndex == UNSPECIFIED_PROPERTY){
String names[] = getPropertyNames();
for (int i = 0; i < names.length; i++){
if (names[i].equals(name)){
setPropertyIndex(i);
break;
}
}
}
return super.getPropertyIndex();
}
/**
* Index a property by its index in the list of all
* properties sorted alphabetically.
*/
public void setPropertyIndex(int index){
if (propertyIndex != index){
super.setPropertyIndex(index);
name = null;
}
}
/**
* 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.
*/
public Object getNode(){
String name = getPropertyName();
if (name.equals("*")){
return null;
}
Object value;
if (index == WHOLE_COLLECTION){
value = dynaBean.get(name);
}
else if (isIndexedProperty()){
// DynaClass at this point is not based on whether
// the property is indeed indexed, but rather on
// whether it is an array or List. Therefore
// the indexed set may fail.
try {
value = dynaBean.get(name, index);
}
catch (ArrayIndexOutOfBoundsException ex){
value = null;
}
catch (IllegalArgumentException ex){
value = dynaBean.get(name);
value = ValueUtils.getValue(value, index);
}
}
else {
value = dynaBean.get(name);
if (ValueUtils.isCollection(value)){
value = ValueUtils.getValue(value, index);
}
else if (index != 0){
value = null;
}
}
return value;
}
/**
* Returns true if the bean has the currently selected property
*/
protected boolean isActualProperty(){
DynaClass dynaClass = dynaBean.getDynaClass();
return dynaClass.getDynaProperty(getPropertyName()) != null;
}
protected boolean isIndexedProperty(){
DynaClass dynaClass = dynaBean.getDynaClass();
DynaProperty property = dynaClass.getDynaProperty(name);
return property.isIndexed();
}
/**
* 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.
*/
public void setValue(Object value){
setValue(index, value);
}
public NodePointer createPath(JXPathContext context, Object value){
return createChild(context, getName(), index, value);
}
public NodePointer createChild(JXPathContext context,
QName name, int index, Object value)
{
// Ignore the name passed to us, use our own data
if (index == WHOLE_COLLECTION){
setValue(index, value);
}
else if (isIndexedProperty()){
dynaBean.set(getPropertyName(), index, convert(value, true));
}
else {
Object collection = getBaseValue();
if (collection == null){
AbstractFactory factory = getAbstractFactory(context);
if (!factory.createObject(
context, this, getBean(), getPropertyName(), 0)){
throw new JXPathException(
"Factory could not create an object for path: " +
asPath());
}
collection = getBaseValue();
}
if (index < 0){
throw new JXPathException("Index is less than 1: " + asPath());
}
if (index >= getLength()){
collection = ValueUtils.expandCollection(collection, index + 1);
dynaBean.set(getPropertyName(), collection);
}
ValueUtils.setValue(collection, index, value);
}
NodePointer ptr = (NodePointer)clone();
ptr.setIndex(index);
return ptr;
}
public NodePointer createChild(JXPathContext context,
QName name, int index)
{
if (isIndexedProperty()){
AbstractFactory factory = getAbstractFactory(context);
if (!factory.createObject(
context, this, dynaBean, getPropertyName(), index)){
throw new JXPathException(
"Factory could not create an object for path: " + asPath());
}
}
else {
// Ignore the name passed to us, use our own data
Object collection = getBaseValue();
if (collection == null){
AbstractFactory factory = getAbstractFactory(context);
if (!factory.createObject(
context, this, dynaBean, getPropertyName(), index)){
throw new JXPathException(
"Factory could not create an object for path: " +
asPath());
}
collection = getBaseValue();
}
if (index < 0){
throw new JXPathException("Index is less than 1: " + asPath());
}
if (index >= getLength()){
collection = ValueUtils.expandCollection(collection, index + 1);
dynaBean.set(getPropertyName(), collection);
}
}
DynaBeanPropertyPointer pointer = (DynaBeanPropertyPointer)this.clone();
pointer.setIndex(index);
return pointer;
}
public NodePointer createPath(JXPathContext context){
if (getNode() == null){
AbstractFactory factory = getAbstractFactory(context);
int inx = (index == WHOLE_COLLECTION ? 0 : index);
if (!factory.createObject(
context, this, dynaBean, getPropertyName(), inx)){
throw new JXPathException(
"Factory could not create an object for path: " +
asPath());
}
}
return this;
}
public void remove(){
if (index == WHOLE_COLLECTION){
dynaBean.set(getPropertyName(), null);
}
else if (isIndexedProperty()){
dynaBean.set(getPropertyName(), index, null);
}
else if (isCollection()){
Object collection = ValueUtils.remove(getBaseValue(), index);
dynaBean.set(getPropertyName(), collection);
}
else if (index == 0){
dynaBean.set(getPropertyName(), null);
}
}
private AbstractFactory getAbstractFactory(JXPathContext context){
AbstractFactory factory = context.getFactory();
if (factory == null){
throw new JXPathException("Factory is not set on the JXPathContext -
cannot create path: " + asPath());
}
return factory;
}
private void setValue(int index, Object value){
if (index == WHOLE_COLLECTION){
dynaBean.set(getPropertyName(), convert(value, false));
}
else if (isIndexedProperty()){
dynaBean.set(getPropertyName(), index, convert(value, true));
}
else {
Object baseValue = dynaBean.get(getPropertyName());
ValueUtils.setValue(baseValue, index, value);
}
}
private Object convert(Object value, boolean element){
DynaClass dynaClass = (DynaClass)dynaBean.getDynaClass();
DynaProperty property =
dynaClass.getDynaProperty(getPropertyName());
Class type = property.getType();
if (element){
if (type.isArray()){
type = type.getComponentType();
}
else {
return value; // No need to convert
}
}
try {
return TypeUtils.convert(value, type);
}
catch (Exception ex){
ex.printStackTrace();
throw new JXPathException("Cannot convert value of class " +
(value == null ? "null" : value.getClass().getName()) +
" to type " + type, ex);
}
}
}
1.1
jakarta-commons/jxpath/src/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPointerFactory.java
Index: DynaBeanPointerFactory.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-commons/jxpath/src/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPointerFactory.java,v
1.1 2002/10/20 03:44:18 dmitri Exp $
* $Revision: 1.1 $
* $Date: 2002/10/20 03:44:18 $
*
* ====================================================================
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2001, Plotnix, Inc,
* <http://www.plotnix.com/>.
* For more information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.commons.jxpath.ri.model.dynabeans;
import java.util.Locale;
import org.apache.commons.beanutils.DynaBean;
import org.apache.commons.beanutils.DynaClass;
import org.apache.commons.jxpath.ri.QName;
import org.apache.commons.jxpath.ri.model.NodePointer;
import org.apache.commons.jxpath.ri.model.NodePointerFactory;
/**
* Implements NodePointerFactory for DynaBeans.
* See <a href="http://jakarta.apache.org/commons/beanutils.html";>
* Jakarta Commons BeanUtils
* </a>
*
* @author Dmitri Plotnikov
* @version $Revision: 1.1 $ $Date: 2002/10/20 03:44:18 $
*/
public class DynaBeanPointerFactory implements NodePointerFactory {
public static final int DYNA_BEAN_POINTER_FACTORY_ORDER = 700;
public int getOrder(){
return DYNA_BEAN_POINTER_FACTORY_ORDER;
}
public NodePointer createNodePointer(
QName name, Object bean, Locale locale)
{
if (bean instanceof DynaBean){
return new DynaBeanPointer(name, (DynaBean)bean, locale);
}
return null;
}
public NodePointer createNodePointer(
NodePointer parent, QName name, Object bean)
{
if (bean instanceof DynaBean){
return new DynaBeanPointer(parent, name, (DynaBean)bean);
}
return null;
}
}
1.1
jakarta-commons/jxpath/src/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPointer.java
Index: DynaBeanPointer.java
===================================================================
/*
* $Header:
/home/cvs/jakarta-commons/jxpath/src/java/org/apache/commons/jxpath/ri/model/dynabeans/DynaBeanPointer.java,v
1.1 2002/10/20 03:44:18 dmitri Exp $
* $Revision: 1.1 $
* $Date: 2002/10/20 03:44:18 $
*
* ====================================================================
* The Apache Software License, Version 1.1
*
*
* Copyright (c) 1999-2001 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation and was
* originally based on software copyright (c) 2001, Plotnix, Inc,
* <http://www.plotnix.com/>.
* For more information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.commons.jxpath.ri.model.dynabeans;
import java.beans.PropertyDescriptor;
import java.util.Locale;
import org.apache.commons.beanutils.DynaBean;
import org.apache.commons.jxpath.ri.model.beans.PropertyOwnerPointer;
import org.apache.commons.jxpath.ri.model.beans.PropertyPointer;
import org.apache.commons.jxpath.JXPathIntrospector;
import org.apache.commons.jxpath.ri.QName;
import org.apache.commons.jxpath.ri.model.NodePointer;
import org.apache.commons.jxpath.util.ValueUtils;
/**
* A Pointer that points to a DynaBean.
*
* @author Dmitri Plotnikov
* @version $Revision: 1.1 $ $Date: 2002/10/20 03:44:18 $
*/
public class DynaBeanPointer extends PropertyOwnerPointer {
private QName name;
private DynaBean dynaBean;
public DynaBeanPointer(QName name, DynaBean dynaBean, Locale locale)
{
super(null, locale);
this.name = name;
this.dynaBean = dynaBean;
}
/**
* @param name is the name given to the first node
*/
public DynaBeanPointer(NodePointer parent, QName name, DynaBean dynaBean) {
super(parent);
this.name = name;
this.dynaBean = dynaBean;
}
public PropertyPointer getPropertyPointer(){
return new DynaBeanPropertyPointer(this, dynaBean);
}
public QName getName(){
return name;
}
/**
* Returns the bean itself
*/
public Object getBaseValue(){
return dynaBean;
}
public Object getNode(){
return dynaBean;
}
public boolean isCollection(){
return false;
}
/**
* Returns 1.
*/
public int getLength(){
return 1;
}
public boolean isLeaf() {
return false;
}
public int hashCode(){
return name == null ? 0 : name.hashCode();
}
public boolean equals(Object object){
if (object == this){
return true;
}
if (!(object instanceof DynaBeanPointer)){
return false;
}
DynaBeanPointer other = (DynaBeanPointer)object;
if (parent != other.parent){
if (parent == null || !parent.equals(other.parent)){
return false;
}
}
if ((name == null && other.name != null) ||
(name != null && !name.equals(other.name))){
return false;
}
int i_this = (index == WHOLE_COLLECTION ? 0 : index);
int i_other = (other.index == WHOLE_COLLECTION ? 0 : other.index);
if (i_this != i_other){
return false;
}
return dynaBean == other.dynaBean;
}
/**
* If there's a parent - parent's path, otherwise "/".
*/
public String asPath(){
if (parent != null){
return super.asPath();
}
return "/";
}
}
--
To unsubscribe, e-mail: <mailto:commons-dev-unsubscribe@;jakarta.apache.org>
For additional commands, e-mail: <mailto:commons-dev-help@;jakarta.apache.org>
