public class LazyDynaBean extends java.lang.Object implements DynaBean, java.io.Serializable
DynaBean which automatically adds properties to the DynaClass
and provides Lazy List and Lazy Map features.
DynaBeans deal with three types of properties - simple, indexed and mapped and
have the following get()
and set()
methods for
each of these types:
get(name)
and
set(name, value)
get(name, index)
and
set(name, index, value)
get(name, key)
and
set(name, key, value)
Getting Property Values
Calling any of the get()
methods, for a property which
doesn't exist, returns null
in this implementation.
Setting Simple Properties
The LazyDynaBean
will automatically add a property to the DynaClass
if it doesn't exist when the set(name, value)
method is called.
DynaBean myBean = new LazyDynaBean();
myBean.set("myProperty", "myValue");
Setting Indexed Properties
If the property doesn't exist, the LazyDynaBean
will automatically add
a property with an ArrayList
type to the DynaClass
when
the set(name, index, value)
method is called.
It will also instantiate a new ArrayList
and automatically grow
the List
so that it is big enough to accomodate the index being set.
ArrayList
is the default indexed property that LazyDynaBean uses but
this can be easily changed by overriding the defaultIndexedProperty(name)
method.
DynaBean myBean = new LazyDynaBean();
myBean.set("myIndexedProperty", 0, "myValue1");
myBean.set("myIndexedProperty", 1, "myValue2");
If the indexed property does exist in the DynaClass
but is set to
null
in the LazyDynaBean
, then it will instantiate a
new List
or Array
as specified by the property's type
in the DynaClass
and automatically grow the List
or Array
so that it is big enough to accomodate the index being set.
DynaBean myBean = new LazyDynaBean();
MutableDynaClass myClass = (MutableDynaClass)myBean.getDynaClass();
myClass.add("myIndexedProperty", int[].class);
myBean.set("myIndexedProperty", 0, new Integer(10));
myBean.set("myIndexedProperty", 1, new Integer(20));
Setting Mapped Properties
If the property doesn't exist, the LazyDynaBean
will automatically add
a property with a HashMap
type to the DynaClass
and
instantiate a new HashMap
in the DynaBean when the
set(name, key, value)
method is called. HashMap
is the default
mapped property that LazyDynaBean uses but this can be easily changed by overriding
the defaultMappedProperty(name)
method.
DynaBean myBean = new LazyDynaBean();
myBean.set("myMappedProperty", "myKey", "myValue");
If the mapped property does exist in the DynaClass
but is set to
null
in the LazyDynaBean
, then it will instantiate a
new Map
as specified by the property's type in the DynaClass
.
DynaBean myBean = new LazyDynaBean();
MutableDynaClass myClass = (MutableDynaClass)myBean.getDynaClass();
myClass.add("myMappedProperty", TreeMap.class);
myBean.set("myMappedProperty", "myKey", "myValue");
Restricted DynaClass
MutableDynaClass
have a facility to restrict the DynaClass
so that its properties cannot be modified. If the MutableDynaClass
is
restricted then calling any of the set()
methods for a property which
doesn't exist will result in a IllegalArgumentException
being thrown.
LazyDynaClass
,
Serialized FormModifier and Type | Field and Description |
---|---|
protected static java.math.BigDecimal |
BigDecimal_ZERO
BigDecimal Zero
|
protected static java.math.BigInteger |
BigInteger_ZERO
BigInteger Zero
|
protected static java.lang.Byte |
Byte_ZERO
Byte Zero
|
protected static java.lang.Character |
Character_SPACE
Character Space
|
protected static java.lang.Double |
Double_ZERO
Double Zero
|
protected MutableDynaClass |
dynaClass
The
MutableDynaClass "base class" that this DynaBean
is associated with. |
protected static java.lang.Float |
Float_ZERO
Float Zero
|
protected static java.lang.Integer |
Integer_ZERO
Integer Zero
|
private org.apache.commons.logging.Log |
logger
Commons Logging
|
protected static java.lang.Long |
Long_ZERO
Long Zero
|
private java.util.Map<java.lang.String,java.lang.Object> |
mapDecorator
Map decorator for this DynaBean
|
protected static java.lang.Short |
Short_ZERO
Short Zero
|
protected java.util.Map<java.lang.String,java.lang.Object> |
values
The
MutableDynaClass "base class" that this DynaBean
is associated with. |
Constructor and Description |
---|
LazyDynaBean()
Construct a new
LazyDynaBean with a LazyDynaClass instance. |
LazyDynaBean(DynaClass dynaClass)
Construct a new
DynaBean associated with the specified
DynaClass instance - if its not a MutableDynaClass
then a new LazyDynaClass is created and the properties copied. |
LazyDynaBean(java.lang.String name)
Construct a new
LazyDynaBean with a LazyDynaClass instance. |
Modifier and Type | Method and Description |
---|---|
boolean |
contains(java.lang.String name,
java.lang.String key)
Does the specified mapped property contain a value for the specified
key value?
|
protected java.lang.Object |
createDynaBeanProperty(java.lang.String name,
java.lang.Class<?> type)
Create a new Instance of a 'DynaBean' Property.
|
protected java.lang.Object |
createIndexedProperty(java.lang.String name,
java.lang.Class<?> type)
Create a new Instance of an 'Indexed' Property
|
protected java.lang.Object |
createMappedProperty(java.lang.String name,
java.lang.Class<?> type)
Create a new Instance of a 'Mapped' Property
|
protected java.lang.Object |
createNumberProperty(java.lang.String name,
java.lang.Class<?> type)
Create a new Instance of a
java.lang.Number Property. |
protected java.lang.Object |
createOtherProperty(java.lang.String name,
java.lang.Class<?> type)
Create a new Instance of other Property types
|
protected java.lang.Object |
createPrimitiveProperty(java.lang.String name,
java.lang.Class<?> type)
Create a new Instance of a 'Primitive' Property.
|
protected java.lang.Object |
createProperty(java.lang.String name,
java.lang.Class<?> type)
Create a new Instance of a Property
|
protected java.lang.Object |
defaultIndexedProperty(java.lang.String name)
Creates a new
ArrayList for an 'indexed' property
which doesn't exist. |
protected java.util.Map<java.lang.String,java.lang.Object> |
defaultMappedProperty(java.lang.String name)
Creates a new
HashMap for a 'mapped' property
which doesn't exist. |
java.lang.Object |
get(java.lang.String name)
Return the value of a simple property with the specified name.
|
java.lang.Object |
get(java.lang.String name,
int index)
Return the value of an indexed property with the specified name.
|
java.lang.Object |
get(java.lang.String name,
java.lang.String key)
Return the value of a mapped property with the specified name.
|
DynaClass |
getDynaClass()
Return the
DynaClass instance that describes the set of
properties available for this DynaBean. |
java.util.Map<java.lang.String,java.lang.Object> |
getMap()
Return a Map representation of this DynaBean.
|
protected java.lang.Object |
growIndexedProperty(java.lang.String name,
java.lang.Object indexedProperty,
int index)
Grow the size of an indexed property
|
protected boolean |
isAssignable(java.lang.Class<?> dest,
java.lang.Class<?> source)
Is an object of the source class assignable to the destination class?
|
protected boolean |
isDynaProperty(java.lang.String name)
Indicates if there is a property with the specified name.
|
private org.apache.commons.logging.Log |
logger()
Returns the
Log . |
protected java.util.Map<java.lang.String,java.lang.Object> |
newMap()
Creates a new instance of the
Map . |
void |
remove(java.lang.String name,
java.lang.String key)
Remove any existing value for the specified key on the
specified mapped property.
|
void |
set(java.lang.String name,
int index,
java.lang.Object value)
Set the value of an indexed property with the specified name.
|
void |
set(java.lang.String name,
java.lang.Object value)
Set the value of a simple property with the specified name.
|
void |
set(java.lang.String name,
java.lang.String key,
java.lang.Object value)
Set the value of a mapped property with the specified name.
|
int |
size(java.lang.String name)
Return the size of an indexed or mapped property.
|
private transient org.apache.commons.logging.Log logger
protected static final java.math.BigInteger BigInteger_ZERO
protected static final java.math.BigDecimal BigDecimal_ZERO
protected static final java.lang.Character Character_SPACE
protected static final java.lang.Byte Byte_ZERO
protected static final java.lang.Short Short_ZERO
protected static final java.lang.Integer Integer_ZERO
protected static final java.lang.Long Long_ZERO
protected static final java.lang.Float Float_ZERO
protected static final java.lang.Double Double_ZERO
protected java.util.Map<java.lang.String,java.lang.Object> values
MutableDynaClass
"base class" that this DynaBean
is associated with.private transient java.util.Map<java.lang.String,java.lang.Object> mapDecorator
protected MutableDynaClass dynaClass
MutableDynaClass
"base class" that this DynaBean
is associated with.public LazyDynaBean()
LazyDynaBean
with a LazyDynaClass
instance.public LazyDynaBean(java.lang.String name)
LazyDynaBean
with a LazyDynaClass
instance.name
- Name of this DynaBean classpublic LazyDynaBean(DynaClass dynaClass)
DynaBean
associated with the specified
DynaClass
instance - if its not a MutableDynaClass
then a new LazyDynaClass
is created and the properties copied.dynaClass
- The DynaClass we are associated withpublic java.util.Map<java.lang.String,java.lang.Object> getMap()
fooProperty
:
${myDynaBean.map.fooProperty}
public int size(java.lang.String name)
Return the size of an indexed or mapped property.
name
- Name of the propertyjava.lang.IllegalArgumentException
- if no property name is specifiedpublic boolean contains(java.lang.String name, java.lang.String key)
public java.lang.Object get(java.lang.String name)
Return the value of a simple property with the specified name.
N.B. Returns null
if there is no property
of the specified name.
public java.lang.Object get(java.lang.String name, int index)
Return the value of an indexed property with the specified name.
N.B. Returns null
if there is no 'indexed'
property of the specified name.
get
in interface DynaBean
name
- Name of the property whose value is to be retrievedindex
- Index of the value to be retrievedjava.lang.IllegalArgumentException
- if the specified property
exists, but is not indexedjava.lang.IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying propertypublic java.lang.Object get(java.lang.String name, java.lang.String key)
Return the value of a mapped property with the specified name.
N.B. Returns null
if there is no 'mapped'
property of the specified name.
public DynaClass getDynaClass()
DynaClass
instance that describes the set of
properties available for this DynaBean.getDynaClass
in interface DynaBean
public void remove(java.lang.String name, java.lang.String key)
public void set(java.lang.String name, java.lang.Object value)
set
in interface DynaBean
name
- Name of the property whose value is to be setvalue
- Value to which this property is to be setjava.lang.IllegalArgumentException
- if this is not an existing property
name for our DynaClass and the MutableDynaClass is restrictedConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.NullPointerException
- if an attempt is made to set a
primitive property to nullpublic void set(java.lang.String name, int index, java.lang.Object value)
set
in interface DynaBean
name
- Name of the property whose value is to be setindex
- Index of the property to be setvalue
- Value to which this property is to be setConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not indexedjava.lang.IndexOutOfBoundsException
- if the specified index
is outside the range of the underlying propertypublic void set(java.lang.String name, java.lang.String key, java.lang.Object value)
set
in interface DynaBean
name
- Name of the property whose value is to be setkey
- Key of the property to be setvalue
- Value to which this property is to be setConversionException
- if the specified value cannot be
converted to the type required for this propertyjava.lang.IllegalArgumentException
- if there is no property
of the specified namejava.lang.IllegalArgumentException
- if the specified property
exists, but is not mappedprotected java.lang.Object growIndexedProperty(java.lang.String name, java.lang.Object indexedProperty, int index)
name
- The name of the propertyindexedProperty
- The current property valueindex
- The indexed value to grow the property to (i.e. one less than
the required size)protected java.lang.Object createProperty(java.lang.String name, java.lang.Class<?> type)
name
- The name of the propertytype
- The class of the propertyprotected java.lang.Object createIndexedProperty(java.lang.String name, java.lang.Class<?> type)
name
- The name of the propertytype
- The class of the propertyprotected java.lang.Object createMappedProperty(java.lang.String name, java.lang.Class<?> type)
name
- The name of the propertytype
- The class of the propertyprotected java.lang.Object createDynaBeanProperty(java.lang.String name, java.lang.Class<?> type)
name
- The name of the propertytype
- The class of the propertyprotected java.lang.Object createPrimitiveProperty(java.lang.String name, java.lang.Class<?> type)
name
- The name of the propertytype
- The class of the propertyprotected java.lang.Object createNumberProperty(java.lang.String name, java.lang.Class<?> type)
java.lang.Number
Property.name
- The name of the propertytype
- The class of the propertyprotected java.lang.Object createOtherProperty(java.lang.String name, java.lang.Class<?> type)
name
- The name of the propertytype
- The class of the propertyprotected java.lang.Object defaultIndexedProperty(java.lang.String name)
Creates a new ArrayList
for an 'indexed' property
which doesn't exist.
This method should be overridden if an alternative List
or Array
implementation is required for 'indexed' properties.
name
- Name of the 'indexed property.protected java.util.Map<java.lang.String,java.lang.Object> defaultMappedProperty(java.lang.String name)
Creates a new HashMap
for a 'mapped' property
which doesn't exist.
This method can be overridden if an alternative Map
implementation is required for 'mapped' properties.
name
- Name of the 'mapped property.protected boolean isDynaProperty(java.lang.String name)
name
- The name of the property to checktrue
if there is a property of the
specified name, otherwise false
protected boolean isAssignable(java.lang.Class<?> dest, java.lang.Class<?> source)
dest
- Destination classsource
- Source classtrue
if the source class is assignable to the
destination class, otherwise false
protected java.util.Map<java.lang.String,java.lang.Object> newMap()
Creates a new instance of the Map
.
private org.apache.commons.logging.Log logger()
Returns the Log
.
Copyright (c) 2000-2008 - Apache Software Foundation