| org.apache.commons.betwixt.io.BeanReader
| Constructor Summary | |
| public | BeanReader()
Construct a new BeanReader with default properties. | | public | BeanReader(SAXParser parser)
Construct a new BeanReader, allowing a SAXParser to be passed in. | | public | BeanReader(XMLReader reader)
Construct a new BeanReader, allowing an XMLReader to be passed in. |
| BeanReader | | public BeanReader()(Code) | | Construct a new BeanReader with default properties.
|
| BeanReader | | public BeanReader(SAXParser parser)(Code) | | Construct a new BeanReader, allowing a SAXParser to be passed in. This
allows BeanReader to be used in environments which are unfriendly to
JAXP1.1 (such as WebLogic 6.0). Thanks for the request to change go to
James House (james@interobjective.com). This may help in places where
you are able to load JAXP 1.1 classes yourself.
Parameters:
parser - use this SAXParser |
| BeanReader | | public BeanReader(XMLReader reader)(Code) | | Construct a new BeanReader, allowing an XMLReader to be passed in. This
allows BeanReader to be used in environments which are unfriendly to
JAXP1.1 (such as WebLogic 6.0). Note that if you use this option you
have to configure namespace and validation support yourself, as these
properties only affect the SAXParser and emtpy constructor.
Parameters:
reader - use this XMLReader as source for SAX events |
| addBeanCreateRule | | protected void addBeanCreateRule(String path, ElementDescriptor elementDescriptor, Class beanClass)(Code) | | Adds a new bean create rule for the specified path
Parameters:
path - the digester path at which this rule should be added
Parameters:
elementDescriptor - the ElementDescriptor describes the expected element
Parameters:
beanClass - the Class of the bean created by this rule |
| deregisterBeanClass | | public void deregisterBeanClass(Class beanClass)(Code) | | Remove the given class from the register.
Calling this method will allow the bean class to be re-registered
by a subsequent call to registerBeanClass.
This allows (for example) a bean to be reintrospected after a change
to the introspection settings.
Note that deregistering a bean does not
remove the Digester rules associated with that bean.
Parameters:
beanClass - the Class to remove from the set of registered bean classes
since:
0.5 |
| flushRegisteredBeanClasses | | public void flushRegisteredBeanClasses()(Code) | | Flush all registered bean classes.
This allows all bean classes to be re-registered
by a subsequent calls to registerBeanClass.
Note that deregistering a bean does not
remove the Digester rules associated with that bean.
since:
0.5 |
| getBindingConfiguration | | public BindingConfiguration getBindingConfiguration()(Code) | | Gets the dynamic configuration setting to be used for bean reading.
the BindingConfiguration settings, not null
since:
0.5 |
| getLog | | public Log getLog()(Code) | | Get the current level for logging.
the Log implementation this class logs to |
| getMatchIDs | | public boolean getMatchIDs()(Code) | | Should the reader use ID attributes to match beans.
true if ID and IDREF attributes should be used to match instancesBindingConfiguration.getMapIDs |
| getReadConfiguration | | public ReadConfiguration getReadConfiguration()(Code) | | Gets read specific configuration details.
the ReadConfiguration, not null
since:
0.5 |
| getXMLIntrospector | | public XMLIntrospector getXMLIntrospector()(Code) | | Get the introspector used.
The
XMLBeanInfo used to map each bean is
created by the XMLIntrospector.
One way in which the mapping can be customized is by
altering the XMLIntrospector.
the XMLIntrospector used for the introspection |
| registerBeanClass | | public void registerBeanClass(Class beanClass) throws IntrospectionException(Code) | | Register a bean class and add mapping rules for this bean class.
A bean class is introspected when it is registered.
It will not be introspected again even if the introspection
settings are changed.
If re-introspection is required, then
BeanReader.deregisterBeanClass must be called
and the bean re-registered.
A bean class can only be registered once.
If the same class is registered a second time, this registration will be ignored.
In order to change a registration, call
BeanReader.deregisterBeanClass
before calling this method.
All the rules required to digest this bean are added when this method is called.
Other rules that you want to execute before these should be added before this
method is called.
Those that should be executed afterwards, should be added afterwards.
Parameters:
beanClass - the Class to be registered
throws:
IntrospectionException - if the bean introspection fails |
| registerBeanClass | | public void registerBeanClass(String path, Class beanClass) throws IntrospectionException(Code) | | Registers a bean class
and add mapping rules for this bean class at the given path expression.
A bean class is introspected when it is registered.
It will not be introspected again even if the introspection
settings are changed.
If re-introspection is required, then
BeanReader.deregisterBeanClass must be called
and the bean re-registered.
A bean class can only be registered once.
If the same class is registered a second time, this registration will be ignored.
In order to change a registration, call
BeanReader.deregisterBeanClass
before calling this method.
All the rules required to digest this bean are added when this method is called.
Other rules that you want to execute before these should be added before this
method is called.
Those that should be executed afterwards, should be added afterwards.
Parameters:
path - the xml path expression where the class is to registered. This should be in digester path notation
Parameters:
beanClass - the Class to be registered
throws:
IntrospectionException - if the bean introspection fails |
| registerBeanClass | | public void registerBeanClass(InputSource mapping, Class beanClass) throws IntrospectionException, IOException, SAXException(Code) | | Registers a class with a custom mapping.
This mapping is specified by the standard dot betwixt document
contained in the given InputSource.
Note: the custom mapping will be registered with
the introspector. This must remain so for the reading to work correctly
It is recommended that use of the pre-registeration process provided
by
XMLIntrospector.register be considered as an alternative to this method.
See Also: BeanReader.registerBeanClass(Class)
See Also: since the general notes given there
See Also: apply equally to this
since:
0.7
Parameters:
mapping - InputSource giving the dot betwixt document specifying the mapping
Parameters:
beanClass - Class that should be register
throws:
IntrospectionException -
throws:
SAXException -
throws:
IOException - |
| setBindingConfiguration | | public void setBindingConfiguration(BindingConfiguration bindingConfiguration)(Code) | | Sets the dynamic configuration setting to be used for bean reading.
Parameters:
bindingConfiguration - the BindingConfiguration settings, not null
since:
0.5 |
| setLog | | public void setLog(Log log)(Code) | | Set the current logging level.
Parameters:
log - the Logimplementation to use for logging |
| setMatchIDs | | public void setMatchIDs(boolean matchIDs)(Code) | | Set whether the read should use ID attributes to match beans.
Parameters:
matchIDs - pass true if ID's should be matchedBindingConfiguration.setMapIDs |
| setReadConfiguration | | public void setReadConfiguration(ReadConfiguration readConfiguration)(Code) | | Sets the read specific configuration details.
Parameters:
readConfiguration - not null
since:
0.5 |
| setXMLIntrospector | | public void setXMLIntrospector(XMLIntrospector introspector)(Code) | | Set the introspector to be used.
The
XMLBeanInfo used to map each bean is
created by the XMLIntrospector.
One way in which the mapping can be customized is by
altering the XMLIntrospector.
Parameters:
introspector - use this introspector |
|
|