Ignore:
Timestamp:
2003-08-06T12:02:10+12:00 (21 years ago)
Author:
kjdon
Message:

gadually standardising my Java code. have turned all class variables from like doc_ to this.doc.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/gsdl3/src/java/org/greenstone/gsdl3/service/GS2Construct.java

    r4903 r5098  
    6767   
    6868    // the list of the collections - store between some method calls
    69     private String[] collection_list_ = null;
     69    private String[] collection_list = null;
    7070
    7171    // set of listeners for any construction commands
    72     protected Map listeners_ = null;
     72    protected Map listeners = null;
    7373   
    7474    public GS2Construct() {
    75     listeners_ = Collections.synchronizedMap(new HashMap());
     75    this.listeners = Collections.synchronizedMap(new HashMap());
    7676   
    7777    }
    … …  
    8080    protected Element getServiceDescription(String service, String lang) {
    8181
    82     Element description = doc_.createElement(GSXML.SERVICE_ELEM);
     82    Element description = this.doc.createElement(GSXML.SERVICE_ELEM);
    8383    description.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    8484    description.setAttribute(GSXML.NAME_ATT, service);
    85     description.appendChild(GSXML.createDisplayTextElement(doc_, GSXML.DISPLAY_TEXT_NAME,  getTextString(service+".name", lang)));
    86     description.appendChild(GSXML.createDisplayTextElement(doc_,  GSXML.DISPLAY_TEXT_SUBMIT, getTextString(service+".submit", lang)));
    87 
    88     Element param_list = doc_.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
     85    description.appendChild(GSXML.createDisplayTextElement(this.doc, GSXML.DISPLAY_TEXT_NAME,  getTextString(service+".name", lang)));
     86    description.appendChild(GSXML.createDisplayTextElement(this.doc,  GSXML.DISPLAY_TEXT_SUBMIT, getTextString(service+".submit", lang)));
     87
     88    Element param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
    8989    description.appendChild(param_list);
    9090   
    9191    if (service.equals(NEW_SERVICE)) {
    9292       
    93         Element param = GSXML.createParameterDescription(doc_, NEW_COL_TITLE_PARAM, getTextString("param."+NEW_COL_TITLE_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
    94         param_list.appendChild(param);
    95         param = GSXML.createParameterDescription(doc_, CREATOR_PARAM, getTextString("param."+CREATOR_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
    96         param_list.appendChild(param);
    97         param = GSXML.createParameterDescription(doc_, NEW_COL_ABOUT_PARAM, getTextString("param."+NEW_COL_ABOUT_PARAM, lang), GSXML.PARAM_TYPE_TEXT, null, null, null);
     93        Element param = GSXML.createParameterDescription(this.doc, NEW_COL_TITLE_PARAM, getTextString("param."+NEW_COL_TITLE_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
     94        param_list.appendChild(param);
     95        param = GSXML.createParameterDescription(this.doc, CREATOR_PARAM, getTextString("param."+CREATOR_PARAM, lang), GSXML.PARAM_TYPE_STRING, null, null, null);
     96        param_list.appendChild(param);
     97        param = GSXML.createParameterDescription(this.doc, NEW_COL_ABOUT_PARAM, getTextString("param."+NEW_COL_ABOUT_PARAM, lang), GSXML.PARAM_TYPE_TEXT, null, null, null);
    9898        param_list.appendChild(param);
    9999        String[] types = {BUILDTYPE_MGPP, BUILDTYPE_MG};
    100100        String[] type_texts = {getTextString("param."+BUILDTYPE_PARAM+"."+BUILDTYPE_MGPP, lang), getTextString("param."+BUILDTYPE_PARAM+"."+BUILDTYPE_MG, lang)};
    101101       
    102         param = GSXML.createParameterDescription(doc_, BUILDTYPE_PARAM, getTextString("param."+BUILDTYPE_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, BUILDTYPE_MGPP, types, type_texts);
     102        param = GSXML.createParameterDescription(this.doc, BUILDTYPE_PARAM, getTextString("param."+BUILDTYPE_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, BUILDTYPE_MGPP, types, type_texts);
    103103        param_list.appendChild(param);
    104104        return description;
    … …  
    108108    if (service.equals(ACTIVATE_SERVICE) || service.equals(IMPORT_SERVICE) || service.equals(BUILD_SERVICE) || service.equals(RELOAD_SERVICE) || service.equals(DELETE_SERVICE)) {
    109109       
    110         collection_list_ = getCollectionList();
    111         Element param = GSXML.createParameterDescription(doc_, COL_PARAM, getTextString("param."+COL_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, null, collection_list_, collection_list_);
     110        this.collection_list = getCollectionList();
     111        Element param = GSXML.createParameterDescription(this.doc, COL_PARAM, getTextString("param."+COL_PARAM, lang), GSXML.PARAM_TYPE_ENUM_SINGLE, null, this.collection_list, this.collection_list);
    112112        param_list.appendChild(param);
    113113       
    … …  
    129129    // decode the file name, add it to the import directory
    130130    String name = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
    131     Element response = doc_.createElement(GSXML.RESPONSE_ELEM);
     131    Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
    132132    response.setAttribute(GSXML.FROM_ATT, name);
    133     Element status = doc_.createElement(GSXML.STATUS_ELEM);
     133    Element status = this.doc.createElement(GSXML.STATUS_ELEM);
    134134    response.appendChild(status);
    135135    //String lang = request.getAttribute(GSXML.LANG_ATT);
    136136    //String request_type = request.getAttribute(GSXML.TYPE_ATT);
    137     Text t = doc_.createTextNode("AddDocument: not implemented yet");
     137    Text t = this.doc.createTextNode("AddDocument: not implemented yet");
    138138    status.appendChild(t);
    139139    status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.ERROR));
    … …  
    164164    }
    165165    String id = status.getAttribute(GSXML.STATUS_PROCESS_ID_ATT);
    166     GS2PerlListener listener = (GS2PerlListener)listeners_.get(id);
     166    GS2PerlListener listener = (GS2PerlListener)this.listeners.get(id);
    167167    if (listener==null) {
    168168        System.err.println("somethings gone wrong, couldn't find the listener");
    … …  
    181181   
    182182    // add the rest of the messages to the status node
    183     Text t = doc_.createTextNode("\n"+listener.getUpdate());
     183    Text t = this.doc.createTextNode("\n"+listener.getUpdate());
    184184    status.appendChild(t);
    185185    status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(listener.getStatus()));
    … …  
    188188    }
    189189
    190     t = doc_.createTextNode("\n");
     190    t = this.doc.createTextNode("\n");
    191191    status.appendChild(t);
    192192    // once have got here, we assume
    … …  
    200200    // the response to send back
    201201    String name = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
    202     Element response = doc_.createElement(GSXML.RESPONSE_ELEM);
     202    Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
    203203    response.setAttribute(GSXML.FROM_ATT, name);
    204     Element status = doc_.createElement(GSXML.STATUS_ELEM);
     204    Element status = this.doc.createElement(GSXML.STATUS_ELEM);
    205205    response.appendChild(status);
    206206    Text t = null; // the text node for the error/success message
    … …  
    225225    String coll_name = (String)params.get(COL_PARAM);   
    226226    String[] args={coll_name};
    227     File coll_dir = new File(GSFile.collectionBaseDir(site_home_, coll_name));
     227    File coll_dir = new File(GSFile.collectionBaseDir(this.site_home, coll_name));
    228228    // check that the coll is there in the first place
    229229    if (!coll_dir.exists()) {
    230         t = doc_.createTextNode(getTextString("delete.exists_error", args, lang));
     230        t = this.doc.createTextNode(getTextString("delete.exists_error", args, lang));
    231231        status.appendChild(t);
    232232        status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.ERROR));
    … …  
    236236    // try to delete the directory
    237237    if (!GSFile.deleteFile(coll_dir)) {
    238         t = doc_.createTextNode(getTextString("delete.delete_error", args, lang));
     238        t = this.doc.createTextNode(getTextString("delete.delete_error", args, lang));
    239239        status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.ERROR));
    240240        status.appendChild(t);
    … …  
    249249    // the response to send back
    250250    String name = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
    251     Element response = doc_.createElement(GSXML.RESPONSE_ELEM);
     251    Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
    252252    response.setAttribute(GSXML.FROM_ATT, name);
    253     Element status = doc_.createElement(GSXML.STATUS_ELEM);
     253    Element status = this.doc.createElement(GSXML.STATUS_ELEM);
    254254    response.appendChild(status);
    255255    Text t = null; // the text node for the error/success message
    … …  
    287287   
    288288    // send the request to the MR
    289     Element message = doc_.createElement(GSXML.MESSAGE_ELEM);
    290     Element request = doc_.createElement(GSXML.REQUEST_ELEM);
     289    Element message = this.doc.createElement(GSXML.MESSAGE_ELEM);
     290    Element request = this.doc.createElement(GSXML.REQUEST_ELEM);
    291291    request.setAttribute(GSXML.TYPE_ATT, GSXML.REQUEST_TYPE_CONFIGURE);
    292292    request.setAttribute(GSXML.TO_ATT, "");
    293293    message.appendChild(request);
    294     Element command = doc_.createElement(GSXML.CONFIGURE_ELEM);
     294    Element command = this.doc.createElement(GSXML.CONFIGURE_ELEM);
    295295    command.setAttribute(GSXML.TYPE_ATT, GSXML.COLLECTION_ELEM);
    296296    command.setAttribute(GSXML.NAME_ATT, coll_name);
    … …  
    304304    }
    305305    request.appendChild(command);
    306     Element response = router_.process(message); // at the moment, get no info in response so ignore it
     306    Element response = this.router.process(message); // at the moment, get no info in response so ignore it
    307307    Text t;
    308308    String[] args={coll_name};
    309309       
    310310    if (response == null) {
    311         t = doc_.createTextNode(getTextString(action_name+".configure_error", args , lang));
     311        t = this.doc.createTextNode(getTextString(action_name+".configure_error", args , lang));
    312312        status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.ERROR));
    313313        status.appendChild(t);
    … …  
    316316       
    317317    // if we got here, we have succeeded!
    318     t = doc_.createTextNode(getTextString(action_name+".success", args, lang));
     318    t = this.doc.createTextNode(getTextString(action_name+".success", args, lang));
    319319    status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.SUCCESS));
    320320    status.appendChild(t);
    … …  
    333333    // set up short_service_info_ - for now just has name and type
    334334
    335     e = doc_.createElement(GSXML.SERVICE_ELEM);
     335    e = this.doc.createElement(GSXML.SERVICE_ELEM);
    336336    e.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    337337    e.setAttribute(GSXML.NAME_ATT, NEW_SERVICE);
    338     short_service_info_.appendChild(e);
    339 
    340     e = doc_.createElement(GSXML.SERVICE_ELEM);
     338    this.short_service_info.appendChild(e);
     339
     340    e = this.doc.createElement(GSXML.SERVICE_ELEM);
    341341    e.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    342342    e.setAttribute(GSXML.NAME_ATT, IMPORT_SERVICE);
    343     short_service_info_.appendChild(e);
    344 
    345     e = doc_.createElement(GSXML.SERVICE_ELEM);
     343    this.short_service_info.appendChild(e);
     344
     345    e = this.doc.createElement(GSXML.SERVICE_ELEM);
    346346    e.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    347347    e.setAttribute(GSXML.NAME_ATT, BUILD_SERVICE);
    348     short_service_info_.appendChild(e);
    349 
    350     e = doc_.createElement(GSXML.SERVICE_ELEM);
     348    this.short_service_info.appendChild(e);
     349
     350    e = this.doc.createElement(GSXML.SERVICE_ELEM);
    351351    e.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    352352    e.setAttribute(GSXML.NAME_ATT, ACTIVATE_SERVICE);
    353     short_service_info_.appendChild(e);
    354 
    355     e = doc_.createElement(GSXML.SERVICE_ELEM);
     353    this.short_service_info.appendChild(e);
     354
     355    e = this.doc.createElement(GSXML.SERVICE_ELEM);
    356356    e.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    357357    e.setAttribute(GSXML.NAME_ATT, DELETE_SERVICE);
    358     short_service_info_.appendChild(e);
    359 
    360     e = doc_.createElement(GSXML.SERVICE_ELEM);
     358    this.short_service_info.appendChild(e);
     359
     360    e = this.doc.createElement(GSXML.SERVICE_ELEM);
    361361    e.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    362362    e.setAttribute(GSXML.NAME_ATT, RELOAD_SERVICE);
    363     short_service_info_.appendChild(e);
    364 
    365     //e = doc_.createElement(GSXML.SERVICE_ELEM);
     363    this.short_service_info.appendChild(e);
     364
     365    //e = this.doc.createElement(GSXML.SERVICE_ELEM);
    366366    //e.setAttribute(GSXML.TYPE_ATT, GSXML.SERVICE_TYPE_PROCESS);
    367367    //e.setAttribute(GSXML.NAME_ATT, ADD_DOC_SERVICE);
    368     //short_service_info_.appendChild(e);
     368    //this.short_service_info.appendChild(e);
    369369
    370370
    … …  
    377377    // the response to send back
    378378    String name = GSPath.getFirstLink(request.getAttribute(GSXML.TO_ATT));
    379     Element response = doc_.createElement(GSXML.RESPONSE_ELEM);
     379    Element response = this.doc.createElement(GSXML.RESPONSE_ELEM);
    380380    response.setAttribute(GSXML.FROM_ATT, name);
    381     Element status = doc_.createElement(GSXML.STATUS_ELEM);
     381    Element status = this.doc.createElement(GSXML.STATUS_ELEM);
    382382    response.appendChild(status);
    383383
    … …  
    397397        String id = (String)params.get(PROCESS_ID_PARAM);
    398398        status.setAttribute(GSXML.STATUS_PROCESS_ID_ATT, id);
    399         GS2PerlListener listener = (GS2PerlListener)listeners_.get(id);
     399        GS2PerlListener listener = (GS2PerlListener)this.listeners.get(id);
    400400        if (listener==null) {
    401         Text t = doc_.createTextNode(getTextString("general.process_id_error", lang));
     401        Text t = this.doc.createTextNode(getTextString("general.process_id_error", lang));
    402402        status.appendChild(t);
    403403        status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.ERROR));
    404404        } else {
    405         Text t = doc_.createTextNode(listener.getUpdate());
     405        Text t = this.doc.createTextNode(listener.getUpdate());
    406406        status.appendChild(t);
    407407        status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(listener.getStatus()));
    408408        // check that we actually should be removing the listener here
    409409        if (listener.isFinished()) { // remove this listener - its job is done
    410             listeners_.remove(id); // not working
     410            this.listeners.remove(id); // not working
    411411        }
    412412        }
    … …  
    431431    GS2PerlConstructor constructor = new GS2PerlConstructor("perl_build");
    432432    if (!constructor.configure()) {
    433         Text t = doc_.createTextNode(getTextString("general.configure_constructor_error", lang));
     433        Text t = this.doc.createTextNode(getTextString("general.configure_constructor_error", lang));
    434434        status.appendChild(t);
    435435        status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.ERROR));
    … …  
    437437    }
    438438       
    439     constructor.setSiteHome(site_home_);
     439    constructor.setSiteHome(this.site_home);
    440440    constructor.setCollectionName(coll_name);
    441441    constructor.setActionType(type);
    … …  
    447447
    448448    String id = newID();
    449     listeners_.put(id, listener);
     449    this.listeners.put(id, listener);
    450450
    451451    status.setAttribute(GSXML.STATUS_PROCESS_ID_ATT, id);
    452452    status.setAttribute(GSXML.STATUS_ERROR_CODE_ATT, Integer.toString(GSStatus.ACCEPTED));
    453     Text t = doc_.createTextNode(getTextString("general.process_start", lang));
     453    Text t = this.doc.createTextNode(getTextString("general.process_start", lang));
    454454    status.appendChild(t);
    455455    return response;
    … …  
    465465    protected String[] getCollectionList() {
    466466   
    467     File collectDir = new File(GSFile.collectDir(site_home_));
     467    File collectDir = new File(GSFile.collectDir(this.site_home));
    468468    if (!collectDir.exists()) {
    469469        System.err.println("couldn't find collect dir: "+collectDir.toString());
    … …  
    513513        base_name = coll_title.substring(0,6);
    514514    }
    515     File coll_dir = new File(GSFile.collectionBaseDir(site_home_, base_name));
     515    File coll_dir = new File(GSFile.collectionBaseDir(this.site_home, base_name));
    516516    if (!coll_dir.exists()) { // this name is ok - not used yet
    517517        return base_name;
    … …  
    523523    while(coll_dir.exists()) {
    524524        i++;
    525         coll_dir = new File(GSFile.collectionBaseDir(site_home_, base_name+Integer.toString(i)));
     525        coll_dir = new File(GSFile.collectionBaseDir(this.site_home, base_name+Integer.toString(i)));
    526526    }
    527527    return base_name+Integer.toString(i);
    … …  
    534534    protected Element extractOtherParams(HashMap params, int type) {
    535535
    536     Element param_list = doc_.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
     536    Element param_list = this.doc.createElement(GSXML.PARAM_ELEM+GSXML.LIST_MODIFIER);
    537537    if (type == GS2PerlConstructor.NEW) {
    538         Element param = doc_.createElement(GSXML.PARAM_ELEM);
     538        Element param = this.doc.createElement(GSXML.PARAM_ELEM);
    539539        param.setAttribute(GSXML.NAME_ATT, "creator");
    540540        param.setAttribute(GSXML.VALUE_ATT, (String)params.get(CREATOR_PARAM));
    541541       
    542542        param_list.appendChild(param);
    543         param = doc_.createElement(GSXML.PARAM_ELEM);
     543        param = this.doc.createElement(GSXML.PARAM_ELEM);
    544544        param.setAttribute(GSXML.NAME_ATT, "about");
    545545        param.setAttribute(GSXML.VALUE_ATT, (String)params.get(NEW_COL_ABOUT_PARAM));
    546546        param_list.appendChild(param);
    547         param = doc_.createElement(GSXML.PARAM_ELEM);
     547        param = this.doc.createElement(GSXML.PARAM_ELEM);
    548548        param.setAttribute(GSXML.NAME_ATT, "title");
    549549        param.setAttribute(GSXML.VALUE_ATT, (String)params.get(NEW_COL_TITLE_PARAM));
    550550        param_list.appendChild(param);
    551         param = doc_.createElement(GSXML.PARAM_ELEM);
     551        param = this.doc.createElement(GSXML.PARAM_ELEM);
    552552        param.setAttribute(GSXML.NAME_ATT, "buildtype");
    553553        param.setAttribute(GSXML.VALUE_ATT, (String)params.get(BUILDTYPE_PARAM));
Note: See TracChangeset for help on using the changeset viewer.