| Home >> All >> org >> [ jxbeans Javadoc ] |
| • | org.jxbeans.flow_control.* (15) | • | org.jxbeans.input.* (10) | • | org.jxbeans.integration.* (16) |
| • | org.jxbeans.output.* (5) | • | org.jxbeans.tests.* (3) | • | org.jxbeans.transformation.* (5) |
| • | org.jxbeans.utilities.* (7) |
• org.jxbeans: Javadoc index of package org.jxbeans.
Package Samples:
• org.jxbeans.transformation.tests: This package contains classes and JXBeans for performing a variety of data translation and transformation functions in the JXBeans Framework.
• org.jxbeans.flow_control.tests: This package contains classes and JXBeans for performing a variety of process flow of control and branching decisions within a JXBeans model.
• org.jxbeans.output.tests: This package contains classes and JXBeans for performing a variety of data output functions from within the JXBeans Framework.
• org.jxbeans.flow_control.comparators.tests: This package contains classes and JXBeans for performing a variety of data value comparisons in JXBean models.
• org.jxbeans.input.tests: This package contains classes and JXBeans for parsing data in a variety of forms into an XML representation.
• org.jxbeans.integration.email.tests: This package contains classes and JXBeans for integrating with email systems from the JXBeans Framework.
• org.jxbeans.utilities: This package contains the core classes and interfaces of the JXBeans Framework.
• org.jxbeans.flow_control.comparators
• org.jxbeans.flow_control
• org.jxbeans.input
• org.jxbeans.integration.database
• org.jxbeans.integration.email
• org.jxbeans.integration.http
• org.jxbeans.output
• org.jxbeans.transformation
• org.jxbeans.tests
Classes:
• JXBeanModelRunner: The JXBeanModelRunner JXBean will execute another JXBeanModel . This JXBean provides the means of creating JXBean "sub-processes" or "sub-routines". This JXBean works this way: If the model's DocumentGenerator is the SimpleDocumentGenerator , this bean will use the incoming Document to set the document for the SimpleDocumentGenerator . Finally, if the model has a final DocumentReadyListener and is a SimpleDocumentListener , this bean will behave as follows: If the parentElementExpression property has been set, the resulting document will be inserted under the element referred to by the parentElementExpression ...
• AbstractDatabaseJXBean: The AbstractDatabaseAccessor class provides common properties and behavior for database access JXBeans. Authors of JXBeans accessing a database should consider using this class as a superclass. The Connection can be obtained in one of four ways. A Connection object set as a property A DataSource object set as a property A DataSource JNDI name A set of properties including the JDBC driver class name, connection URL, username and password The precedence of usage is: The Connection The DataSource (if the Connection is null ) The DataSource JNDI name (if DataSource is null ) The JDBC driver class name, ...
• Looper: The Looper JXBean will loop over a list of XML elements, selected using an XPath expression. Each iteration through the loop will create a new Document containing the selected element as a the root. This new document will be sent to each DocumentReadyListener in a new DocumentReadyEvent . This JXBean supports PropertyChangeListeners , publishing a single PropertyChangeEvent for the property "numberOfElements". This property represents the number of elements that will be processed during looping. This PropertyChangeEvent is published after entry into the documentReady() method, after the element ...
• XMLTransformer: The XMLTransformer JXBean will transform the incoming XML document using an XSLT "tranformation sheet". Since XSLT can be used to tranform XML into something other than XML (e.g., plain text output, HTML, etc.), this class provides a way to direct its output directly to a file name, File or Writer . If any of these properties is set the transformed output will not be forwarded to the DocumentReadyListeners . The precedence of usage of the output destination is: Writer File (if the Writer is null ) file name (if the File is null )
• AbstractParserJXBean: The AbstractParserJXBean class provides a framework for creating other JXBeans that will parse data from one one a set of possible data sources. These parsing sources include: A Reader object A File object A file name (as a String object) A URL object The precedence of usage of the input source is: Reader File (if the Writer is null ) file name (if the File is null ) URL (if the file name is null )
• AbstractTransformerJXBean: The AbstractTransformerJXBean class provides a framework for creating other JXBeans that require the use of an XSLT transformer. The source of the XSLT tranformation sheet can be set in one of three ways, including: A File object A file name (as a String object) A URL object The precedence of usage of the transformation sheet source is: File (if the Writer is null ) file name (if the File is null ) URL (if the file name is null )
• DocumentGenerator: The DocumentGenerator interface must be implemented by classes wishing to participate in the JXBeans Framework as generator of documents. Objects of classes that implement this interface will generate a new XML document, from some source, to be processed by other JXBeans. As an interface that inherits from the DocumentSource interface, classes that implement this interface must also implement the DocumentSource interface and, therefore, are capable of having objects of classes that implement the DocumentReadyListener interface subscribe to DocumentReadyEvents .
• Retriever: The Retriever JXBean is used for retrieving data from a database using a standard SQL query. The result set from the query is turned into an XML document. The resulting XML document can optionally be inserted into the incoming XML document by setting an XPath expression of the parent element under which the new document should be inserted. Otherwise, output from this JXBean is simply the result set of the query. This JXBean also provides some control over the names of the result set and row elements generated from a result set. Result set column name are used for elements within rows.
• Logger: The Logger JXBean will log either a string message, the incoming document or a transformation of the incoming document to a specified log category at a specified log priority. However, currently, the entire document is only logged at the debug priority, if debugging is turned on. This bean uses the Log4J logging API. The order of precedence in logging is first the string message, second using the XSLT transformation sheet (if the string message is null ), and finally the entire document (if there is no XSLT transformation sheet set).
• Parallelizer: This JXBean will convey a document to multiple DocumentReadyListeners in turn. Each DocumentReadyListener will get the document one at a time (i.e., not parallel in a multi-threaded sense). This JXBean supports PropertyChangeListeners, publishing a single PropertyChangeEvent for the property "numberOfListeners". This property represents the number of listeners that will be handed the document during looping. This PropertyChangeEvent is published after entry into the documentReady method, but before the first DocumentReadyListener gets notified.
• Serializer: The Serializer JXBean writes an XML document, as text, to one of three different output targets. These output targets include: A Writer object A File object A file name (as a String object) The precedence of usage of the output destination is: Writer File (if the Writer is null ) file name (if the File is null )
• DocumentSource: The DocumentSource interface must be implemented by classes wishing to participate in the JXBeans Framework as a source of DocumentReadyEvents . Objects of classes, implementing the DocumentReadyListener interface, can subscribe to the DocumentReadyEvent by adding themselves as DocumentReadyListeners . Objects of classes that implement this interface are considered to be "source" JXBeans.
• JXBeanModel: The JXBeanModel class represents a JXBean model. A model, in JXBeans nomeclature, is a collection of JXBeans that have been assembled, connected together and configured for some specific purpose. You might think of a JXBean model as "mini application" or perhaps a "process flow". All JXBean models have a single starting point, and proceed to process XML documents, passing these documents to subsequent JXBeans in the model until the end.
• SimpleDocumentGenerator: The SimpleDocumentGenerator class provides a very simple implementation of the DocumentGenerator interface. Specifically, objects of this class can be used if the document to be process has already been generated by some other means in the hosting application. Alternatively, if there is no real starting document, an object of this class can be used to generate a simple, empty document to get a model going.
• DocumentReadyEvent: The DocumentReadyEvent is the central event in the JXBeans Framework. Instances of this event are used to communicate from one JXBean to another when a document is ready to be processed. This event can be published from objects of any class that implements the DocumentSource interface. The event will contain a reference to the Document to be processed and a reference to the publishing object.
• DocumentReadyListener: The DocumentReadyListener interface must be implemented by classes wishing to participate in the JXBeans Framework as receivers of DocumentReadyEvents . Objects of classes that implement this interface are able to receive DocumentReadyEvents if they subscribe to such events from a objects of classes implementing the DocumentSource interface.
• Decision: The Decision JXBean represents an "if" condition in a JXBean model. If the XPath expression property evaluates to true , the a DocumentReadyEvent will be sent to the standard DocumentReadyListeners . If the XPath expression evaluates to false , a DocumentReadyEvent will be sent to the "false" DocumentReadyListener .
• Emailer: The Emailer JXBean looks for a set of elements named "email" in the incoming Document and extracts information ("to" email address, "from" email address, subject, body, attachments) from each "email" element to construct an email message to be sent. This class uses the Email utility class to actually send the email messages.
• Pruner: The Pruner JXBeans is used to remove part of the XML document before passing it along to its DocumentReadyListeners. This JXBeans can be configured to either cut out the element (and its children) represented by an XPath expression, or cut our everything except the element (and its children) represented by an XPath expression.
• JXBeanException: The JXBeanException is the exception that can be thrown by any JXBean. This exception provides constructors so that detailed information about the failure can be provided by the JXBean that throws this exception, including the document that was being processed and the causing exception, if applicable.
• SimpleDocumentListener: The SimpleDocumentListener provides a very simple implementation of the DocumentReadyListener interface. Objects of this class simply receive the DocumentReadyEvent , grab the document and hold on to it for future use (by another object requesting the document).
• DateComparator: The DateComparator JXBean provides a way to make a comparison of date values and branch accordingly. A DocumentReadyListener can be set for the conditions where a date, drawn from the incoming XML document, is less than, greater than or equal to a specified control date.
• AbstractJXBean: The AbstractJXBean class defines and implements methods common to all JXBeans in the JXBeans Framework. It is not a requirement for an class to inherit from this class to be a JXBean, however many will want to for the features provided.
• AbstractDocumentSource: The AbstractDocumentSource class provides a convenient superclass for any class that implements the DocumentSource interface. Specifically, this class provides a generic implementation of the DocumentSource interface.
• XbeansAdapter: The XbeansAdapter JXBean provides a bridge to the Xbeans framework. Xbeans from that framework can be integrated into JXBean models by placing them before or after an XbeansAdapter in the model.
| Home | Contact Us | Privacy Policy | Terms of Service |