com.massa.mrules.factory.xml

Class RichXMLFactory.GenericAddon<A extends IAddon>

java.lang.Object

com.massa.mrules.factory.xml.RichXMLFactory.GenericAddon<A>

All Implemented Interfaces:

RichXMLFactory.RichSubFactory<A>

Direct Known Subclasses:

RichXMLFactory.CALLAddon, RichXMLFactory.FORMATAddon, RichXMLFactory.INDEXAddon, RichXMLFactory.MainRuleFactoryImpl

Enclosing class:

RichXMLFactory

public class RichXMLFactory.GenericAddon<A extends IAddon>
extends Object
implements RichXMLFactory.RichSubFactory<A>

SubFactory used by default if an addon does not have its own SubFactory. Parses the current addon by :

• Parsing all subnodes as addons, injecting result in current addon similarly named property.
• Parsing all attributes, except "class" and "implem", injecting result in current addon similarly named property.

Constructor Summary

Constructors

Constructor and Description
GenericAddon()

Method Summary

Modifier and Type	Method and Description
void	afterWriteChildren(Outer os, A addon, String nodeName, Map<PersistantPropertyInfo,Object> deferredNodes) Called if current node has children, after writing them.
boolean	beforeCloseNoChild(Outer os, A addon, String nodeName) Called if current node has no child: will be called after attributes writing.
void	beforeWriteChildren(Outer os, A addon, String nodeName, Map<PersistantPropertyInfo,Object> deferredNodes) Called if current node has children, before writing them.
String	getImplementationId() Null for generic implem.
protected void	handleReadAttr(A addon, Node node, Node attr)
protected void	handleReadAttributes(Node mainNode, A addon)
protected void	handleReadChildNodes(Node mainNode, A addon)
protected void	handleReadNode(A addon, Node node)
protected void	handleWriteAttribute(Outer os, A addon, PersistantPropertyInfo property, Object propertyValue, String defaultValue)
protected void	handleWriteNode(Outer os, A addon, PersistantPropertyInfo property, Object propertyValue)
protected void	injectIntoProperty(Object target, Node node, String propertyName)
protected boolean	isWriteAsAttribute(PersistantPropertyInfo property, Object propertyValue) Does value should be writen as node ?
protected boolean	isWriteAsNode(PersistantPropertyInfo property, Object propertyValue) Does value should be writen as attribute?
A	read(Node mainNode)
protected Object	readPersistantObject(Node node, Class<?> type)
void	write(Outer os, A addon)
void	write(Outer os, A addon, String nodeName)
void	writePersistantObject(Outer os, String property, Object propertyValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericAddon

public GenericAddon()

Method Detail

read

public A read(Node mainNode)
       throws XMLMConfigurationException

Specified by:

read in interface RichXMLFactory.RichSubFactory<A extends IAddon>

Throws:

XMLMConfigurationException

handleReadChildNodes

protected void handleReadChildNodes(Node mainNode,
                                    A addon)
                             throws XMLMConfigurationException

Throws:

XMLMConfigurationException

handleReadAttributes

protected void handleReadAttributes(Node mainNode,
                                    A addon)
                             throws XMLMConfigurationException

Throws:

XMLMConfigurationException

handleReadNode

protected void handleReadNode(A addon,
                              Node node)
                       throws XMLMConfigurationException

Throws:

XMLMConfigurationException

injectIntoProperty

protected void injectIntoProperty(Object target,
                                  Node node,
                                  String propertyName)
                           throws UtilsException,
                                  XMLMConfigurationException

Throws:

UtilsException

XMLMConfigurationException

readPersistantObject

protected Object readPersistantObject(Node node,
                                      Class<?> type)
                               throws UtilsException,
                                      XMLMConfigurationException

Throws:

UtilsException

XMLMConfigurationException

handleReadAttr

protected void handleReadAttr(A addon,
                              Node node,
                              Node attr)
                       throws XMLMConfigurationException

Throws:

XMLMConfigurationException

write

public void write(Outer os,
                  A addon)
           throws XMLMConfigurationException,
                  IOException

Throws:

XMLMConfigurationException

IOException

write

public void write(Outer os,
                  A addon,
                  String nodeName)
           throws XMLMConfigurationException,
                  IOException

Specified by:

write in interface RichXMLFactory.RichSubFactory<A extends IAddon>

Throws:

XMLMConfigurationException

IOException

beforeCloseNoChild

public boolean beforeCloseNoChild(Outer os,
                                  A addon,
                                  String nodeName)
                           throws XMLMConfigurationException,
                                  IOException

Called if current node has no child: will be called after attributes writing.
Default implementation does nothing except return true.

Returns:

true, if node should close normally. False if some children where added. If false is returned, "beforeCloseNoChild" method is responsible for closing.

Throws:

XMLMConfigurationException

IOException

beforeWriteChildren

public void beforeWriteChildren(Outer os,
                                A addon,
                                String nodeName,
                                Map<PersistantPropertyInfo,Object> deferredNodes)
                         throws XMLMConfigurationException,
                                IOException

Called if current node has children, before writing them.
Default implementation does nothing.

Throws:

XMLMConfigurationException

IOException

afterWriteChildren

public void afterWriteChildren(Outer os,
                               A addon,
                               String nodeName,
                               Map<PersistantPropertyInfo,Object> deferredNodes)
                        throws XMLMConfigurationException,
                               IOException

Called if current node has children, after writing them.
Default implementation does nothing.

Throws:

XMLMConfigurationException

IOException

isWriteAsAttribute

protected boolean isWriteAsAttribute(PersistantPropertyInfo property,
                                     Object propertyValue)
                              throws XMLMConfigurationException,
                                     MRuleInternalException

Does value should be writen as node ?
This method is the strict opposite as #isWriteAsNode(PersistantPropertyInfo, Object), but overriding it might changer caller behaviour and allow a specific data to be written both as attribute and node for instance.

Parameters:

property - property info. might be null.

propertyValue - corresponding property value. might be null.

Throws:

XMLMConfigurationException

MRuleInternalException

See Also:

isWriteAsNode(PersistantPropertyInfo, Object)

isWriteAsNode

protected boolean isWriteAsNode(PersistantPropertyInfo property,
                                Object propertyValue)
                         throws XMLMConfigurationException,
                                MRuleInternalException

Does value should be writen as attribute?
This method is the strict opposite as #isWriteAsAttribute(PersistantPropertyInfo, Object), but overriding it might changer caller behaviour and allow a specific data to be written both as attribute and node for instance.

Parameters:

property - property info. might be null.

propertyValue - corresponding property value. might be null.

Throws:

XMLMConfigurationException

MRuleInternalException

See Also:

isWriteAsAttribute(PersistantPropertyInfo, Object)

handleWriteNode

protected void handleWriteNode(Outer os,
                               A addon,
                               PersistantPropertyInfo property,
                               Object propertyValue)
                        throws XMLMConfigurationException,
                               IOException

Throws:

XMLMConfigurationException

IOException

writePersistantObject

public void writePersistantObject(Outer os,
                                  String property,
                                  Object propertyValue)
                           throws XMLMConfigurationException,
                                  IOException

Throws:

XMLMConfigurationException

IOException

handleWriteAttribute

protected void handleWriteAttribute(Outer os,
                                    A addon,
                                    PersistantPropertyInfo property,
                                    Object propertyValue,
                                    String defaultValue)
                             throws XMLMConfigurationException,
                                    IOException

Throws:

XMLMConfigurationException

IOException

getImplementationId

public String getImplementationId()

Null for generic implem.

Specified by:

getImplementationId in interface RichXMLFactory.RichSubFactory<A extends IAddon>