| java.lang.Object
 org.jfree.xml.util.AbstractModelReader
All known Subclasses: org.jfree.xml.generator.DefaultModelReader, org.jfree.xml.util.ObjectFactoryLoader,
| AbstractModelReader | | abstract public class AbstractModelReader (Code) | | Loads the class model from an previously written xml file set.
This class provides abstract methods which get called during the parsing
(similiar to the SAX parsing, but slightly easier to code).
This will need a rewrite in the future, when the structure is finished.
|
| Method Summary | |
| protected void | endIncludeHandling()
End handling an include. | | abstract protected void | endMultiplexMapping()
Finializes the multiplexer mapping. | | abstract protected void | endObjectDefinition()
Finializes the object definition. | | protected void | endRootDocument()
End the root document. | | protected String[] | getCloseComment()
Returns the close comment. | | protected CommentHandler | getCommentHandler()
Returns the comment handler. | | protected String[] | getOpenComment()
Returns the open comment. | | abstract protected void | handleAttributeDefinition(String name, String attribName, String handlerClass)
Handles an attribute definition. | | abstract protected void | handleConstructorDefinition(String propertyName, String parameterClass)
Handles a constructor definition. | | abstract protected void | handleElementDefinition(String name, String element)
Handles an element definition. | | protected void | handleIgnoredProperty(String name)
Callback method for ignored properties. | | abstract protected void | handleLookupDefinition(String name, String lookupKey)
Handles an lookup definition. | | abstract protected boolean | handleManualMapping(String className, String readHandler, String writeHandler)
Handles a manual mapping definition. | | abstract protected void | handleMultiplexMapping(String typeName, String className)
Defines an entry for the multiplex mapping. | | protected Class | loadClass(String className)
Loads the given class, and ignores all exceptions which may occur
during the loading. | | protected void | parseXml(URL resource)
Parses an XML document at the given URL. | | protected void | parseXmlDocument(URL resource, boolean isInclude)
Parses the given specification and loads all includes specified in the files. | | protected void | setCloseComment(String[] closeComment)
Sets the close comment. | | protected void | setOpenComment(String[] openComment)
Sets the open comment. | | protected void | startIncludeHandling(URL resource)
Start handling an include. | | abstract protected void | startMultiplexMapping(String className, String typeAttr)
Starts a multiplex mapping. | | abstract protected boolean | startObjectDefinition(String className, String register, boolean ignored)
Starts a object definition. | | protected void | startRootDocument()
Start the root document. |
| AbstractModelReader | | public AbstractModelReader()(Code) | | Default Constructor.
|
| endIncludeHandling | | protected void endIncludeHandling()(Code) | | End handling an include.
|
| endRootDocument | | protected void endRootDocument()(Code) | | End the root document.
|
| getCloseComment | | protected String[] getCloseComment()(Code) | | Returns the close comment.
The close comment. |
| getCommentHandler | | protected CommentHandler getCommentHandler()(Code) | | Returns the comment handler.
The comment handler. |
| getOpenComment | | protected String[] getOpenComment()(Code) | | Returns the open comment.
The open comment. |
| handleAttributeDefinition | | abstract protected void handleAttributeDefinition(String name, String attribName, String handlerClass) throws ObjectDescriptionException(Code) | | Handles an attribute definition. This method gets called after the object definition
was started. The method will be called for every defined attribute property.
Parameters:
name - the name of the property
Parameters:
attribName - the xml-attribute name to use later.
Parameters:
handlerClass - the attribute handler class.
throws:
ObjectDescriptionException - if an error occured. |
| handleConstructorDefinition | | abstract protected void handleConstructorDefinition(String propertyName, String parameterClass) throws ObjectDescriptionException(Code) | | Handles a constructor definition. Only one constructor can be defined for
a certain object type. The constructor will be filled using the given properties.
Parameters:
propertyName - the property name of the referenced local property
Parameters:
parameterClass - the parameter class for the parameter.
throws:
ObjectDescriptionException - if an error occured. |
| handleElementDefinition | | abstract protected void handleElementDefinition(String name, String element) throws ObjectDescriptionException(Code) | | Handles an element definition. This method gets called after the object definition
was started. The method will be called for every defined element property. Element
properties are used to describe complex objects.
Parameters:
name - the name of the property
Parameters:
element - the xml-tag name for the child element.
throws:
ObjectDescriptionException - if an error occurs. |
| handleIgnoredProperty | | protected void handleIgnoredProperty(String name)(Code) | | Callback method for ignored properties. Such properties get marked so that
the information regarding these properties won't get lost.
Parameters:
name - the name of the ignored property. |
| handleLookupDefinition | | abstract protected void handleLookupDefinition(String name, String lookupKey) throws ObjectDescriptionException(Code) | | Handles an lookup definition. This method gets called after the object definition
was started. The method will be called for every defined lookup property. Lookup properties
reference previously created object using the object's registry name.
Parameters:
name - the property name of the base object
Parameters:
lookupKey - the register key of the referenced object
throws:
ObjectDescriptionException - if an error occured. |
| handleManualMapping | | abstract protected boolean handleManualMapping(String className, String readHandler, String writeHandler) throws ObjectDescriptionException(Code) | | Handles a manual mapping definition. The manual mapping maps specific
read and write handlers to a given base class. Manual mappings always
override any other definition.
Parameters:
className - the base class name
Parameters:
readHandler - the class name of the read handler
Parameters:
writeHandler - the class name of the write handler true, if the mapping was accepted, false otherwise.
throws:
ObjectDescriptionException - if an unexpected error occured. |
| handleMultiplexMapping | | abstract protected void handleMultiplexMapping(String typeName, String className) throws ObjectDescriptionException(Code) | | Defines an entry for the multiplex mapping. The new entry will be activated
when the base mappers type attribute contains this typename and
will resolve to the handler for the given classname.
Parameters:
typeName - the type value for this mapping.
Parameters:
className - the class name to which this mapping resolves.
throws:
ObjectDescriptionException - if an error occurs. |
| loadClass | | protected Class loadClass(String className)(Code) | | Loads the given class, and ignores all exceptions which may occur
during the loading. If the class was invalid, null is returned instead.
Parameters:
className - the name of the class to be loaded. the class or null. |
| parseXmlDocument | | protected void parseXmlDocument(URL resource, boolean isInclude) throws ObjectDescriptionException(Code) | | Parses the given specification and loads all includes specified in the files.
This implementation does not check for loops in the include files.
Parameters:
resource - the url of the xml specification.
Parameters:
isInclude - an include?
throws:
org.jfree.xml.util.ObjectDescriptionException - if an error occured which prevented theloading of the specifications. |
| setCloseComment | | protected void setCloseComment(String[] closeComment)(Code) | | Sets the close comment.
Parameters:
closeComment - the close comment. |
| setOpenComment | | protected void setOpenComment(String[] openComment)(Code) | | Sets the open comment.
Parameters:
openComment - the open comment. |
| startIncludeHandling | | protected void startIncludeHandling(URL resource)(Code) | | Start handling an include.
Parameters:
resource - the URL. |
| startMultiplexMapping | | abstract protected void startMultiplexMapping(String className, String typeAttr)(Code) | | Starts a multiplex mapping. Multiplex mappings are used to define polymorphic
argument handlers. The mapper will collect all derived classes of the given
base class and will select the corresponding mapping based on the given type
attribute.
Parameters:
className - the base class name
Parameters:
typeAttr - the xml-attribute name containing the mapping key |
| startObjectDefinition | | abstract protected boolean startObjectDefinition(String className, String register, boolean ignored) throws ObjectDescriptionException(Code) | | Starts a object definition. The object definition collects all properties of
an bean-class and defines, which constructor should be used when creating the
class.
Parameters:
className - the class name of the defined object
Parameters:
register - the (optional) register name, to lookup and reference the objectlater.
Parameters:
ignored - ??. true, if the definition was accepted, false otherwise.
throws:
ObjectDescriptionException - if an unexpected error occured. |
| startRootDocument | | protected void startRootDocument()(Code) | | Start the root document.
|
|
|