core/api/src/main/java/org/onosproject/ui/topo/PropertyPanel.java

/*
 * Copyright 2015-present Open Networking Foundation
 *
 * 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.ui.topo;

import com.google.common.collect.Sets;

import java.text.NumberFormat;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

/**
 * Models a panel displayed on the Topology View.
 */
public class PropertyPanel {

    private static final NumberFormat NF = NumberFormat.getInstance();

    private String title;
    private String glyphId;
    private String id;
    private String navPath;
    private List<Prop> properties = new ArrayList<>();
    private List<ButtonId> buttons = new ArrayList<>();

    /**
     * Constructs a property panel model with the given title and
     * glyph identifier (icon to display).
     *
     * @param title   title text
     * @param glyphId glyph ID
     */
    public PropertyPanel(String title, String glyphId) {
        this.title = title;
        this.glyphId = glyphId;
    }

    /**
     * Returns a number formatter to use for formatting integer and long
     * property values.
     * <p>
     * This default implementation uses a formatter for the default
     * locale. For example:
     * <pre>
     *     Locale.ENGLISH  :  1000 -&gt; "1,000"
     *     Locale.FRENCH   :  1000 -&gt; "1 000"
     *     Locale.GERMAN   :  1000 -&gt; "1.000"
     * </pre>
     *
     * @return the number formatter
     */
    protected NumberFormat formatter() {
        return NF;
    }

    /**
     * Adds a navigation path field to the panel data, to be included in
     * the returned JSON data to the client. This is typically used to
     * configure the topology view with the appropriate navigation path for
     * a hot-link to some other view.
     *
     * @param navPath the navigation path
     * @return self for chaining
     */
    public PropertyPanel navPath(String navPath) {
        this.navPath = navPath;
        return this;
    }

    /**
     * Adds an ID field to the panel data, to be included in
     * the returned JSON data to the client.
     *
     * @param id the identifier
     * @return self, for chaining
     */
    public PropertyPanel id(String id) {
        this.id = id;
        return this;
    }

    /**
     * Adds a property to the panel data.
     *
     * @param key   property key
     * @param label property label (localized)
     * @param value property value
     * @return self, for chaining
     */
    public PropertyPanel addProp(String key, String label, String value) {
        properties.add(new Prop(key, label, value));
        return this;
    }

    /**
     * Adds a property to the panel data, using a decimal formatter.
     *
     * @param key   property key
     * @param label property label (localized)
     * @param value property value
     * @return self, for chaining
     */
    public PropertyPanel addProp(String key, String label, int value) {
        properties.add(new Prop(key, label, formatter().format(value)));
        return this;
    }

    /**
     * Adds a property to the panel data, using a decimal formatter.
     *
     * @param key   property key
     * @param label property label (localized)
     * @param value property value
     * @return self, for chaining
     */
    public PropertyPanel addProp(String key, String label, long value) {
        properties.add(new Prop(key, label, formatter().format(value)));
        return this;
    }

    /**
     * Adds a property to the panel data. Note that the value's
     * {@link Object#toString toString()} method is used to convert the
     * value to a string.
     *
     * @param key   property key
     * @param label property label (localized)
     * @param value property value
     * @return self, for chaining
     */
    public PropertyPanel addProp(String key, String label, Object value) {
        properties.add(new Prop(key, label, value.toString()));
        return this;
    }

    /**
     * Adds a property to the panel data. Note that the value's
     * {@link Object#toString toString()} method is used to convert the
     * value to a string, from which the characters defined in the given
     * regular expression string are stripped.
     *
     * @param key     property key
     * @param label   property label (localized)
     * @param value   property value
     * @param reStrip regexp characters to strip from value string
     * @return self, for chaining
     */
    public PropertyPanel addProp(String key, String label,
                                 Object value, String reStrip) {
        String val = value.toString().replaceAll(reStrip, "");
        properties.add(new Prop(key, label, val));
        return this;
    }

    /*
     * The following degenerate forms of addProp(...) for backward compatibility.
     */

    /**
     * Adds a property to the panel data.
     * Note that the key is used as the label.
     *
     * @param key   property key (also used as display label)
     * @param value property value
     * @return self, for chaining
     * @deprecated as of Loon (1.11) in deference to the localized version
     */
    @Deprecated
    public PropertyPanel addProp(String key, String value) {
        return addProp(key, key, value);
    }

    /**
     * Adds a property to the panel data, using a decimal formatter.
     * Note that the key is used as the label.
     *
     * @param key   property key (also used as display label)
     * @param value property value
     * @return self, for chaining
     * @deprecated as of Loon (1.11) in deference to the localized version
     */
    @Deprecated
    public PropertyPanel addProp(String key, int value) {
        return addProp(key, key, value);
    }

    /**
     * Adds a property to the panel data, using a decimal formatter.
     * Note that the key is used as the label.
     *
     * @param key   property key (also used as display label)
     * @param value property value
     * @return self, for chaining
     * @deprecated as of Loon (1.11) in deference to the localized version
     */
    @Deprecated
    public PropertyPanel addProp(String key, long value) {
        return addProp(key, key, value);
    }

    /**
     * Adds a property to the panel data. Note that the value's
     * {@link Object#toString toString()} method is used to convert the
     * value to a string.
     * Note also that the key is used as the label.
     *
     * @param key   property key (also used as display label)
     * @param value property value
     * @return self, for chaining
     * @deprecated as of Loon (1.11) in deference to the localized version
     */
    @Deprecated
    public PropertyPanel addProp(String key, Object value) {
        return addProp(key, key, value);
    }

    /**
     * Adds a property to the panel data. Note that the value's
     * {@link Object#toString toString()} method is used to convert the
     * value to a string, from which the characters defined in the given
     * regular expression string are stripped.
     * Note also that the key is used as the label.
     *
     * @param key     property key (also used as display label)
     * @param value   property value
     * @param reStrip regexp characters to strip from value string
     * @return self, for chaining
     * @deprecated as of Loon (1.11) in deference to the localized version
     */
    @Deprecated
    public PropertyPanel addProp(String key, Object value, String reStrip) {
        return addProp(key, key, value, reStrip);
    }

    /**
     * Adds a separator to the panel data.
     *
     * @return self, for chaining
     */
    public PropertyPanel addSeparator() {
        properties.add(new Separator());
        return this;
    }

    /**
     * Returns the title text.
     *
     * @return title text
     */
    public String title() {
        return title;
    }

    /**
     * Returns the glyph identifier.
     *
     * @return glyph identifier
     */
    public String glyphId() {
        return glyphId;
    }

    /**
     * Returns the navigation path.
     *
     * @return the navigation path
     */
    public String navPath() {
        return navPath;
    }

    /**
     * Returns the internal ID.
     *
     * @return the ID
     */
    public String id() {
        return id;
    }

    /**
     * Returns the list of properties to be displayed.
     *
     * @return the property list
     */
    public List<Prop> properties() {
        return properties;
    }

    /**
     * Returns the list of button descriptors.
     *
     * @return the button list
     */
    public List<ButtonId> buttons() {
        return buttons;
    }

    // == MUTATORS

    /**
     * Sets the title text.
     *
     * @param title title text
     * @return self, for chaining
     */
    public PropertyPanel title(String title) {
        this.title = title;
        return this;
    }

    /**
     * Sets the glyph identifier.
     *
     * @param glyphId glyph identifier
     * @return self, for chaining
     */
    public PropertyPanel glyphId(String glyphId) {
        this.glyphId = glyphId;
        return this;
    }

    /**
     * Removes properties with the given keys from the list.
     *
     * @param keys keys of properties to remove
     * @return self, for chaining
     */
    public PropertyPanel removeProps(String... keys) {
        Set<String> forRemoval = Sets.newHashSet(keys);
        List<Prop> toKeep = new ArrayList<>();
        for (Prop p : properties) {
            if (!forRemoval.contains(p.key())) {
                toKeep.add(p);
            }
        }
        properties = toKeep;
        return this;
    }

    /**
     * Removes all currently defined properties.
     *
     * @return self, for chaining
     */
    public PropertyPanel removeAllProps() {
        properties.clear();
        return this;
    }

    /**
     * Adds the given button descriptor to the panel data.
     *
     * @param button button descriptor
     * @return self, for chaining
     */
    public PropertyPanel addButton(ButtonId button) {
        buttons.add(button);
        return this;
    }

    /**
     * Removes buttons with the given descriptors from the list.
     *
     * @param descriptors descriptors to remove
     * @return self, for chaining
     */
    public PropertyPanel removeButtons(ButtonId... descriptors) {
        Set<ButtonId> forRemoval = Sets.newHashSet(descriptors);
        List<ButtonId> toKeep = new ArrayList<>();
        for (ButtonId bd : buttons) {
            if (!forRemoval.contains(bd)) {
                toKeep.add(bd);
            }
        }
        buttons = toKeep;
        return this;
    }

    /**
     * Removes all currently defined buttons.
     *
     * @return self, for chaining
     */
    public PropertyPanel removeAllButtons() {
        buttons.clear();
        return this;
    }

    // ====================


    /**
     * Simple data carrier for a property, composed of a key/label/value trio.
     */
    public static class Prop {
        private final String key;
        private final String label;
        private final String value;

        /**
         * Constructs a property data value.
         *
         * @param key   property key (localization key)
         * @param label property label (localization value)
         * @param value property value
         */
        public Prop(String key, String label, String value) {
            this.key = key;
            this.label = label;
            this.value = value;
        }

        /**
         * Returns the property's key.
         *
         * @return the key
         */
        public String key() {
            return key;
        }

        /**
         * Returns the property's (localized) label.
         *
         * @return the label
         */
        public String label() {
            return label;
        }

        /**
         * Returns the property's value.
         *
         * @return the value
         */
        public String value() {
            return value;
        }

        /*
         * NOTE: equals/hashCode are only expressed in terms of key and value.
         */

        @Override
        public boolean equals(Object o) {
            if (this == o) {
                return true;
            }
            if (o == null || getClass() != o.getClass()) {
                return false;
            }

            Prop prop = (Prop) o;
            return key.equals(prop.key) && value.equals(prop.value);
        }

        @Override
        public int hashCode() {
            int result = key.hashCode();
            result = 31 * result + value.hashCode();
            return result;
        }

        @Override
        public String toString() {
            return "{" + key + "(" + label + ") -> " + value + "}";
        }
    }

    /**
     * Auxiliary class representing a separator property.
     */
    static class Separator extends Prop {
        Separator() {
            super("-", "-", "");
        }
    }

}