com.rapid.actions.Navigate.java Source code

Introduction

Here is the source code for com.rapid.actions.Navigate.java

Source

/*
    
Copyright (C) 2015 - Gareth Edwards / Rapid Information Systems
    
gareth.edwards@rapid-is.co.uk
    
    
This file is part of the Rapid Application Platform
    
RapidSOA is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as 
published by the Free Software Foundation, either version 3 of the 
License, or (at your option) any later version. The terms require you 
to include the original copyright, and the license notice in all redistributions.
    
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.
    
You should have received a copy of the GNU Affero General Public License
in a file named "COPYING".  If not, see <http://www.gnu.org/licenses/>.
    
*/

package com.rapid.actions;

import java.util.ArrayList;

import com.rapid.core.Action;
import com.rapid.core.Application;
import com.rapid.core.Control;
import com.rapid.core.Page;
import com.rapid.server.RapidHttpServlet;
import com.rapid.server.RapidRequest;

import org.json.JSONArray;
import org.json.JSONObject;

public class Navigate extends Action {

    // details of the inputs
    public static class SessionVariable {

        private String _name, _itemId, _field;

        public String getName() {
            return _name;
        }

        public void setName(String name) {
            _name = name;
        }

        public String getItemId() {
            return _itemId;
        }

        public void setItemId(String itemId) {
            _itemId = itemId;
        }

        public String getField() {
            return _field;
        }

        public void setField(String field) {
            _field = field;
        }

        public SessionVariable() {
        };

        public SessionVariable(String name, String itemId, String field) {
            _name = name;
            _itemId = itemId;
            _field = field;
        }

    }

    // instance variables

    private ArrayList<SessionVariable> _sessionVariables;

    // properties

    public ArrayList<SessionVariable> getSessionVariables() {
        return _sessionVariables;
    }

    public void setSessionVariables(ArrayList<SessionVariable> sessionVariables) {
        _sessionVariables = sessionVariables;
    }

    // parameterless constructor for jaxb
    public Navigate() {
        super();
    }

    // json constructor for designer
    public Navigate(RapidHttpServlet rapidServlet, JSONObject jsonAction) throws Exception {
        // call super constructor to set xml version
        super();
        // save all key/values from the json into the properties 
        for (String key : JSONObject.getNames(jsonAction)) {
            // add all json properties to our properties (except for sessionVariables)
            if (!"sessionVariables".equals(key))
                addProperty(key, jsonAction.get(key).toString());
        }
        // get the inputs collections
        JSONArray jsonInputs = jsonAction.optJSONArray("sessionVariables");
        // check it
        if (jsonInputs == null) {
            // empty down the collection
            _sessionVariables = null;
        } else {
            // initialise the collection
            _sessionVariables = new ArrayList<SessionVariable>();
            // loop it
            for (int i = 0; i < jsonInputs.length(); i++) {
                // get this input
                JSONObject jsonInput = jsonInputs.getJSONObject(i);
                // add it to the collection
                _sessionVariables.add(new SessionVariable(jsonInput.getString("name"),
                        jsonInput.getString("itemId"), jsonInput.optString("field")));
            }
        }
    }

    @Override
    public String getJavaScript(RapidRequest rapidRequest, Application application, Page page, Control control,
            JSONObject jsonDetails) {
        String pageId = getProperty("page");
        if (pageId == null) {
            return "";
        } else {
            // string into which we're about to build the session variables
            String sessionVariables = "";
            // check we have some
            if (_sessionVariables != null) {
                // loop
                for (SessionVariable sessionVariable : _sessionVariables) {
                    // get the data getter command
                    String getter = Control.getDataJavaScript(rapidRequest.getRapidServlet().getServletContext(),
                            application, page, sessionVariable.getItemId(), sessionVariable.getField());
                    // if we didn't get anything update to empty string
                    if (getter == null)
                        getter = "''";
                    if (getter.length() == 0)
                        getter = "''";
                    // build the concatinating string
                    sessionVariables += "&" + sessionVariable.getName() + "=' + " + getter + " + '";
                }
            }
            // build the action string (also used in mobile action for online check type)
            String action = "Action_navigate('~?a=" + application.getId() + "&v=" + application.getVersion() + "&p="
                    + pageId;
            // check if this is a dialogue 
            if (Boolean.parseBoolean(getProperty("dialogue"))) {
                action += "&action=dialogue" + sessionVariables + "',true,'" + pageId + "');";
                // return false if we're stopping further actions
                if (Boolean.parseBoolean(getProperty("stopActions")))
                    action += "return false;\n";
            } else {
                action += sessionVariables + "');\n";
            }
            // replace any unnecessary characters
            action = action.replace(" + ''", "");
            // stop event bubbling (both navigation types need this)
            action += "ev.stopPropagation();\n";
            // stop the form being submitted
            action += "ev.preventDefault();\n";
            // return it into the page!
            return action;
        }

    }

}