26006 - How to Create a Simple JSP OLAPTableView

Sample 26006: How to Create a Simple JSP OLAPTableView

Overview

The OLAPTableView is a TableView that enables OLAP (Online Analytical Processing) data to be viewed and manipulated in tabular form. The sample creates an OLAPTableViewComposite, which is a TransformationBean^TM that is composed of other TransformationBeans that include the following subcomponents: MenuBar, NavigationBar, OLAPTableView, OLAPDrillState, AppliedFilters, Title, and Footer.

Here are the steps for creating a simple OLAPTableView:

Create an OLAPDataSet.
Create an OLAPTableView with the OLAPDataSet model.
Render the OLAPTableView.

The code shown on the Full Code tab will create an OLAPDataSet and display a default OLAPTableViewComposite with that model.

The sample is based on the Model 2 Servlet template that is available in SAS^® AppDev Studio. For simplicity, this sample uses its own static data model for the OLAPTableView, which means that it does not enable the actions that are available with live data such as sorting, expanding, and totals. In most real-world use cases, users will connect to live data and not create their own data model. For more information about how to connect the OLAPTableView, see Sample 26014.

Customizations

This sample contains the following customizations:

Adding navigation bars
Changing background colors

Adding navigation bars

Set the columnPageSize and rowPageSize properties on the OLAPTableView tag:

<sas:OLAPTableViewComposite id="OLAPTableView1" model="model" scope="session" actionProvider="actionProvider">
   <sas:OLAPTableView columnPageSize="4" rowPageSize="4"/>
</sas:OLAPTableViewComposite>

Changing background colors

Change the sas:OLAPTableView tag to have a separate end tag, and insert the following sas:StyleMapKey tags in the body of the sas:OLAPTableView tag:

<sas:OLAPTableViewComposite id="OLAPTableView1" model="model" scope="session" actionProvider="actionProvider">
   <sas:OLAPTableView columnPageSize="4" rowPageSize="4">
      <sas:StyleMapKey key="OLAPTABLEVIEW_ROW_HEADER_STYLE"
         classid="OLAPTableRowHeader" style="background-color: lightgreen;"/>
      <sas:StyleMapKey key="OLAPTABLEVIEW_COLUMN_HEADER_STYLE"
         classid="OLAPTableColumnHeader" style="background-color: lightblue;"/>
      <sas:StyleMapKey key="OLAPTABLEVIEW_COLUMN_MEASURE_HEADER_STYLE"
         classid="OLAPTableColumnMeasureHeader" style="background-color: aqua;"/>
      <sas:StyleMapKey key="OLAPTABLEVIEW_ROW_MEASURE_HEADER_STYLE"
         classid="OLAPTableRowMeasureHeader" style="background-color: yellow;"/>
      <sas:StyleMapKey key="OLAPTABLEVIEW_ROW_TITLE_HEADER_STYLE"
         classid="OLAPTableRowTitleHeader" style="background-color: lime;"/>
      <sas:StyleMapKey key="OLAPTABLEVIEW_EMPTY_ROW_TITLE_HEADER_STYLE"
         classid="OLAPTableEmptyRowTitleHeader" style="background-color: lime;"/>
      <sas:StyleMapKey key="OLAPTABLEVIEW_COLUMN_TITLE_HEADER_STYLE"
         classid="OLAPTableColumnTitleHeader" style="background-color: lightskyblue;"/>
      <sas:StyleMapKey key="OLAPTABLEVIEW_DATA_STYLE"
         classid="OLAPTableData" style="background-color: orange;"/>
   </sas:OLAPTableView>
</sas:OLAPTableViewComposite>

Additional Documentation

For a list of samples for common tasks, see SAS Note 32218.
The SAS AppDev Studio Developer's Site contains detailed information that will assist you when developing Web applications with SAS AppDev Studio, including an API reference and the custom tag reference for the sas tagset.

These sample files and code examples are provided by SAS Institute Inc. "as is" without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. Recipients acknowledge and agree that SAS Institute shall not be liable for any damages whatsoever arising out of their use of this material. In addition, SAS Institute will provide no support for the materials contained herein.

Instructions

Build a new Web application project in SAS AppDev Studio by using the Model 2 Servlet template.
The template will generate a servlet and a JSP file, which, by default, are named Model2ExampleControllerServlet.java and Model2ExampleViewer.jsp. Replace the contents of these files with the code below.
There are three versions of Model2ExampleViewer.jsp below. The first is the default view, and the other two contain the customizations discussed on the Details page. Choose the code for the JSP page based on the customization you want to use.
Execute the servlet on the test Tomcat server.

Tip: For help with building a Web application project and testing a Web application, see SAS Note 32218.

Code for Model2ExampleViewer.jsp. This code contains the default view


<%@ taglib uri="http://www.sas.com/taglib/sas" prefix="sas" %>
<%@ page pageEncoding="UTF-8"%>
<html>
<head>
	<link href="styles/sasComponents.css" rel="STYLESHEET" type="text/css">
</head>
<body>
	
	<sas:OLAPTableViewComposite id="olapTableView" 
		model="olapModel" 
		actionProvider="actionProvider"
		scope="session"/>
	
</body>
</html>

Code for Model2ExampleViewer.jsp - Customization: Adding Navigation Bars


<%@ taglib uri="http://www.sas.com/taglib/sas" prefix="sas" %>
<%@ page pageEncoding="UTF-8"%>
<html>
<head>
	<link href="styles/sasComponents.css" rel="STYLESHEET" type="text/css">
</head>
<body>
	
	<sas:OLAPTableViewComposite id="olapTableView" 
		model="olapModel" 
		actionProvider="actionProvider"
		scope="session">
		<sas:OLAPTableView columnPageSize="4" rowPageSize="4"/>
	</sas:OLAPTableViewComposite>	
	
</body>
</html>

Code for Model2ExampleViewer.jsp - Customization: Changing Background Colors


<%@ taglib uri="http://www.sas.com/taglib/sas" prefix="sas" %>
<%@ page pageEncoding="UTF-8"%>
<html>
<head>
	<link href="styles/sasComponents.css" rel="STYLESHEET" type="text/css">
</head>
<body>
	
	<sas:OLAPTableViewComposite id="olapTableView" 
		model="olapModel" 
		actionProvider="actionProvider"
		scope="session">
		<sas:OLAPTableView columnPageSize="4" rowPageSize="4">
			<sas:StyleMapKey key="OLAPTABLEVIEW_ROW_HEADER_STYLE"
			   classid="OLAPTableRowHeader" style="background-color: lightgreen;"/>
			<sas:StyleMapKey key="OLAPTABLEVIEW_COLUMN_HEADER_STYLE"
			   classid="OLAPTableColumnHeader" style="background-color: lightblue;"/>
			<sas:StyleMapKey key="OLAPTABLEVIEW_COLUMN_MEASURE_HEADER_STYLE"
			   classid="OLAPTableColumnMeasureHeader" style="background-color: aqua;"/>
			<sas:StyleMapKey key="OLAPTABLEVIEW_ROW_MEASURE_HEADER_STYLE"
			   classid="OLAPTableRowMeasureHeader" style="background-color: yellow;"/>
			<sas:StyleMapKey key="OLAPTABLEVIEW_ROW_TITLE_HEADER_STYLE"
			   classid="OLAPTableRowTitleHeader" style="background-color: lime;"/>
			<sas:StyleMapKey key="OLAPTABLEVIEW_EMPTY_ROW_TITLE_HEADER_STYLE"
			   classid="OLAPTableEmptyRowTitleHeader" style="background-color: lime;"/>
			<sas:StyleMapKey key="OLAPTABLEVIEW_COLUMN_TITLE_HEADER_STYLE"
			   classid="OLAPTableColumnTitleHeader" style="background-color: lightskyblue;"/>
			<sas:StyleMapKey key="OLAPTABLEVIEW_DATA_STYLE"
			   classid="OLAPTableData" style="background-color: orange;"/>
   		</sas:OLAPTableView>
	</sas:OLAPTableViewComposite>	
	
</body>
</html>

Code for Model2ExampleControllerServlet.java

Required changes

If you did not use the default values during the generation of the project, you may need to update the following values.

The package for the servlet.
package servlets;
The servlet name.
public class Model2ExampleControllerServlet.java ...
The URLmapping for the action provider, which must match the servlet mapping for the servlet.
sas_actionProvider.setControllerURL(request.getContextPath()+ "/Model2Example");
The JSP page that the servlet forwards to.
RequestDispatcher rd = getServletContext().getRequestDispatcher("/Model2ExampleViewer.jsp");


package servlets;

import java.io.IOException;

import javax.servlet.RequestDispatcher;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import com.sas.actionprovider.HttpActionProvider;
import com.sas.storage.olap.AxisInterface;
import com.sas.storage.olap.OLAPException;
import com.sas.storage.olap.TupleElementInterface;
import com.sas.storage.olap.TupleInterface;
import com.sas.storage.olap.embedded.Axis;
import com.sas.storage.olap.embedded.OLAPDataSet;
import com.sas.storage.olap.embedded.ResultSet;
import com.sas.storage.olap.embedded.ResultSetMetadata;
import com.sas.storage.olap.embedded.Tuple;
import com.sas.storage.olap.embedded.TupleElement;

public class Model2ExampleControllerServlet extends
		javax.servlet.http.HttpServlet {
	private static final String ACTION_PROVIDER = "actionProvider";
	private static final String SAS_MODEL = "olapModel";
	// Declare a default version ID since parent class implements
	// java.io.Serializable
	private static final long serialVersionUID = 1L;

	/*
	 * doPost() Respond to the Post message.
	 */
	public void doPost(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		// Note: Calling doGet to provide same behavior to POST and GET HTTP
		// methods.
		doGet(request, response);
	}

	/*
	 * doGet() Respond to the Get message.
	 */
	public void doGet(HttpServletRequest request, HttpServletResponse response)
			throws ServletException, IOException {
		// Note: Add User DO_GET code here
		HttpSession session = request.getSession();

		// Setup the ActionProvider
		HttpActionProvider actionProvider = null;
		synchronized (session) {
			if (session != null) {
				actionProvider = (HttpActionProvider) session
						.getAttribute(ACTION_PROVIDER);
			}
			// if ActionProvider is null, create one and put it on the session
			if (actionProvider == null) {
				actionProvider = new HttpActionProvider();
				actionProvider.setLocale(request.getLocale());
				actionProvider.setControllerURL(request.getContextPath()
						+ "/Model2Example");
				actionProvider.setName(ACTION_PROVIDER);
				// store object in its scope
				if (session != null)
					session.setAttribute(ACTION_PROVIDER, actionProvider);
			}
			// else execute the ActionProvider command
			else {
				actionProvider.executeCommand(request, response, response
						.getWriter());
			}
		}

		OLAPDataSet defaultOLAPTableModel = null;
		synchronized (session) {
			if (session != null) {
				defaultOLAPTableModel = (OLAPDataSet) session
						.getAttribute(SAS_MODEL);
			}
			if (null == defaultOLAPTableModel) {
				defaultOLAPTableModel = createStaticData();
				session.setAttribute(SAS_MODEL, defaultOLAPTableModel);
			}
		}

		RequestDispatcher rd = getServletContext().getRequestDispatcher(
				"/Model2ExampleViewer.jsp");
		rd.forward(request, response);

	}

	private OLAPDataSet createStaticData() {
		OLAPDataSet defaultOLAPTableModel = null;
		try {
			TupleInterface tuple1 = new Tuple(new TupleElementInterface[] {
					new TupleElement("Candy"), new TupleElement("Sales") });
			TupleInterface tuple2 = new Tuple(new TupleElementInterface[] {
					new TupleElement("Candy"), new TupleElement("Profits") });
			TupleInterface tuple3 = new Tuple(new TupleElementInterface[] {
					new TupleElement("Magazines"), new TupleElement("Sales") });
			TupleInterface tuple4 = new Tuple(
					new TupleElementInterface[] {
							new TupleElement("Magazines"),
							new TupleElement("Profits") });

			TupleInterface tuple5 = new Tuple(
					new TupleElementInterface[] {
							new TupleElement("North Carolina"),
							new TupleElement("Bob") });
			TupleInterface tuple6 = new Tuple(new TupleElementInterface[] {
					new TupleElement("North Carolina"),
					new TupleElement("Mary") });
			TupleInterface tuple7 = new Tuple(new TupleElementInterface[] {
					new TupleElement("Virginia"), new TupleElement("Jean") });
			TupleInterface tuple8 = new Tuple(new TupleElementInterface[] {
					new TupleElement("Virginia"), new TupleElement("Joe") });
			TupleInterface tuple9 = new Tuple(new TupleElementInterface[] {
					new TupleElement("Tennessee"), new TupleElement("Tom") });
			TupleInterface tuple10 = new Tuple(new TupleElementInterface[] {
					new TupleElement("Tennessee"), new TupleElement("Dave") });

			Axis columnAxis = new Axis(AxisInterface.COLUMNS_AXIS, null,
					new TupleInterface[] { tuple1, tuple2, tuple3, tuple4 });
			columnAxis.setAxisHeaders(new String[] { "Product", "" });
			columnAxis.setUniqueLevelNames(new String[] { "[Products]",
					"[Measures]" });
			Axis rowAxis = new Axis(AxisInterface.ROWS_AXIS, null,
					new TupleInterface[] { tuple5, tuple6, tuple7, tuple8,
							tuple9, tuple10 });
			rowAxis.setAxisHeaders(new String[] { "State", "Name" });
			rowAxis.setUniqueLevelNames(new String[] { "[State]", "[Name]" });
			AxisInterface[] axes = { columnAxis, rowAxis };

			// create an instance of result set metadata with the axes
			ResultSetMetadata resultSetMetadata = new ResultSetMetadata(axes);
			ResultSet resultSet = new ResultSet();
			resultSet.setResultSetMetadata(resultSetMetadata);
			Object[] values = new Object[] { "500", "150", "200", "75", "450",
					"105", "300", "85", "335", "80", "120", "25", "570", "175",
					"150", "35", "475", "125", "205", "40", "610", "230", "95",
					"30" };
			resultSet.setCells(0, 23, values);
			defaultOLAPTableModel = new OLAPDataSet(resultSet);
		} catch (OLAPException oe) {
			oe.printStackTrace();
		}
		return defaultOLAPTableModel;

	}
}