PropertyEditorEvent.java

/*
 * Copyright 2015 JBoss, by Red Hat, Inc
 *
 * 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.uberfire.ext.properties.editor.model;

import java.util.ArrayList;
import java.util.Comparator;
import java.util.List;

import static java.util.Collections.sort;
import static org.uberfire.commons.validation.PortablePreconditions.checkNotNull;

/**
 * A Property Editor CDI Event handled by Property Editor.
 * Id event its a parameter to identify the originator of the event.
 * A Property Editor event contains one or multiples PropertyEditorCategory.
 */
public class PropertyEditorEvent {

    private List<PropertyEditorCategory> properties = new ArrayList<PropertyEditorCategory>();

    public PropertyEditorEvent(String idEvent,
                               List<PropertyEditorCategory> properties) {
        checkNotNull("idEvent",
                     idEvent);
        checkNotNull("properties",
                     properties);
        for (PropertyEditorCategory property : properties) {
            property.setIdEvent(idEvent);
        }
        this.properties = properties;
    }

    public PropertyEditorEvent(String idEvent,
                               PropertyEditorCategory property) {
        checkNotNull("idEvent",
                     idEvent);
        checkNotNull("property",
                     property);
        property.setIdEvent(idEvent);
        this.properties.add(property);
    }

    private static void sortCategoriesAndFieldsByPriority(List<PropertyEditorCategory> properties) {
        sortCategoriesByPriority(properties);

        sortEditorFieldInfoByPriority(properties);
    }

    private static void sortCategoriesByPriority(List<PropertyEditorCategory> properties) {
        sort(properties,
             new Comparator<PropertyEditorCategory>() {
                 @Override
                 public int compare(final PropertyEditorCategory o1,
                                    final PropertyEditorCategory o2) {

                     if (o1.getPriority() < o2.getPriority()) {
                         return -1;
                     } else if (o1.getPriority() > o2.getPriority()) {
                         return 1;
                     } else {
                         return 0;
                     }
                 }
             });
    }

    private static void sortEditorFieldInfoByPriority(List<PropertyEditorCategory> properties) {
        for (PropertyEditorCategory category : properties) {
            sort(category.getFields(),
                 new Comparator<PropertyEditorFieldInfo>() {
                     @Override
                     public int compare(final PropertyEditorFieldInfo o1,
                                        final PropertyEditorFieldInfo o2) {

                         if (o1.getPriority() < o2.getPriority()) {
                             return -1;
                         } else if (o1.getPriority() > o2.getPriority()) {
                             return 1;
                         } else {
                             return 0;
                         }
                     }
                 });
        }
    }

    /**
     * Get Properties from a event ordered by priority.
     * @return Categories and fields ordered by priority, lower values toward the beginning
     */
    public List<PropertyEditorCategory> getSortedProperties() {
        sortCategoriesAndFieldsByPriority(properties);
        return properties;
    }
}