Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

Page 1   2   3  
org.apache.cocoon.acting.* (49)org.apache.cocoon.caching.* (14)org.apache.cocoon.callback.* (5)
org.apache.cocoon.components.* (402)org.apache.cocoon.environment.* (31)org.apache.cocoon.generation.* (25)
org.apache.cocoon.i18n.* (3)org.apache.cocoon.matching.* (38)org.apache.cocoon.poi.* (186)
org.apache.cocoon.precept.* (33)

org.apache.cocoon: Javadoc index of package org.apache.cocoon.


Package Samples:

org.apache.cocoon.components.treeprocessor.sitemap: Evaluation tree based implementation of the Processor interface  
org.apache.cocoon.poi.hssf.dev
org.apache.cocoon.poi.hssf
org.apache.cocoon.poi.hssf.model
org.apache.cocoon.poi.hssf.record.formula
org.apache.cocoon.poi.hssf.record
org.apache.cocoon.poi.hssf.usermodel
org.apache.cocoon.poi.poifs.common
org.apache.cocoon.poi.poifs.filesystem
org.apache.cocoon.poi.poifs.property
org.apache.cocoon.poi.poifs.storage
org.apache.cocoon.poi.util
org.apache.cocoon.components.source
org.apache.cocoon.components.notification
org.apache.cocoon.components.language.markup.xsp
org.apache.cocoon.components.language.markup.sitemap
org.apache.cocoon.components.language.markup
org.apache.cocoon.components.language.generator
org.apache.cocoon.components.language.programming.java
org.apache.cocoon.components.language.programming.javascript

Classes:

I18nTransformer: Internationalization transformer is used to transform i18n markup into text based on a particular locale. i18n transformer The i18n transformer works by obtaining the users locale based on request, session attributes or a cookie data. See LocaleAction.getLocaleAttribute(Map) > LocaleAction.getLocaleAttribute(Map) 55 for details. It then attempts to find a message catalogue that satisifies the particular locale, and use it for for text replacement within i18n markup. Catalogues are maintained in separate files, with a naming convention similar to that of ResourceBundle (See java.util.ResourceBundle). ...
AbstractValidatorAction: Abstract implementation of action that needs to perform validation of parameters (from session, from request, etc.). All `validator' actions share the same description xml file. In such file every parameter is described via its name, type and its constraints. One large description file can be used among all validator actions, because each action should explicitely specify which parameters to validate - through a sitemap parameter. <root> <parameter name="username" type="string" nullable="no"/> <parameter name="role" type="string" nullable="no"/> <parameter name="oldpassword" ...
TraxTransformer: This Transformer is used to transform this incomming SAX stream using a XSLT stylesheet. Use the following sitemap declarations to define, configure and parameterize it: In the map:sitemap/map:components/map:transformers: <map:transformer name="xslt" src="org.apache.cocoon.transformation.TraxTransformer"> <use-request-parameters>false</use-request-parameters> <use-browser-capabilities-db>false</use-browser-capabilities-db> <use-session-info>false</use-session-info> <xslt-processor-role>org.apache.cocoon.components.xslt.XSLTProcessor</xslt-processor-role> ...
VelocityGenerator: Cocoon Generator that produces dynamic XML SAX events from a Velocity template file. Sitemap Configuration Attributes: usecache (optional; default: 'false') set to 'true' to enable template caching on the 'cocoon' resource loader checkInterval (optional; default: '0') This is the number of seconds between modification checks when caching is turned on. When this is an integer > 0, this represents the number of seconds between checks to see if the template was modified. If the template has been modified since last check, then it is reloaded and reparsed. Otherwise nothing is done. When <= 0, ...
AbstractDatabaseAction: Set up environment for configurable form handling data. It is important to note that all DatabaseActions use a common configuration format. This group of actions are unique in that they employ a terciary mapping. There is the Form parameter, the database column, and the type. Each configuration file must use the same format in order to be effective. The name of the root configuration element is irrelevant. <root> <connection>personnel<connection> <table> <keys> <key param="id" dbcol="id" type="int"/> </keys> <values> <value param="name" dbcol="name" ...
InsertTransformer: This implementation allows the inserting of an xml fragment into a resource which is configured in sunConfig. XPath denoting the position to insert the xml fragment By default, the fragment is always inserted (added). It is possible to specify a node (by an XPath) which will be replaced if it exists. XPath denoting the position to insert the xml fragment XPath denoting a criteria for which node will be replaced The information for replace has to be relative to path, but can specify a subnode of the node the be replaced. The XPath specification is very complicated. So here is an example for the ...
CocoonTargetFactory: CocoonTargetFactory class. This factory is able to create different LogTargets specific to Cocoon according to the following configuration syntax: <file id="foo"> <filename>${context-key}/real-name/...</filename> <format type="raw|pattern|extended|xml|cocoon">pattern to be used if needed</format> <append>true|false</append> <rotation type="revolving|unique" init="5" max="10"> <or> <size>10000000</size> <time>24:00:00</time> <time>12:00:00</time> </or> </rotate> </file> Some explanations about ...
RequestSessionContext: A SessionContext which encapsulates the current Request object. It is not allowed to change this context. The following paths are valid: /parameter - lists all parameters, parameter names build the elements with the values as text node childs /parameter/ - one text node containing the value /querystring - the querystring with a leading '?' or null (the querystring is only for GET) /parametervalues - same as /parameter but values are listed as described below parameter name parameter value ... parameter name parameter value If a parameter has more than one value for each value a block is generated. ...
LDAPTransformer: The LDAPTransformer is a class that can be plugged into a pipeline to transform the SAX events which passes thru this transformer into queries an responses to/from a ldap interface. The file will be specified in a parameter tag in the sitemap pipeline to the transformer as follows: <map:transform type="ldap"/> The following DTD is valid: <!ELEMENT execute-query (attribute+ | show-attribute? | scope? | initializer? | authentication? | error-element? | sax-error? doc-element? | row-element? | version? | serverurl? | rootdn? | password? | deref-link? | count-limit? | searchbase, filter)> ...
JDBCTypeConversions: Provide some utility methods to read from JDBC result sets or store them to JDBC statements. Largely copied from org.apache.cocoon.acting.AbstractDatabaseAction. The following table lists all available column type names together with the JDBC methods used to get or set a column with that type. In some cases the returned type differs from the type returned by the getXXX method. To set a column, a number of conversions are automatically used. For details, please see the actual code. type getXXX returns setXXX clob Clob String Clob ascii Clob String asciStream big-decimal BigDecimal BigDecimal binary ...
FormValidatorAction: This is the action used to validate Request parameters. The parameters are described via the external xml file (its format is defined in AbstractValidatorAction). Variant 1 <map:act type="form-validator"> <parameter name="descriptor" value="context://descriptor.xml"> <parameter name="validate" value="username,password"> </map:act> The list of parameters to be validated is specified as a comma separated list of their names. descriptor.xml can therefore be used among many various actions. If the list contains only of * , all parameters in the file will be validated. Variant ...
LocaleAction: LocaleAction is a class which obtains the request's locale information (language, country, variant) and makes it available to the sitemap/pipeline. Definition in sitemap: <map:actions> <map:action name="locale" src="org.apache.cocoon.acting.LocaleAction"/> </map:actions> Examples: <map:match pattern="file"> <map:act type="locale"> <map:generate src="file_{lang}{country}{variant}.xml"/> </map:act> </map:match> or <map:match pattern="file"> <map:act type="locale"> <map:generate src="file.xml?locale={locale}"/> </map:act> </map:match> ...
Interpreter: The interface to the flow scripting languages. This interface is for a component, which implements the appropriate language to be used for describing the flow. A system could have multiple components that implement this interface, each of them for a different scripting language. A flow script defines what is the page flow in an interactive Web application. Usually the flow is defined in a high level programming language which provides the notion of continuations, which allows for the flow of the application to be described as a simple procedural program, without having to think about the application ...
SimpleFormTransformer: Eliminates the need for XSP to use FormValidatorAction. Caveat: Select options need a value attribute to work correctly. This transformer fills all HTML 4 form elements with values from an InputModule, e.g. request, with the same name. It handles select boxes, textareas, checkboxes, radio buttons, password and text fields, and buttons. In addition, it handles FormValidatorAction results by selectively omitting <error/> elements. These elements need a "name" attribute corresponding to the name of the form element, and either a "when" or a "when-ge" attribute. An error element is send down ...
DatabaseCookieAuthenticatorAction: This action is used to authenticate user by comparing several cookie values (username, password) with the values in database. The description of the process is given via external xml description file simiar to the one used for all actions derived from AbstractDatabaseAction. <root> <connection>personnel</connection> <table name="users_table> <select dbcol="username" cookie-name="username" to-session="username"/> <select dbcol="password" cookie-name="password" nullable="yes"/> <select dbcol="role" to-session="role" type="string"/> <select dbcol="skin" ...
XMLDBTransformer: This transformer allows to perform resource creation, deletion, and XUpdate command execution in XML:DB. Definition: <map:transformer name="xmldb" src="www.XMLDBTransformer"> <driver>org.apache.xindice.client.xmldb.DatabaseImpl</driver> <base>xmldb:xindice:///db/collection</base> </map:transformer> Invokation: <map:transform type="xmldb"> <map:parameter name="base" value="xmldb:xindice:///db/collection"/> </map:transform> Input XML document example: <page xmlns:xindice="http://apache.org/cocoon/xmldb/1.0"> ... <xindice:query type="create" ...
HttpCookie: Creates a cookie, a small amount of information sent by a servlet to a Web browser, saved by the browser, and later sent back to the server. A cookie's value can uniquely identify a client, so cookies are commonly used for session management. A cookie has a name, a single value, and optional attributes such as a comment, path and domain qualifiers, a maximum age, and a version number. Some Web browsers have bugs in how they handle the optional attributes, so use them sparingly to improve the interoperability of your servlets. The servlet sends cookies to the browser by using the HttpResponse.addCookie(org.apache.cocoon.environment.Cookie) ...
DatabaseAuthenticatorAction: This action is used to authenticate user by comparing several request fields (username, password) with the values in database. The description of the process is given via external xml description file simiar to the one used for all actions derived from AbstractDatabaseAction. <root> <connection>personnel</connection> <table name="users_table> <select dbcol="username" request-param="username" to-session="username"/> <select dbcol="password" request-param="password" nullable="yes"/> <select dbcol="role" to-session="role" type="string"/> <select dbcol="skin" ...
Cookie: Creates a cookie, a small amount of information sent by a servlet to a Web browser, saved by the browser, and later sent back to the server. A cookie's value can uniquely identify a client, so cookies are commonly used for session management. A cookie has a name, a single value, and optional attributes such as a comment, path and domain qualifiers, a maximum age, and a version number. Some Web browsers have bugs in how they handle the optional attributes, so use them sparingly to improve the interoperability of your servlets. The servlet sends cookies to the browser by using the Response.addCookie(org.apache.cocoon.environment.Cookie) ...
DbXMLAuthenticatorAction: This action is used to authenticate user by comparing several request fields (username, password) with the values in a DBXML compliant database. The description of the process is given via external xml description file simiar to the one used for all actions derived from AbstractDatabaseAction. org.apache.xindice.client.xmldb.DatabaseImpl xmldb:xindice:///db/beta The values specified via "request-param" describe the name of HTTP request parameter, "element" indicates matching document node, "nullable" means that request-param which is null or empty will not be included in the WHERE clause. This ...
SessionStateAction: Store the session's current state in a session attribute. To keep track of the state of a user's session, a string is stored in a session attribute in order to allow to chose between different pipelines in the sitemap accordingly. For added flexibility it is possible to use sub states as well. For this declare your own name for the session state attribute and give the number of sublevels plus the level to modify. (This is one based!) Sub states below the current one are removed from the session so that the default sub state will be reentered when the user returns. If you don't like this behaviour ...
DatabaseAction: Abstract action for common function needed by database actions. The difference to the other Database*Actions is, that the actions in this package use additional components ("modules") for reading and writing parameters. In addition the descriptor format has changed to accomodate the new features. This action is heavily based upon the original DatabaseAddActions. Modes have to be configured in cocoon.xconf. Mode names from descriptor.xml file are looked up in the component service. Default mode names can only be set during action setup. The number of affected rows is returned to the sitemap with ...
AbstractSAXTransformer: This class is the basis for all transformers. It provides various useful methods and hooks for implementing own custom transformers. The basic behaviour of each transformer consists of the following four parts: Listen for specific events with a given namespace Collect information via these events Process the information Create new events from the processed information For all these four purposes the AbstractSunshineTransformer offers some powerful methods and hooks: Namespace handling By setting the instance variable namespaceURI to the namespace the events are filtered and only events with this ...
RequestParamAction: This action makes some request details available to the sitemap via parameter substitution. {context} - is the context path of the servlet (usually "/cocoon") {requestURI} - is the requested URI without parameters {requestQuery} - is the query string like "?param1=test" if there is one Additionlly all request parameters can be made available for use in the sitemap. if the parameter "parameters" is set to true. (A variable is created for each request parameter (only if it doesn't exist) with the same name as the parameter itself) Default values can be set for request parameters, by including sitemap ...
SearchGenerator: Generates an XML representation of a search result. This generator generates xml content representening an XML search. The generated xml content contains the search result, the search query information, and navigation information about the search results. Search xml sample generated by this generator: <?xml version="1.0" encoding="UTF-8"?> <search:results date="1008437081064" query-string="cocoon" start-index="0" page-length="10" xmlns:search="http://apache.org/cocoon/search/1.0" xmlns:xlink="http://www.w3.org/1999/xlink"> ...

Home | Contact Us | Privacy Policy | Terms of Service