de.intarsys.tools.infoset

Class ElementTools

java.lang.Object

de.intarsys.tools.infoset.ElementTools

public class ElementTools
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_CLASS
static String	ATTR_FACTORY
static String	ATTR_NAME
static String	ATTR_REF
static String	ATTR_TYPE
static String	ELEMENT_ACCESSOR
static String	ELEMENT_ARGS
static String	ELEMENT_GET
static String	ELEMENT_IMPLEMENTATION
static String	ELEMENT_METHOD
static String	ELEMENT_NULL
static String	ELEMENT_OBJECT
static String	ELEMENT_PERFORM
static String	ELEMENT_SET
static String	ELEMENT_VALUE
static String	PROPERTY_INSERT
static String	PROPERTY_REMOVE
static String	PROPERTY_SET

Constructor Summary

Constructors

Constructor and Description
ElementTools()

Method Summary

Methods

Modifier and Type	Method and Description
static void	copy(IElement to, IElement from)
static void	copyAttributes(IElement to, IElement from)
static void	copyElements(IElement to, IElement from)
static void	copyText(IElement to, IElement from)
static <T> Class<T>	createClass(IElement element, String classAttribute, Class<T> expectedClass, Object context)
static IFunctor	createFunctor(Object owner, IElement element, String role, Object context) This is a tool method to create an IFunctor.
static <T> T	createObject(IElement element, Class<T> expectedClass, Object context)
static <T> T	createObject(IElement element, String role, Class<T> expectedClass, Object context) Create an object of type expectedClass as described in element.
static <T> T	createObjectChild(Object owner, IElement element, Class<T> expectedClass, Object context)
static <T> T	createPropertyValue(Object owner, IElement element, Class<T> expectedClass, Object context)
static boolean	getBool(IElement element, String attributeName, boolean defaultValue)
static boolean	getBoolean(IElement element, String attributeName, boolean defaultValue)
static char[]	getCharArray(IElement element, String attributeName, char[] defaultValue)
static Color	getColor(IElement element, String name, Color defaultValue) The argument value at name as a Color.
static double	getDouble(IElement element, String attributeName, double defaultValue)
static <T extends EnumItem> T	getEnumItem(IElement element, String attributeName, EnumMeta<T> meta)
static <T extends EnumItem> T	getEnumItem(IElement element, String attributeName, EnumMeta<T> meta, T defaultValue)
static float	getFloat(IElement element, String attributeName, float defaultValue)
static int	getInt(IElement element, String attributeName, int defaultValue)
static long	getLong(IElement element, String attributeName, long defaultValue)
static boolean	getPathBoolean(IElement element, String path, boolean defaultValue)
static double	getPathDouble(IElement element, String path, double defaultValue)
static float	getPathFloat(IElement element, String path, float defaultValue)
static int	getPathInt(IElement element, String path, int defaultValue)
static String	getPathString(IElement element, String path, String defaultValue)
static String	getString(IElement element, String attributeName, String defaultValue)
static IElement	parseElement(String value)
static void	serialize(Object value, IElement element, String role)
static void	setCDATA(IElement element, String value)
static void	setProperties(Object object, IElement element, Object context) Set properties in object based on the list of property information contained in element.
static void	setProperty(Object object, IElement element, Object context) Set a property in object based on the property information contained in element.
static IElement	toElement(IArgs args) Create an Element from args.
static void	write(ContentHandler handler, IElement element)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PROPERTY_REMOVE

public static final String PROPERTY_REMOVE

See Also:

Constant Field Values

PROPERTY_INSERT

public static final String PROPERTY_INSERT

See Also:

Constant Field Values

ELEMENT_SET

public static final String ELEMENT_SET

See Also:

Constant Field Values

PROPERTY_SET

public static final String PROPERTY_SET

See Also:

Constant Field Values

ELEMENT_GET

public static final String ELEMENT_GET

See Also:

Constant Field Values

ATTR_REF

public static final String ATTR_REF

See Also:

Constant Field Values

ELEMENT_ACCESSOR

public static final String ELEMENT_ACCESSOR

See Also:

Constant Field Values

ELEMENT_NULL

public static final String ELEMENT_NULL

See Also:

Constant Field Values

ELEMENT_ARGS

public static final String ELEMENT_ARGS

See Also:

Constant Field Values

ELEMENT_VALUE

public static final String ELEMENT_VALUE

See Also:

Constant Field Values

ELEMENT_OBJECT

public static final String ELEMENT_OBJECT

See Also:

Constant Field Values

ATTR_TYPE

public static final String ATTR_TYPE

See Also:

Constant Field Values

ELEMENT_PERFORM

public static final String ELEMENT_PERFORM

See Also:

Constant Field Values

ATTR_CLASS

public static final String ATTR_CLASS

See Also:

Constant Field Values

ATTR_FACTORY

public static final String ATTR_FACTORY

See Also:

Constant Field Values

ATTR_NAME

public static final String ATTR_NAME

See Also:

Constant Field Values

ELEMENT_IMPLEMENTATION

public static final String ELEMENT_IMPLEMENTATION

See Also:

Constant Field Values

ELEMENT_METHOD

public static final String ELEMENT_METHOD

See Also:

Constant Field Values

Constructor Detail

ElementTools

public ElementTools()

Method Detail

copy

public static void copy(IElement to,
        IElement from)

copyAttributes

public static void copyAttributes(IElement to,
                  IElement from)

copyElements

public static void copyElements(IElement to,
                IElement from)

copyText

public static void copyText(IElement to,
            IElement from)

createClass

public static <T> Class<T> createClass(IElement element,
                       String classAttribute,
                       Class<T> expectedClass,
                       Object context)
                            throws ObjectCreationException

Throws:

ObjectCreationException

createFunctor

public static IFunctor createFunctor(Object owner,
                     IElement element,
                     String role,
                     Object context)
                              throws ObjectCreationException

This is a tool method to create an IFunctor. We use this because of a small deviation from the standard XML syntax. The functor can be either created "normally" or via an embedded "perform" element.

Parameters:

owner -

element -

role - TODO

context -

Returns:

Throws:

ObjectCreationException

createObject

public static <T> T createObject(IElement element,
                 Class<T> expectedClass,
                 Object context)
                      throws ObjectCreationException

Throws:

ObjectCreationException

createObject

public static <T> T createObject(IElement element,
                 String role,
                 Class<T> expectedClass,
                 Object context)
                      throws ObjectCreationException

Create an object of type expectedClass as described in element. The object can stem from one the following sources:

• ref
A reference to a registered object in a bean container
• class
A new instance of the designated class
• factory
A new instance created by the designated IFactory

The implementation class is accessed via classLoader.

Parameters:

element -

role -

expectedClass -

context - TODO

Returns:

Throws:

ObjectCreationException

createObjectChild

public static <T> T createObjectChild(Object owner,
                      IElement element,
                      Class<T> expectedClass,
                      Object context)
                           throws ObjectCreationException

Throws:

ObjectCreationException

createPropertyValue

public static <T> T createPropertyValue(Object owner,
                        IElement element,
                        Class<T> expectedClass,
                        Object context)
                             throws ObjectCreationException

Throws:

ObjectCreationException

getBool

public static boolean getBool(IElement element,
              String attributeName,
              boolean defaultValue)

getBoolean

public static boolean getBoolean(IElement element,
                 String attributeName,
                 boolean defaultValue)

getCharArray

public static char[] getCharArray(IElement element,
                  String attributeName,
                  char[] defaultValue)

getColor

public static Color getColor(IElement element,
             String name,
             Color defaultValue)

The argument value at name as a Color. If the argument value is not provided or not convertible, defaultValueis returned.

Parameters:

args -

name -

defaultValue -

Returns:

The argument value at name as a Color.

getDouble

public static double getDouble(IElement element,
               String attributeName,
               double defaultValue)

getEnumItem

public static <T extends EnumItem> T getEnumItem(IElement element,
                                 String attributeName,
                                 EnumMeta<T> meta)

getEnumItem

public static <T extends EnumItem> T getEnumItem(IElement element,
                                 String attributeName,
                                 EnumMeta<T> meta,
                                 T defaultValue)

getFloat

public static float getFloat(IElement element,
             String attributeName,
             float defaultValue)

getInt

public static int getInt(IElement element,
         String attributeName,
         int defaultValue)

getLong

public static long getLong(IElement element,
           String attributeName,
           long defaultValue)

getPathBoolean

public static boolean getPathBoolean(IElement element,
                     String path,
                     boolean defaultValue)

getPathDouble

public static double getPathDouble(IElement element,
                   String path,
                   double defaultValue)

getPathFloat

public static float getPathFloat(IElement element,
                 String path,
                 float defaultValue)

getPathInt

public static int getPathInt(IElement element,
             String path,
             int defaultValue)

getPathString

public static String getPathString(IElement element,
                   String path,
                   String defaultValue)

getString

public static String getString(IElement element,
               String attributeName,
               String defaultValue)

parseElement

public static IElement parseElement(String value)
                             throws IOException

Throws:

IOException

serialize

public static void serialize(Object value,
             IElement element,
             String role)
                      throws ElementSerializationException

Throws:

ElementSerializationException

setCDATA

public static void setCDATA(IElement element,
            String value)

setProperties

public static void setProperties(Object object,
                 IElement element,
                 Object context)
                          throws FieldException,
                                 ObjectCreationException,
                                 FunctorInvocationException

Set properties in object based on the list of property information contained in element.

...