|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.rave.web.ui.renderer.template.xml.XMLLayoutDefinitionReader
public class XMLLayoutDefinitionReader
This class is responsible for doing the actual parsing of an XML
document following the layout.dtd. It produces a LayoutElement
tree with a LayoutDefinition
object at the root of the tree.
Field Summary | |
---|---|
static java.lang.String |
ATTRIBUTE_ELEMENT
|
static java.lang.String |
AUTO_RENDERED
|
static java.lang.String |
CLASS_NAME_ATTRIBUTE
|
static java.lang.String |
COMPONENT_ELEMENT
|
static java.lang.String |
COMPONENT_TYPE_ELEMENT
|
static java.lang.String |
CONDITION_ATTRIBUTE
|
static java.lang.String |
DEFAULT_ATTRIBUTE
|
static java.lang.String |
DESCRIPTION_ATTRIBUTE
|
static java.lang.String |
EVENT_ELEMENT
|
static java.lang.String |
EXTRA_INFO_ATTRIBUTE
|
static java.lang.String |
FACET_ELEMENT
|
static java.lang.String |
FACTORY_CLASS_ATTRIBUTE
|
static java.lang.String |
FOREACH_ELEMENT
|
static java.lang.String |
HANDLER_DEFINITION_ELEMENT
|
static java.lang.String |
HANDLER_ELEMENT
|
static java.lang.String |
HANDLERS_ELEMENT
|
static java.lang.String |
ID_ATTRIBUTE
|
static java.lang.String |
IF_ELEMENT
|
static java.lang.String |
INPUT_DEF_ELEMENT
|
static java.lang.String |
INPUT_ELEMENT
|
static java.lang.String |
KEY_ATTRIBUTE
|
static java.lang.String |
LAYOUT_DEFINITION_ELEMENT
|
static java.lang.String |
LAYOUT_ELEMENT
|
static java.lang.String |
LIST_ATTRIBUTE
|
static java.lang.String |
LIST_ELEMENT
|
static java.lang.String |
MARKUP_ELEMENT
|
static java.lang.String |
METHOD_NAME_ATTRIBUTE
|
static java.lang.String |
NAME_ATTRIBUTE
|
static java.lang.String |
OPTION_ELEMENT
|
static java.lang.String |
OUTPUT_DEF_ELEMENT
|
static java.lang.String |
OUTPUT_MAPPING_ELEMENT
|
static java.lang.String |
OUTPUT_NAME_ATTRIBUTE
|
static java.lang.String |
OVERWRITE_ATTRIBUTE
|
static java.lang.String |
PROPERTY_ATTRIBUTE
|
static java.lang.String |
RENDERED_ATTRIBUTE
|
static java.lang.String |
REQUIRED_ATTRIBUTE
|
static java.lang.String |
RESOURCE_ELEMENT
|
static java.lang.String |
RESOURCES_ELEMENT
|
static java.lang.String |
STATIC_TEXT_ELEMENT
|
static java.lang.String |
TAG_ATTRIBUTE
|
static java.lang.String |
TARGET_KEY_ATTRIBUTE
|
static java.lang.String |
TARGET_TYPE_ATTRIBUTE
|
static java.lang.String |
TYPE_ATTRIBUTE
|
static java.lang.String |
TYPES_ELEMENT
|
static java.lang.String |
VALUE_ATTRIBUTE
|
static java.lang.String |
WHILE_ELEMENT
|
Constructor Summary | |
---|---|
XMLLayoutDefinitionReader(java.net.URL url,
org.xml.sax.EntityResolver entityResolver,
org.xml.sax.ErrorHandler errorHandler,
java.lang.String baseURI)
Constructor. |
Method Summary | |
---|---|
HandlerDefinition |
createHandlerDefinition(org.w3c.dom.Node node)
This method takes the given HANDLER_DEFINITION_ELEMENT node and reads the ID_ATTRIBUTE, CLASS_NAME_ATTRIBUTE, and METHOD_NAME_ATTRIBUTE attributes. |
java.util.Map |
getAttributes(org.w3c.dom.Node node)
This method returns a Map of all attributes for the given Node. |
java.lang.String |
getBaseURI()
Accessor for the base URI. |
java.util.List |
getChildElements(org.w3c.dom.Node node)
This method returns a List of all child Elements below the given Node. |
java.util.List |
getChildElements(org.w3c.dom.Node node,
java.lang.String name)
This method returns a List of all child Elements below the given Node matching the given name. |
ComponentType |
getComponentType(LayoutElement elt,
java.lang.String type)
This utility method returns the requested component type. |
org.xml.sax.EntityResolver |
getEntityResolver()
Accessor for the entityResolver. |
org.xml.sax.ErrorHandler |
getErrorHandler()
Accessor for the ErrorHandler. |
java.lang.String |
getTextNodesAsString(org.w3c.dom.Node node)
This method returns the String representation of all the Node.TEXT_NODE nodes that are children of the given Node. |
java.net.URL |
getURL()
Accessor for the URL. |
LayoutDefinition |
read()
The read method opens the given URL and parses the XML document that it points to. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ATTRIBUTE_ELEMENT
public static final java.lang.String COMPONENT_ELEMENT
public static final java.lang.String COMPONENT_TYPE_ELEMENT
public static final java.lang.String EVENT_ELEMENT
public static final java.lang.String FACET_ELEMENT
public static final java.lang.String FOREACH_ELEMENT
public static final java.lang.String HANDLER_ELEMENT
public static final java.lang.String HANDLERS_ELEMENT
public static final java.lang.String HANDLER_DEFINITION_ELEMENT
public static final java.lang.String IF_ELEMENT
public static final java.lang.String INPUT_DEF_ELEMENT
public static final java.lang.String INPUT_ELEMENT
public static final java.lang.String LAYOUT_DEFINITION_ELEMENT
public static final java.lang.String LAYOUT_ELEMENT
public static final java.lang.String LIST_ELEMENT
public static final java.lang.String MARKUP_ELEMENT
public static final java.lang.String OPTION_ELEMENT
public static final java.lang.String OUTPUT_DEF_ELEMENT
public static final java.lang.String OUTPUT_MAPPING_ELEMENT
public static final java.lang.String STATIC_TEXT_ELEMENT
public static final java.lang.String TYPES_ELEMENT
public static final java.lang.String RESOURCES_ELEMENT
public static final java.lang.String RESOURCE_ELEMENT
public static final java.lang.String WHILE_ELEMENT
public static final java.lang.String CLASS_NAME_ATTRIBUTE
public static final java.lang.String CONDITION_ATTRIBUTE
public static final java.lang.String DEFAULT_ATTRIBUTE
public static final java.lang.String DESCRIPTION_ATTRIBUTE
public static final java.lang.String EXTRA_INFO_ATTRIBUTE
public static final java.lang.String FACTORY_CLASS_ATTRIBUTE
public static final java.lang.String ID_ATTRIBUTE
public static final java.lang.String KEY_ATTRIBUTE
public static final java.lang.String LIST_ATTRIBUTE
public static final java.lang.String METHOD_NAME_ATTRIBUTE
public static final java.lang.String NAME_ATTRIBUTE
public static final java.lang.String OUTPUT_NAME_ATTRIBUTE
public static final java.lang.String OVERWRITE_ATTRIBUTE
public static final java.lang.String PROPERTY_ATTRIBUTE
public static final java.lang.String RENDERED_ATTRIBUTE
public static final java.lang.String REQUIRED_ATTRIBUTE
public static final java.lang.String TAG_ATTRIBUTE
public static final java.lang.String TARGET_KEY_ATTRIBUTE
public static final java.lang.String TARGET_TYPE_ATTRIBUTE
public static final java.lang.String TYPE_ATTRIBUTE
public static final java.lang.String VALUE_ATTRIBUTE
public static final java.lang.String AUTO_RENDERED
Constructor Detail |
---|
public XMLLayoutDefinitionReader(java.net.URL url, org.xml.sax.EntityResolver entityResolver, org.xml.sax.ErrorHandler errorHandler, java.lang.String baseURI)
url
- A URL pointing to the LayoutDefinition
entityResolver
- EntityResolver to use, may be (null)errorHandler
- ErrorHandler to use, may be (null)baseURI
- The base URI passed to DocumentBuilder.parse()Method Detail |
---|
public java.net.URL getURL()
public org.xml.sax.EntityResolver getEntityResolver()
public org.xml.sax.ErrorHandler getErrorHandler()
public java.lang.String getBaseURI()
public LayoutDefinition read() throws java.io.IOException
The read method opens the given URL and parses the XML document
that it points to. It then walks the DOM and populates a
LayoutDefinition
structure, which is returned.
LayoutDefinition
java.io.IOException
public HandlerDefinition createHandlerDefinition(org.w3c.dom.Node node)
This method takes the given HANDLER_DEFINITION_ELEMENT node and reads the ID_ATTRIBUTE, CLASS_NAME_ATTRIBUTE, and METHOD_NAME_ATTRIBUTE attributes. It then instantiates a new HandlerDefinition object.
Next it looks to see if the HandlerDefinition has child inputDef, outputDef, and/or nested handler elements. If so it processes them.
node
- The HANDLER_DEFINITION_ELEMENT node to extract
information from when creating the HandlerDefinition.
public java.util.List getChildElements(org.w3c.dom.Node node)
node
- The node to pull child elements from.
public java.util.List getChildElements(org.w3c.dom.Node node, java.lang.String name)
This method returns a List of all child Elements below the given Node matching the given name. If name equals null, all Elements below this node will be returned.
node
- The node to pull child elements from.name
- The name of the Elements to return.
public java.lang.String getTextNodesAsString(org.w3c.dom.Node node)
node
- The node to pull child elements from.
public java.util.Map getAttributes(org.w3c.dom.Node node)
node
- The node to pull attributes from.
public ComponentType getComponentType(LayoutElement elt, java.lang.String type)
elt
- A LayoutElement whose root is LayoutDefinition
type
- The String type to lookup
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |