ObjectModelProvider (JBoss/Common API) - JBoss 4.0.1 sp1 common API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.xml.binding
Interface ObjectModelProvider

All Known Subinterfaces:: GenericObjectModelProvider

All Known Implementing Classes:: DelegatingObjectModelProvider, MappingObjectModelProvider

public interface ObjectModelProvider

The interface all object model providers must implement. Object model providers are used on marshalling providing data for XML content based on the object model and XML schema or DTD.

Each object model provider must implement one method getRoot defined in ObjectModelProvider interface and a set of getChildren, getElementValue and getAttributeValue methods descovered by the framework at runtime with introspection.

So, the following methods should be implemented:

getRoot method
```
    java.lang.Object getRoot(java.lang.Object o, java.lang.String namespaceURI, java.lang.String localName)
 
```
This method is called on the object model provider by the framework when a root XML element is marshalled. The method returns an object that represents the root of the XML content corresponding to the namespace URI and local name.
a set of getChildren methods This method is called on the object model provider by the framework when marshalling of a new XML element started. Each getChildren method must have three arguments:
1. parent object of a concrete Java type (not java.lang.Object) that is "asked" for its children
2. namespace URI of the child XML element as java.lang.String
3. local name of the child element as java.lang.String
A getChildren method returns children that represent the namespace URI and local name in XML content. The method can return null if there are no children in this object graph corresponding to the namespace and local name. The method can return a single object if there is only one child object corresponding to the namespace and local name. If there are many children that match the namespace URI and local name, the method can return them as an array, java.util.List, java.util.Collection or java.util.Iterator.
a set of getElementValue methods This method is called on the object model provider by the framework for objects that represent XML elements with simple content, i.e. elements that don't contain nested XML elements. The method must have three arguments:
1. an object of a concrete Java type (not java.lang.Object) that is "asked" to provide a value of the XML element being marshalled
2. namespace URI as java.lang.String of the XML element being marshalled
3. local name as java.lang.String of the XML element being marshalled
The method returns either null if the object model does not have any value corresponding to the namespace URI and local name (in this case the XML content will not contain this XML element) or the actual value of the XML element.
a set of getAttributeValue methods This method is called on the object model provider by the framework for objects that represent XML elements with attributes. The method must have three arguments:
1. an object of a concrete Java type (not java.lang.Object) that is "asked" to provide a value for the XML attribute being marshalled
2. namespace URI of the XML attribute being marshalled
3. local name of the XML attribute being marshalled
The method returns either null if the object graph does not have any value corresponding to the namespace URI and local name (in this case the XML content will not contain this attribute) or the actual value of the XML attribute.

Version:: $Revision: 1.4.2.1 $
Author:: Alexey Loubyansky

Method Summary

Object getRoot(Object o, String namespaceURI, String localName)
Called by the framework when a root XML element is marshalled.

Method Detail

getRoot

public Object getRoot(Object o,
                      String namespaceURI,
                      String localName)

Called by the framework when a root XML element is marshalled.

Parameters:: o - the root of the object graph; namespaceURI - namespace URI of the root XML element being marshalled; localName - local name of the root XML element being marshalled
Returns:: an object that represents the root XML element corresponding to the namespace URI and local name