content: /*****************************************************************
   *   Licensed to the Apache Software Foundation (ASF) under one
   *  or more contributor license agreements.  See the NOTICE file
   *  distributed with this work for additional information
   *  regarding copyright ownership.  The ASF licenses this file
   *  to you 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
   *
   *    https://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.apache.cayenne.modeler.util;
  
  import org.apache.cayenne.configuration.ConfigurationNode;
  import org.apache.cayenne.map.Attribute;
  import org.apache.cayenne.map.Entity;
  import org.apache.cayenne.map.Relationship;
  
  import javax.swing.event.TreeModelListener;
  import javax.swing.tree.TreeModel;
  import javax.swing.tree.TreePath;
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.Collection;
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  /**
   * Swing TreeModel for Entity attributes and relationships
   * 
   * @since 1.1
   */
  public class EntityTreeModel implements TreeModel {
      protected Entity<?,?,?> root;
      protected Map<Object, ConfigurationNode[]> sortedChildren;
  
      /**
       * Filter for checking attributes and relationships
       */
      protected EntityTreeFilter filter;
  
      public EntityTreeModel(Entity<?,?,?> root) {
          this.root = root;
          sortedChildren = new HashMap<>();
      }
  
      public Object getRoot() {
          return root;
      }
  
      public Object getChild(Object node, int index) {
          return sortedChildren(node)[index];
      }
  
      public int getChildCount(Object node) {
          return (node instanceof Attribute) ? 0 : sortedChildren(node).length;
      }
  
      public boolean isLeaf(Object node) {
          return getChildCount(node) == 0;
      }
  
      public void valueForPathChanged(TreePath arg0, Object arg1) {
          // do nothing...
      }
  
      public int getIndexOfChild(Object node, Object child) {
          if (node instanceof Attribute) {
              return -1;
          }
  
          // wonder if linear search will be faster, considering that
          // this comparator uses reflection?
          return Arrays.binarySearch(sortedChildren(node), (ConfigurationNode)child, Comparators.getNamedObjectComparator());
      }
  
      public void addTreeModelListener(TreeModelListener listener) {
          // do nothing...
      }
  
      public void removeTreeModelListener(TreeModelListener listener) {
          // do nothing...
      }
  
      @SuppressWarnings({"unchecked", "rawtypes"})
      private ConfigurationNode[] sortedChildren(Object node) {
          Entity entity = entityForNonLeafNode(node);
  
          // may happen in incomplete relationships
          if (entity == null) {
              return new ConfigurationNode[0];
          }
  
          ConfigurationNode[] sortedForNode = sortedChildren.get(node);
  
          if (sortedForNode == null) {
              Collection<Attribute<?,?,?>> attributes = entity.getAttributes();
              Collection<Relationship<?,?,?>> relationships = entity.getRelationships();
  
              List<ConfigurationNode> nodes = new ArrayList<>();
  
              // combine two collections in an array
              for (Attribute<?,?,?> attr : attributes) {
                  if (filter == null || filter.attributeMatch(node, attr)) {
                      nodes.add((ConfigurationNode)attr);
                  }
              }
  
              for (Relationship<?,?,?> rel : relationships) {
                  if (filter == null || filter.relationshipMatch(node, rel)) {
                      nodes.add((ConfigurationNode)rel);
                  }
              }
  
              sortedForNode = nodes.toArray(new ConfigurationNode[0]);
  
              Arrays.sort(sortedForNode, Comparators.getEntityChildrenComparator());
              sortedChildren.put(node, sortedForNode);
          }
  
          return sortedForNode;
      }
  
      /**
       * Removes children cache for specified entity.
       */
      public void invalidate() {
          sortedChildren.clear();
      }
  
      /**
       * Removes children cache for specified entity.
       */
      public void invalidateChildren(Entity<?,?,?> entity) {
          sortedChildren.remove(entity);
  
          for (Relationship<?,?,?> rel : entity.getRelationships()) {
              sortedChildren.remove(rel);
          }
      }
  
      private Entity<?,?,?> entityForNonLeafNode(Object node) {
          if (node instanceof Entity) {
              return (Entity<?,?,?>) node;
          } else if (node instanceof Relationship) {
              return ((Relationship<?,?,?>) node).getTargetEntity();
          }
  
          String className = (node != null) ? node.getClass().getName() : "null";
          throw new IllegalArgumentException("Unexpected non-leaf node: " + className);
      }
  
      /**
       * Sets filter for attrs and rels
       */
      public void setFilter(EntityTreeFilter filter) {
          this.filter = filter;
      }
  
      /**
       * Returns filter for attrs and rels
       */
      public EntityTreeFilter getFilter() {
          return filter;
      }
  }
  