Changeset 2825


Ignore:
Timestamp:
04/22/13 13:18:09 (11 years ago)
Author:
keeloo
Message:

Repaired the documentation in VloWebApplication? reffering to the VLO
configuration.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • vlo/trunk/vlo_web_app/src/main/java/eu/clarin/cmdi/vlo/VloWebApplication.java

    r2768 r2825  
    99
    1010/**
    11  * {@literal VLO} web application.<br><br>
     11 * {@literal VLO} web application.
    1212 *
     13 * The web application class defines an object representing the VLO web
     14 * application.
     15 *
    1316 * Because the VloWebApplication class extends WebApplication, a class instance
    14  * will normally reside inside a web server container. By running the Start
    15  * class however, an instance of the application will reside outside a server
     17 * will reside inside a web server container. By running the Start class
     18 * however, an instance of the application will reside outside a server
    1619 * container.
    17  *
    1820 */
    1921public class VloWebApplication extends WebApplication {
    … …  
    2123    private SearchResultsDao searchResults;
    2224   
    23     // flag indicating whether or not the application object lives in a context
     25    /**
     26     * Flag indicating whether or not the application object lives in a web
     27     * server context.
     28     */
    2429    boolean inContext;
    2530
    2631    /**
    27      * Method that will be invoked when the application starts<br><br>
    28      *
     32     * Method that will be invoked when the application starts.
    2933     */
    3034    @Override
    … …  
    3842            servletContext = this.getServletContext();
    3943           
    40             /**
     44            /*
    4145             * Send the application context to the configuration object to
    4246             * enable it to read an external {@literal VloConfig.xml}
    … …  
    5357
    5458    /**
    55      * Web application constructor<br><br>
     59     * Web application constructor.
    5660     *
    5761     * Create an application instance configured to be living inside a web
    … …  
    6064    public VloWebApplication() {
    6165
    62         /**
     66        /*
    6367         * Read the application's packaged configuration.
    6468         *
    … …  
    7781
    7882    /**
    79      * Web application constructor<br><br>
     83     * Web application constructor.
    8084     *
    81      * Create an application instance configured to be living without a web
    82      * server container context.<br><br>
    83      *
    84      * @param testConfig a configuration that could be different from the
    85      * packaged parameters
    86      *
    87      * An instance like this can for example be used for testing purposes. In
    88      * the case of testing, the constructor is invoked from a class in a test
    89      * package. Within such a class a configuration object can be manipulated
    90      * according to specific needs. <br><br>
    91      *
    92      * Please note that in the case of a test configuration, while the
    93      * application object could reside inside a web server container, the
    94      * context associated with this container will be ignored.
     85     * Allows for the creation of an application instance that does not rely on
     86     * a web server context. When send the message 'false', this constructor
     87     * will create an object that will not look for an external configuration
     88     * file; it will exclusively rely on the packaged configuration. Typically,
     89     * the application's tests will send false to the application constructor.
     90     *
     91     * @param inContext If and only if this parameter equals true. later on, the
     92     * {@literal init} method will try to determine the web server's container
     93     * context so that, if it is defined in it, an external configuration can be
     94     * switched to.
    9595     */
    96     public VloWebApplication(Boolean param) {
     96    public VloWebApplication(Boolean inContext) {
    9797
    9898        // remember that the application does not live in a web server context
    9999       
    100         inContext = param;
     100        this.inContext = inContext;
    101101
    102102        searchResults = new SearchResultsDao();
Note: See TracChangeset for help on using the changeset viewer.