org.xmlfield.core.internal

Class XmlFieldUtils

java.lang.Object

org.xmlfield.core.internal.XmlFieldUtils

public abstract class XmlFieldUtils
extends Object

Xml manipulation node utility class.

Author:

David Andrianavalontsalama, Nicolas Richeton , Guillaume Mary

Constructor Summary

Constructors

Constructor and Description
XmlFieldUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static XmlFieldNode	createComplexElement(NamespaceMap namespaces, XmlFieldNode contextNode, String elementName, String stringValue, XmlField xf)
static String	emptyTag(String tag, NamespaceMap namespaces) Create an empty tag matching the given data.
static String	getElementXPath(String fieldXPath, Class<?> type) Used to get an element xpath expression from an attribute expression
static Map<String,Class<?>>	getExplicitCollections(Method method) Function to get all the associations of explicit collection
static String	getFieldFormat(Method method) récupère le contenu de l'annotation @FieldFormat sur une méthode, ou null.
static String	getFieldXPath(Method method) récupère le contenu de l'annotation @FieldXPath sur une méthode, ou null.
static Class<?>	getFieldXPathType(Method method) récupère le contenu de l'annotation @FieldXPathType sur une méthode, ou null.
static NamespaceMap	getResourceNamespaces(Class<?> type) récupère l'annotation @Namespaces sur une class, ou null .
static String	getResourceXPath(Class<?> type) récupère le contenu de l'annotation @ResourceXPath sur une class, ou null.
static XmlFieldNode	getXmlFieldNode(Object object) récupérer le nœud XML qui correspond à un objet.
static void	remove(Object item, XmlField xf) Remove element from document. item must have been acquired either by calling XmlField#nodeToObject(Node, Class) or any get or addTo method.
static void	remove(XmlFieldNode node, XmlField xf) retirer un nœud XML de son parent.

Methods inherited from class java.lang.Object

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

Constructor Detail

XmlFieldUtils

public XmlFieldUtils()

Method Detail

createComplexElement

public static XmlFieldNode createComplexElement(NamespaceMap namespaces,
                                XmlFieldNode contextNode,
                                String elementName,
                                String stringValue,
                                XmlField xf)

Parameters:

namespaces -

contextNode -

elementName -

stringValue -

Returns:

emptyTag

public static String emptyTag(String tag,
              NamespaceMap namespaces)

Create an empty tag matching the given data.

Parameters:

tag - an xml tag, can be of the form "ns:name" or "name"

namespaces - the namespaces to use or null if none

Returns:

a string representing the given tag with the given namespaces

getElementXPath

public static String getElementXPath(String fieldXPath,
                     Class<?> type)

Used to get an element xpath expression from an attribute expression

Parameters:

fieldXPath - field xpath

Returns:

element xpath expression

getExplicitCollections

public static Map<String,Class<?>> getExplicitCollections(Method method)

Function to get all the associations of explicit collection

Parameters:

method - method to get the Collection

Returns:

map with an association of xpath name and classes

getFieldFormat

public static String getFieldFormat(Method method)

récupère le contenu de l'annotation @FieldFormat sur une méthode, ou null. Si la méthode passée en paramètre est un setter, cette méthode regarde aussi du côté du getter correspondant.

Parameters:

method - la méthode pour laquelle on veut le contenu de l'annotation.

Returns:

la valeur de l'annotation, ou null.

getFieldXPath

public static String getFieldXPath(Method method)

récupère le contenu de l'annotation @FieldXPath sur une méthode, ou null. Si la méthode passée en paramètre est un setter, cette méthode regarde aussi du côté du getter correspondant.

Parameters:

method - la méthode pour laquelle on veut le contenu de l'annotation.

Returns:

la valeur de l'annotation, ou null.

getFieldXPathType

public static Class<?> getFieldXPathType(Method method)

récupère le contenu de l'annotation @FieldXPathType sur une méthode, ou null.

Parameters:

method - la méthode pour laquelle on veut le contenu de l'annotation.

Returns:

la valeur de l'annotation, ou null.

getResourceNamespaces

public static NamespaceMap getResourceNamespaces(Class<?> type)

récupère l'annotation @Namespaces sur une class, ou null .

Parameters:

type - la classe pour laquelle on veut le contenu de l'annotation.

Returns:

l'annotation, ou null.

getResourceXPath

public static String getResourceXPath(Class<?> type)

récupère le contenu de l'annotation @ResourceXPath sur une class, ou null.

Parameters:

type - la classe pour laquelle on veut le contenu de l'annotation.

Returns:

la valeur de l'annotation, ou null.

getXmlFieldNode

public static XmlFieldNode getXmlFieldNode(Object object)

récupérer le nœud XML qui correspond à un objet.

Parameters:

object - l'objet.

Returns:

le nœud XML qui correspond à l'objet.

remove

public static void remove(Object item,
          XmlField xf)

Remove element from document. item must have been acquired either by calling XmlField#nodeToObject(Node, Class) or any get or addTo method.

Parameters:

item - Item to remove

remove

public static void remove(XmlFieldNode node,
          XmlField xf)

retirer un nœud XML de son parent.

Parameters:

node - le nœud à retirer.