Package com.sun.enterprise.deployment.node

Interface XMLNode<T>

All Known Subinterfaces:

RootXMLNode<T>

All Known Implementing Classes:

AbsoluteOrderingNode, AbstractBundleNode, ActivationConfigNode, ActivationConfigNode, ActivationSpecNode, AddressingNode, AdministeredObjectDefinitionNode, AdminObjectNode, AppClientNode, AppClientRuntimeNode, ApplicationNode, ApplicationParamNode, ApplicationRuntimeNode, AroundInvokeNode, AroundTimeoutNode, AuthConstraintNode, AuthMechNode, BeanCacheNode, BeanPoolNode, CacheHelperNode, CacheMappingNode, CacheNode, CheckpointAtEndOfMethodNode, ClassLoaderNode, CmpFieldNode, CmpNode, CmpResourceNode, ConcurrentMethodNode, ConfigPropertyNode, ConfigurableNode, ConnectionDefNode, ConnectionFactoryDefinitionNode, ConnectorNode, ConnectorNode, ConstraintFieldNode, ContainerTransactionNode, ContextServiceDefinitionNode, CookieConfigNode, CookiePropertiesNode, DataSourceDefinitionNode, DefaultHelperNode, DefaultResourcePrincipalNode, DefaultResourcePrincipalNode, DefaultWebServiceLoginConfigNode, DeploymentDescriptorNode, DisplayableComponentNode, EjbApplicationExceptionNode, EjbBundleNode, EjbBundleRuntimeNode, EjbEntityNode, EjbInitNode, EjbInterceptorNode, EjbLocalReferenceNode, EjbNode, EjbNode, EjbReferenceDescriptionNode, EjbReferenceNode, EjbRefNode, EjbRelationNode, EjbRelationshipRoleNode, EjbRemoveNode, EjbSessionNode, EnterpriseBeansRuntimeNode, EntityManagerFactoryReferenceNode, EntityManagerReferenceNode, EnvEntryNode, ErrorPageNode, ExcludeListNode, FilterMappingNode, FilterNode, FinderNode, FlushAtEndOfMethodNode, GFAppClientRuntimeNode, GFApplicationRuntimeNode, GFEjbBundleRuntimeNode, GFWebBundleRuntimeNode, GroupNode, IconNode, IdempotentUrlPatternNode, InBoundRANode, InitParamNode, InjectionTargetNode, InterceptorBindingNode, InterfaceBasedEjbNode, IORConfigurationNode, JavaWebStartAccessNode, JaxrpcMappingDescriptorNode, JMSConnectionFactoryDefinitionNode, JMSDestinationDefinitionNode, JnlpDocNode, JspConfigNode, JspConfigRuntimeNode, JspGroupNode, LicenseNode, LifecycleCallbackNode, ListenerNode, LocaleCharsetInfoNode, LocaleCharsetMapNode, LocaleEncodingMappingListNode, LocaleEncodingMappingNode, LocalizedInfoNode, LocalizedNode, LoginConfigNode, MailConfigurationNode, MailSessionNode, ManagedExecutorDefinitionNode, ManagedScheduledExecutorDefinitionNode, ManagedThreadFactoryDefinitionNode, ManagerPropertiesNode, MapElementNode, MDBConnectionFactoryNode, MDBResourceAdapterNode, MessageDestinationNode, MessageDestinationRefNode, MessageDestinationRefNode, MessageDestinationRuntimeNode, MessageDrivenBeanNode, MessageListenerNode, MessageNode, MessageSecurityBindingNode, MessageSecurityNode, MethodNode, MethodPermissionNode, MimeMappingNode, ModuleNode, MultipartConfigNode, NameValuePairNode, OrderingNode, OrderingOrderingNode, OutBoundRANode, PayaraWebBundleRuntimeNode, PermissionItemNode, PermissionsNode, PersistenceNode, PersistenceUnitNode, PMDescriptorNode, PMDescriptorsNode, PMInUseNode, PrefetchDisabledNode, PrincipalNameNode, PrincipalNode, PrincipalNode, PropertiesNode, ProtectionNode, QueryNode, RANode, RelationshipsNode, ReliabilityConfigNode, RequiredConfigNode, ResourceAdapterNode, ResourceDescriptionNode, ResourceEnvDescriptionNode, ResourceEnvRefNode, ResourceEnvRefNode, ResourcePropertyNode, ResourceRefNode, ResourceRefNode, RespectBindingNode, RoleMapNode, RunAsNode, RuntimeBundleNode, RuntimeDescriptorNode, RuntimeNameValuePairNode, ScheduledTimerNode, SecurityConstraintNode, SecurityIdentityNode, SecurityPermissionNode, SecurityRoleAssignmentNode, SecurityRoleMappingNode, SecurityRoleNode, SecurityRoleRefNode, ServiceReferenceNode, ServiceRefNode, ServiceRefPortInfoRuntimeNode, ServletMappingNode, ServletNode, ServletNode, SessionConfigNode, SessionConfigNode, SessionManagerNode, SessionPropertiesNode, StorePropertiesNode, TagLibNode, TimeoutValueNode, UserDataConstraintNode, ValveNode, WebBundleNode, WebBundleRuntimeNode, WebCacheNode, WebCommonNode, WebFragmentNode, WeblogicApplicationNode, WebPropertyContainerNode, WebPropertyNode, WebResourceCollectionNode, WebServiceEndpointNode, WebServiceEndpointRuntimeNode, WebServiceHandlerChainNode, WebServiceHandlerNode, WebServiceNode, WebServiceRuntimeNode, WebServicesDescriptorNode, WLServiceRefNode, WLServiceRefPortInfoRuntimeNode, WLUnSupportedNode, WLWebServiceEndpointNode, WLWebServiceEndpointNode.ServiceEndpointAddressNode, WLWebServiceEndpointNode.WSDLNode, WLWebServiceNode, WLWebServicesDescriptorNode

@Contract
public interface XMLNode<T>

This interface defines the protocol associated with all the nodes. An XML node is responsible for reading the XML file into a object representation

Version:

Author:

Jerome Dochez

Method Summary

Modifier and Type	Method	Description
void	addDescriptor(Object descriptor)	Add a new descriptor to the current descriptor associated with this node.
void	addPrefixMapping(String prefix, String uri)	notify of a new prefix mapping used from this node
boolean	endElement(XMLElement element)	notification of the end of an XML element in the source XML file.
T	getDescriptor()
XMLNode	getHandlerFor(XMLElement element)	Return the XMLNode implementation respionsible for handling the sub-element of the current node
XMLNode	getParentNode()
XMLNode	getRootNode()
String	getXMLPath()
boolean	handlesElement(XMLElement element)	Return true if the XMLNode is responisble for handling the XML element
String	resolvePrefix(XMLElement element, String prefix)	Resolve a QName prefix to its corresponding Namespace URI by searching up node chain starting with the child.
void	setElementValue(XMLElement element, String value)	sets the value of an XML element
void	startElement(XMLElement element, Attributes attributes)	notification of the start of an XML element tag in the processed XML source file.
Node	writeDescriptor(Node parent, T descriptor)	write the descriptor to an JAXP DOM node and return it

Method Detail

startElement

void startElement(XMLElement element,
                  Attributes attributes)

notification of the start of an XML element tag in the processed XML source file.

Parameters:

element - the XML element type name

attributes - the specified or defaultted attritutes

setElementValue

void setElementValue(XMLElement element,
                     String value)

sets the value of an XML element

Parameters:

element - the XML element type name

value - the element value

endElement

boolean endElement(XMLElement element)

notification of the end of an XML element in the source XML file.

Parameters:

element - the XML element type name

Returns:

true if this node is done with the processing of elements in the processing

handlesElement

boolean handlesElement(XMLElement element)

Return true if the XMLNode is responisble for handling the XML element

Parameters:

element - the XML element type name

Returns:

true if the node processes this element name

getHandlerFor

XMLNode getHandlerFor(XMLElement element)

Return the XMLNode implementation respionsible for handling the sub-element of the current node

Parameters:

element - the XML element type name

Returns:

XMLNode implementation responsible for handling the XML tag

getParentNode

XMLNode getParentNode()

Returns:

the parent node for this XMLNode

getRootNode

XMLNode getRootNode()

Returns:

the root node for this XMLNode

getXMLPath

String getXMLPath()

Returns:

the XMLPath for the element name this node is handling. The XML path can be a absolute or a relative XMLPath.

getDescriptor

T getDescriptor()

Returns:

the Descriptor subclass that was populated by reading the source XML file

addDescriptor

void addDescriptor(Object descriptor)

Add a new descriptor to the current descriptor associated with this node. This method is usually called by sub XMLNodes (Returned by getHandlerFor) to add the result of their parsing to the main descriptor.

Parameters:

descriptor - the new descriptor to be added to the current descriptor.

writeDescriptor

Node writeDescriptor(Node parent,
                     T descriptor)

write the descriptor to an JAXP DOM node and return it

Parameters:

parent - node in the DOM tree

descriptor - the descriptor to be written

Returns:

the JAXP DOM node for this descriptor

addPrefixMapping

void addPrefixMapping(String prefix,
                      String uri)

notify of a new prefix mapping used from this node

resolvePrefix

String resolvePrefix(XMLElement element,
                     String prefix)

Resolve a QName prefix to its corresponding Namespace URI by searching up node chain starting with the child.