From 6a07d2d622eaa06953f3353e39c080984076e8de Mon Sep 17 00:00:00 2001 From: Ashlee Young Date: Fri, 9 Oct 2015 18:32:44 -0700 Subject: Updated master to commit id 6ee8aa3e67ce89908a8c93aa9445c6f71a18f986 Change-Id: I94b055ee2f298daf71e2ec794fd0f2495bd8081f --- .../onos/tools/package/archetypes/uitab/pom.xml | 31 ++++ .../META-INF/maven/archetype-metadata.xml | 39 +++++ .../src/main/resources/archetype-resources/pom.xml | 140 +++++++++++++++ .../src/main/java/AppUiTableComponent.java | 80 +++++++++ .../src/main/java/AppUiTableMessageHandler.java | 190 +++++++++++++++++++++ .../resources/app/view/sampleTable/sampleTable.css | 35 ++++ .../app/view/sampleTable/sampleTable.html | 46 +++++ .../resources/app/view/sampleTable/sampleTable.js | 141 +++++++++++++++ .../src/main/resources/sampleTable/css.html | 1 + .../src/main/resources/sampleTable/js.html | 1 + .../resources/projects/basic/archetype.properties | 21 +++ .../src/test/resources/projects/basic/goal.txt | 0 12 files changed, 725 insertions(+) create mode 100644 framework/src/onos/tools/package/archetypes/uitab/pom.xml create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/META-INF/maven/archetype-metadata.xml create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableComponent.java create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.css create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.html create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.js create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/css.html create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/js.html create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/test/resources/projects/basic/archetype.properties create mode 100644 framework/src/onos/tools/package/archetypes/uitab/src/test/resources/projects/basic/goal.txt (limited to 'framework/src/onos/tools/package/archetypes/uitab') diff --git a/framework/src/onos/tools/package/archetypes/uitab/pom.xml b/framework/src/onos/tools/package/archetypes/uitab/pom.xml new file mode 100644 index 00000000..cb18f1f3 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/pom.xml @@ -0,0 +1,31 @@ + + + + 4.0.0 + + + org.onosproject + onos-archetypes + 1.4.0-SNAPSHOT + + + onos-uitab-archetype + maven-archetype + + ONOS UI Table-View overlay archetype + + diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/META-INF/maven/archetype-metadata.xml b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/META-INF/maven/archetype-metadata.xml new file mode 100644 index 00000000..a6273811 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/META-INF/maven/archetype-metadata.xml @@ -0,0 +1,39 @@ + + + + + + + src/main/java + + **/*.java + + + + src/main/resources + + **/*.html + **/*.js + **/*.css + + + + diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml new file mode 100644 index 00000000..05a62b27 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/pom.xml @@ -0,0 +1,140 @@ + + + + + 4.0.0 + + ${groupId} + ${artifactId} + ${version} + bundle + + ONOS OSGi UI Table-View bundle archetype + http://onosproject.org + + + 1.4.0-SNAPSHOT + + + + + + org.onosproject + onos-api + ${onos.version} + + + + org.onosproject + onlab-osgi + ${onos.version} + + + + junit + junit + 4.11 + test + + + + org.onosproject + onos-api + ${onos.version} + test + tests + + + + org.apache.felix + org.apache.felix.scr.annotations + 1.9.8 + provided + + + + + + + org.apache.felix + maven-bundle-plugin + 2.5.3 + true + + + org.apache.maven.plugins + maven-compiler-plugin + 2.5.1 + + 1.8 + 1.8 + + + + org.apache.felix + maven-scr-plugin + 1.20.0 + + + generate-scr-srcdescriptor + + scr + + + + + + bundle + war + + + + + org.onosproject + onos-maven-plugin + 1.5 + + + cfg + generate-resources + + cfg + + + + swagger + generate-sources + + swagger + + + + app + package + + app + + + + + + + + diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableComponent.java b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableComponent.java new file mode 100644 index 00000000..263564ce --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableComponent.java @@ -0,0 +1,80 @@ +#set( $symbol_pound = '#' ) +#set( $symbol_dollar = '$' ) +#set( $symbol_escape = '\' ) +/* + * 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 ${package}; + +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 AppUiTableComponent { + + private static final String VIEW_ID = "sampleTable"; + private static final String VIEW_TEXT = "Sample Table"; + + private final Logger log = LoggerFactory.getLogger(getClass()); + + @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) + protected UiExtensionService uiExtensionService; + + // List of application views + private final List uiViews = ImmutableList.of( + new UiView(UiView.Category.OTHER, VIEW_ID, VIEW_TEXT) + ); + + // Factory for UI message handlers + private final UiMessageHandlerFactory messageHandlerFactory = + () -> ImmutableList.of( + new AppUiTableMessageHandler() + ); + + // 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/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java new file mode 100644 index 00000000..a673f1fd --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/java/AppUiTableMessageHandler.java @@ -0,0 +1,190 @@ +#set( $symbol_pound = '#' ) +#set( $symbol_dollar = '$' ) +#set( $symbol_escape = '\' ) +/* + * 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 ${package}; + +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.lang.Override; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; + +/** + * Skeletal ONOS UI Table-View message handler. + */ +public class AppUiTableMessageHandler extends UiMessageHandler { + + private static final String SAMPLE_TABLE_DATA_REQ = "sampleTableDataRequest"; + private static final String SAMPLE_TABLE_DATA_RESP = "sampleTableDataResponse"; + private static final String SAMPLE_TABLES = "sampleTables"; + + private static final String SAMPLE_TABLE_DETAIL_REQ = "sampleTableDetailsRequest"; + private static final String SAMPLE_TABLE_DETAIL_RESP = "sampleTableDetailsResponse"; + 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 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 items = ss.getItems() + + // fake data for demonstration purposes... + List 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 getItems() { + List 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/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.css b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.css new file mode 100644 index 00000000..5eb551b3 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.css @@ -0,0 +1,35 @@ +/* css for sample table view */ + +#ov-sample-table h2 { + display: inline-block; +} + +/* Panel Styling */ +#ov-sample-table-item-details-panel.floatpanel { + position: absolute; + top: 115px; +} + +.light #ov-sample-table-item-details-panel.floatpanel { + background-color: rgb(229, 234, 237); +} +.dark #ov-sample-table-item-details-panel.floatpanel { + background-color: #3A4042; +} + +#ov-sample-table-item-details-panel h3 { + margin: 0; + font-size: large; +} + +#ov-sample-table-item-details-panel h4 { + margin: 0; +} + +#ov-sample-table-item-details-panel td { + padding: 5px; +} +#ov-sample-table-item-details-panel td.label { + font-style: italic; + opacity: 0.8; +} diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.html b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.html new file mode 100644 index 00000000..e20a94d7 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.html @@ -0,0 +1,46 @@ + +
+
+

Items ({{tableData.length}} total)

+
+
+
+
+ +
+ +
+ + + + + + +
Item ID Label Code
+
+ +
+ + + + + + + + + + +
+ No Items found +
{{item.id}}{{item.label}}{{item.code}}
+
+ +
+ + +
diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.js b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.js new file mode 100644 index 00000000..7b925550 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/app/view/sampleTable/sampleTable.js @@ -0,0 +1,141 @@ +// js for sample app table view +(function () { + 'use strict'; + + // injected refs + var $log, $scope, fs, wss; + + // constants + var detailsReq = 'sampleTableDetailsRequest', + detailsResp = 'sampleTableDetailsResponse', + pName = 'ov-sample-table-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('ovSampleTable', []) + .controller('OvSampleTableCtrl', + ['$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: 'sampleTable', + selCb: selCb + }); + + // cleanup + $scope.$on('$destroy', function () { + wss.unbindHandlers(handlers); + $log.log('OvSampleTableCtrl has been destroyed'); + }); + + $log.log('OvSampleTableCtrl has been created'); + }]) + + .directive('ovSampleTableItemDetailsPanel', ['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/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/css.html b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/css.html new file mode 100644 index 00000000..26112b0d --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/css.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/js.html b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/js.html new file mode 100644 index 00000000..4bfa2169 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/main/resources/archetype-resources/src/main/resources/sampleTable/js.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/test/resources/projects/basic/archetype.properties b/framework/src/onos/tools/package/archetypes/uitab/src/test/resources/projects/basic/archetype.properties new file mode 100644 index 00000000..a1213b40 --- /dev/null +++ b/framework/src/onos/tools/package/archetypes/uitab/src/test/resources/projects/basic/archetype.properties @@ -0,0 +1,21 @@ +# +# 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. +# + +#Thu Dec 04 09:24:50 PST 2014 +package=it.pkg +version=0.1-SNAPSHOT +groupId=archetype.it +artifactId=basic diff --git a/framework/src/onos/tools/package/archetypes/uitab/src/test/resources/projects/basic/goal.txt b/framework/src/onos/tools/package/archetypes/uitab/src/test/resources/projects/basic/goal.txt new file mode 100644 index 00000000..e69de29b -- cgit 1.2.3-korg