ONOS-3505 Skeletal project structure for driver-matrix UI app.
Change-Id: I257a5e1a58f7edb0b13ed8402a3c9032c82db6d1
diff --git a/apps/drivermatrix/pom.xml b/apps/drivermatrix/pom.xml
new file mode 100644
index 0000000..d7a71a4
--- /dev/null
+++ b/apps/drivermatrix/pom.xml
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ~ Copyright 2014 Open Networking Laboratory
+ ~
+ ~ Licensed under the Apache License, Version 2.0 (the "License");
+ ~ you may not use this file except in compliance with the License.
+ ~ You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ -->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.onosproject</groupId>
+ <artifactId>onos-apps</artifactId>
+ <version>1.4.0-SNAPSHOT</version>
+ <relativePath>../pom.xml</relativePath>
+ </parent>
+
+ <artifactId>onos-app-drivermatrix</artifactId>
+ <packaging>bundle</packaging>
+
+ <description>Driver behaviour support matric</description>
+
+ <properties>
+ <onos.app.name>org.onosproject.drivermatrix</onos.app.name>
+ </properties>
+
+</project>
diff --git a/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/DriverMatrixComponent.java b/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/DriverMatrixComponent.java
new file mode 100644
index 0000000..e2b3b2e
--- /dev/null
+++ b/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/DriverMatrixComponent.java
@@ -0,0 +1,77 @@
+/*
+ * Copyright 2014,2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.drivermatrix;
+
+import com.google.common.collect.ImmutableList;
+import org.apache.felix.scr.annotations.Activate;
+import org.apache.felix.scr.annotations.Component;
+import org.apache.felix.scr.annotations.Deactivate;
+import org.apache.felix.scr.annotations.Reference;
+import org.apache.felix.scr.annotations.ReferenceCardinality;
+import org.onosproject.ui.UiExtension;
+import org.onosproject.ui.UiExtensionService;
+import org.onosproject.ui.UiMessageHandlerFactory;
+import org.onosproject.ui.UiView;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.List;
+
+/**
+ * Skeletal ONOS UI Table-View application component.
+ */
+@Component(immediate = true)
+public class DriverMatrixComponent {
+
+ private static final String VIEW_ID = "driverMatrix";
+ private static final String VIEW_TEXT = "Driver Matrix";
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
+ protected UiExtensionService uiExtensionService;
+
+ // List of application views
+ private final List<UiView> uiViews = ImmutableList.of(
+ new UiView(UiView.Category.OTHER, VIEW_ID, VIEW_TEXT)
+ );
+
+ // Factory for UI message handlers
+ private final UiMessageHandlerFactory messageHandlerFactory =
+ () -> ImmutableList.of(
+ new DriverMatrixMessageHandler()
+ );
+
+ // Application UI extension
+ protected UiExtension extension =
+ new UiExtension.Builder(getClass().getClassLoader(), uiViews)
+ .resourcePath(VIEW_ID)
+ .messageHandlerFactory(messageHandlerFactory)
+ .build();
+
+ @Activate
+ protected void activate() {
+ uiExtensionService.register(extension);
+ log.info("Started");
+ }
+
+ @Deactivate
+ protected void deactivate() {
+ uiExtensionService.unregister(extension);
+ log.info("Stopped");
+ }
+
+}
diff --git a/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/DriverMatrixMessageHandler.java b/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/DriverMatrixMessageHandler.java
new file mode 100644
index 0000000..a4e77f4
--- /dev/null
+++ b/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/DriverMatrixMessageHandler.java
@@ -0,0 +1,194 @@
+/*
+ * Copyright 2014,2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.onosproject.drivermatrix;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.google.common.collect.ImmutableSet;
+import org.onosproject.ui.RequestHandler;
+import org.onosproject.ui.UiMessageHandler;
+import org.onosproject.ui.table.TableModel;
+import org.onosproject.ui.table.TableRequestHandler;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.List;
+
+/**
+ * Skeletal ONOS UI Table-View message handler.
+ */
+public class DriverMatrixMessageHandler extends UiMessageHandler {
+
+ private static final String SAMPLE_TABLE_DATA_REQ = "driverMatrixDataRequest";
+ private static final String SAMPLE_TABLE_DATA_RESP = "driverMatrixDataResponse";
+ private static final String SAMPLE_TABLES = "driverMatrixs";
+
+ private static final String SAMPLE_TABLE_DETAIL_REQ = "driverMatrixDetailsRequest";
+ private static final String SAMPLE_TABLE_DETAIL_RESP = "driverMatrixDetailsResponse";
+ private static final String DETAILS = "details";
+
+ private static final String ID = "id";
+ private static final String LABEL = "label";
+ private static final String CODE = "code";
+ private static final String COMMENT = "comment";
+ private static final String RESULT = "result";
+
+ private static final String[] COLUMN_IDS = {ID, LABEL, CODE};
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+
+ @Override
+ protected Collection<RequestHandler> createRequestHandlers() {
+ return ImmutableSet.of(
+ new SampleTableDataRequestHandler(),
+ new SampleTableDetailRequestHandler()
+ );
+ }
+
+ // handler for sample table requests
+ private final class SampleTableDataRequestHandler extends TableRequestHandler {
+
+ private SampleTableDataRequestHandler() {
+ super(SAMPLE_TABLE_DATA_REQ, SAMPLE_TABLE_DATA_RESP, SAMPLE_TABLES);
+ }
+
+ // if necessary, override defaultColumnId() -- if it isn't "id"
+
+ @Override
+ protected String[] getColumnIds() {
+ return COLUMN_IDS;
+ }
+
+ // if required, override createTableModel() to set column formatters / comparators
+
+ @Override
+ protected void populateTable(TableModel tm, ObjectNode payload) {
+ // === NOTE: the table model supplied here will have been created
+ // via a call to createTableModel(). To assign non-default
+ // cell formatters or comparators to the table model, override
+ // createTableModel() and set them there.
+
+ // === retrieve table row items from some service...
+ // SomeService ss = get(SomeService.class);
+ // List<Item> items = ss.getItems()
+
+ // fake data for demonstration purposes...
+ List<Item> items = getItems();
+ for (Item item : items) {
+ populateRow(tm.addRow(), item);
+ }
+ }
+
+ private void populateRow(TableModel.Row row, Item item) {
+ row.cell(ID, item.id())
+ .cell(LABEL, item.label())
+ .cell(CODE, item.code());
+ }
+ }
+
+
+ // handler for sample item details requests
+ private final class SampleTableDetailRequestHandler extends RequestHandler {
+
+ private SampleTableDetailRequestHandler() {
+ super(SAMPLE_TABLE_DETAIL_REQ);
+ }
+
+ @Override
+ public void process(long sid, ObjectNode payload) {
+ String id = string(payload, ID, "(none)");
+
+ // SomeService ss = get(SomeService.class);
+ // Item item = ss.getItemDetails(id)
+
+ // fake data for demonstration purposes...
+ Item item = getItem(id);
+
+ ObjectNode rootNode = objectNode();
+ ObjectNode data = objectNode();
+ rootNode.set(DETAILS, data);
+
+ if (item == null) {
+ rootNode.put(RESULT, "Item with id '" + id + "' not found");
+ log.warn("attempted to get item detail for id '{}'", id);
+
+ } else {
+ rootNode.put(RESULT, "Found item with id '" + id + "'");
+
+ data.put(ID, item.id());
+ data.put(LABEL, item.label());
+ data.put(CODE, item.code());
+ data.put(COMMENT, "Some arbitrary comment");
+ }
+
+ sendMessage(SAMPLE_TABLE_DETAIL_RESP, 0, rootNode);
+ }
+ }
+
+
+ // ===================================================================
+ // NOTE: The code below this line is to create fake data for this
+ // sample code. Normally you would use existing services to
+ // provide real data.
+
+ // Lookup a single item.
+ private static Item getItem(String id) {
+ // We realize this code is really inefficient, but
+ // it suffices for our purposes of demonstration...
+ for (Item item : getItems()) {
+ if (item.id().equals(id)) {
+ return item;
+ }
+ }
+ return null;
+ }
+
+ // Produce a list of items.
+ private static List<Item> getItems() {
+ List<Item> items = new ArrayList<>();
+ items.add(new Item("item-1", "foo", 42));
+ items.add(new Item("item-2", "bar", 99));
+ items.add(new Item("item-3", "baz", 65));
+ return items;
+ }
+
+ // Simple model class to provide sample data
+ private static class Item {
+ private final String id;
+ private final String label;
+ private final int code;
+
+ Item(String id, String label, int code) {
+ this.id = id;
+ this.label = label;
+ this.code = code;
+ }
+
+ String id() {
+ return id;
+ }
+
+ String label() {
+ return label;
+ }
+
+ int code() {
+ return code;
+ }
+ }
+}
\ No newline at end of file
diff --git a/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/package-info.java b/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/package-info.java
new file mode 100644
index 0000000..f0a564d
--- /dev/null
+++ b/apps/drivermatrix/src/main/java/org/onosproject/drivermatrix/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2014-2015 Open Networking Laboratory
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Driver support matrix app.
+ */
+package org.onosproject.drivermatrix;
\ No newline at end of file
diff --git a/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.css b/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.css
new file mode 100644
index 0000000..82ac4bb
--- /dev/null
+++ b/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.css
@@ -0,0 +1,35 @@
+/* css for sample table view */
+
+#ov-driver-matrix h2 {
+ display: inline-block;
+}
+
+/* Panel Styling */
+#ov-driver-matrix-item-details-panel.floatpanel {
+ position: absolute;
+ top: 115px;
+}
+
+.light #ov-driver-matrix-item-details-panel.floatpanel {
+ background-color: rgb(229, 234, 237);
+}
+.dark #ov-driver-matrix-item-details-panel.floatpanel {
+ background-color: #3A4042;
+}
+
+#ov-driver-matrix-item-details-panel h3 {
+ margin: 0;
+ font-size: large;
+}
+
+#ov-driver-matrix-item-details-panel h4 {
+ margin: 0;
+}
+
+#ov-driver-matrix-item-details-panel td {
+ padding: 5px;
+}
+#ov-driver-matrix-item-details-panel td.label {
+ font-style: italic;
+ opacity: 0.8;
+}
diff --git a/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.html b/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.html
new file mode 100644
index 0000000..940a887
--- /dev/null
+++ b/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.html
@@ -0,0 +1,46 @@
+<!-- partial HTML -->
+<div id="ov-driver-matrix">
+ <div class="tabular-header">
+ <h2>Items ({{tableData.length}} total)</h2>
+ <div class="ctrl-btns">
+ <div class="refresh" ng-class="{active: autoRefresh}"
+ icon icon-id="refresh" icon-size="36"
+ tooltip tt-msg="autoRefreshTip"
+ ng-click="toggleRefresh()"></div>
+ </div>
+ </div>
+
+ <div class="summary-list" onos-table-resize>
+
+ <div class="table-header" onos-sortable-header>
+ <table>
+ <tr>
+ <td colId="id" sortable>Item ID </td>
+ <td colId="label" sortable>Label </td>
+ <td colId="code" sortable>Code </td>
+ </tr>
+ </table>
+ </div>
+
+ <div class="table-body">
+ <table>
+ <tr ng-if="!tableData.length" class="no-data">
+ <td colspan="3">
+ No Items found
+ </td>
+ </tr>
+
+ <tr ng-repeat="item in tableData track by $index"
+ ng-click="selectCallback($event, item)"
+ ng-class="{selected: item.id === selId}">
+ <td>{{item.id}}</td>
+ <td>{{item.label}}</td>
+ <td>{{item.code}}</td>
+ </tr>
+ </table>
+ </div>
+
+ </div>
+
+ <ov-driver-matrix-item-details-panel></ov-driver-matrix-item-details-panel>
+</div>
diff --git a/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.js b/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.js
new file mode 100644
index 0000000..2f33a54
--- /dev/null
+++ b/apps/drivermatrix/src/main/resources/app/view/driverMatrix/driverMatrix.js
@@ -0,0 +1,141 @@
+// js for sample app table view
+(function () {
+ 'use strict';
+
+ // injected refs
+ var $log, $scope, fs, wss;
+
+ // constants
+ var detailsReq = 'driverMatrixDetailsRequest',
+ detailsResp = 'driverMatrixDetailsResponse',
+ pName = 'ov-driver-matrix-item-details-panel',
+
+ propOrder = ['id', 'label', 'code'],
+ friendlyProps = ['Item ID', 'Item Label', 'Special Code'];
+
+
+ function addProp(tbody, index, value) {
+ var tr = tbody.append('tr');
+
+ function addCell(cls, txt) {
+ tr.append('td').attr('class', cls).html(txt);
+ }
+ addCell('label', friendlyProps[index] + ' :');
+ addCell('value', value);
+ }
+
+ function populatePanel(panel) {
+ var title = panel.append('h3'),
+ tbody = panel.append('table').append('tbody');
+
+ title.text('Item Details');
+
+ propOrder.forEach(function (prop, i) {
+ addProp(tbody, i, $scope.panelDetails[prop]);
+ });
+
+ panel.append('hr');
+ panel.append('h4').text('Comments');
+ panel.append('p').text($scope.panelDetails.comment);
+ }
+
+ function respDetailsCb(data) {
+ $scope.panelDetails = data.details;
+ $scope.$apply();
+ }
+
+ angular.module('ovDriverMatrix', [])
+ .controller('OvDriverMatrixCtrl',
+ ['$log', '$scope', 'TableBuilderService',
+ 'FnService', 'WebSocketService',
+
+ function (_$log_, _$scope_, tbs, _fs_, _wss_) {
+ $log = _$log_;
+ $scope = _$scope_;
+ fs = _fs_;
+ wss = _wss_;
+
+ var handlers = {};
+ $scope.panelDetails = {};
+
+ // details response handler
+ handlers[detailsResp] = respDetailsCb;
+ wss.bindHandlers(handlers);
+
+ // custom selection callback
+ function selCb($event, row) {
+ if ($scope.selId) {
+ wss.sendEvent(detailsReq, { id: row.id });
+ } else {
+ $scope.hidePanel();
+ }
+ $log.debug('Got a click on:', row);
+ }
+
+ // TableBuilderService creating a table for us
+ tbs.buildTable({
+ scope: $scope,
+ tag: 'driverMatrix',
+ selCb: selCb
+ });
+
+ // cleanup
+ $scope.$on('$destroy', function () {
+ wss.unbindHandlers(handlers);
+ $log.log('OvDriverMatrixCtrl has been destroyed');
+ });
+
+ $log.log('OvDriverMatrixCtrl has been created');
+ }])
+
+ .directive('ovDriverMatrixItemDetailsPanel', ['PanelService', 'KeyService',
+ function (ps, ks) {
+ return {
+ restrict: 'E',
+ link: function (scope, element, attrs) {
+ // insert details panel with PanelService
+ // create the panel
+ var panel = ps.createPanel(pName, {
+ width: 200,
+ margin: 20,
+ hideMargin: 0
+ });
+ panel.hide();
+ scope.hidePanel = function () { panel.hide(); };
+
+ function closePanel() {
+ if (panel.isVisible()) {
+ $scope.selId = null;
+ panel.hide();
+ return true;
+ }
+ return false;
+ }
+
+ // create key bindings to handle panel
+ ks.keyBindings({
+ esc: [closePanel, 'Close the details panel'],
+ _helpFormat: ['esc']
+ });
+ ks.gestureNotes([
+ ['click', 'Select a row to show item details']
+ ]);
+
+ // update the panel's contents when the data is changed
+ scope.$watch('panelDetails', function () {
+ if (!fs.isEmptyObject(scope.panelDetails)) {
+ panel.empty();
+ populatePanel(panel);
+ panel.show();
+ }
+ });
+
+ // cleanup on destroyed scope
+ scope.$on('$destroy', function () {
+ ks.unbindKeys();
+ ps.destroyPanel(pName);
+ });
+ }
+ };
+ }]);
+}());
diff --git a/apps/drivermatrix/src/main/resources/driverMatrix/css.html b/apps/drivermatrix/src/main/resources/driverMatrix/css.html
new file mode 100644
index 0000000..0092289
--- /dev/null
+++ b/apps/drivermatrix/src/main/resources/driverMatrix/css.html
@@ -0,0 +1 @@
+<link rel="stylesheet" href="app/view/driverMatrix/driverMatrix.css">
\ No newline at end of file
diff --git a/apps/drivermatrix/src/main/resources/driverMatrix/js.html b/apps/drivermatrix/src/main/resources/driverMatrix/js.html
new file mode 100644
index 0000000..c1c6a1e
--- /dev/null
+++ b/apps/drivermatrix/src/main/resources/driverMatrix/js.html
@@ -0,0 +1 @@
+<script src="app/view/driverMatrix/driverMatrix.js"></script>
\ No newline at end of file
diff --git a/apps/pom.xml b/apps/pom.xml
index 1a279c5..3a1ed16 100644
--- a/apps/pom.xml
+++ b/apps/pom.xml
@@ -61,6 +61,7 @@
<module>mlb</module>
<module>openstackswitching</module>
<module>pathpainter</module>
+ <module>drivermatrix</module>
<module>cpman</module>
</modules>