org.eclipse.osee.ote.core/src/org/eclipse/osee/ote/message/elements/RecordMap.java

/*********************************************************************
 * Copyright (c) 2004, 2007 Boeing
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Boeing - initial API and implementation
 **********************************************************************/

package org.eclipse.osee.ote.message.elements;

import java.util.Collection;
import java.util.HashMap;
import org.eclipse.osee.ote.message.Message;
import org.eclipse.osee.ote.message.data.MessageData;

/**
 * @author Ryan D. Brooks
 * @author Andrew M. Finkbeiner
 */
public class RecordMap<T extends RecordElement> extends RecordElement {

   private final int NUMBER_OF_RECORDS;

   private final HashMap<Integer, T> records;
   private final IRecordFactory factory;

   public RecordMap(Message message, MessageData messageData, String elementName, int numberOfRecords, int firstRecordBitOffset, IRecordFactory factory) {
      this(message, messageData, elementName, 0, numberOfRecords, firstRecordBitOffset, factory);
   }

   public RecordMap(Message message, MessageData messageData, String elementName, int index, int numberOfRecords, int firstRecordBitOffset, IRecordFactory factory) {
      super(message, elementName, index, messageData, firstRecordBitOffset, factory.getBitLength());
      NUMBER_OF_RECORDS = numberOfRecords;
      records = new HashMap<>(numberOfRecords);
      this.factory = factory;
   }

   public RecordMap(Message message, MessageData messageData, String elementName, int numberOfRecords, IRecordFactory factory) {
      this(message, messageData, elementName, 1, numberOfRecords, 0, factory);
   }

   @Override
   public T get(int index) {
      if (index >= NUMBER_OF_RECORDS) {
         throw new IllegalArgumentException(
            "index(zero-based):" + index + " is greater than NUMBER_OF_RECORDS:" + NUMBER_OF_RECORDS);
      }

      T val = records.get(index);
      if (val == null) {
         val = (T) factory.create(index);
         for (Object obj : getElementPath()) {
            val.getElementPath().add(obj);
         }
         records.put(index, val);
      }
      return val;
   }

   @Override
   public void addPath(Object... objs) {
      for (Object obj : objs) {
         getElementPath().add(obj);
      }
      getElementPath().add(this.getName());
   }

   @Override
   public void put(int index, RecordElement newRecord) {
      records.put(index, (T) newRecord);
   }

   @Override
   public int length() {
      return this.NUMBER_OF_RECORDS;
   }

   public MessageData getMessageData() {
      return messageData;
   }

   public RecordMap<T> switchRecordMapMessages(Collection<? extends Message> messages) {
      for (RecordElement element : this.records.values()) {
         element.switchMessages(messages);
      }

      return this;
   }

   @Override
   public RecordMap<T> findElementInMessages(Collection<? extends Message> messages) {
      for (RecordElement element : this.records.values()) {
         element.findElementInMessages(messages);
      }
      return this;
   }
   
   @Override
   public RecordMap<T> switchMessages(Collection<? extends Message> messages) {
      for (RecordElement element : this.records.values()) {
         element.switchMessages(messages);
      }
      return this;
   }

   @Override
   public void visit(IElementVisitor visitor) {
      visitor.asRecordMap(this);
   }

   public int compareTo(RecordElement o) {
      return 0;
   }

   @Override
   public void zeroize() {
      super.zeroize();
      for (int i = 0; i < length(); i++) {
         get(i).zeroize();
      }
   }

   @Override
   public String getDescriptiveName() {
      return String.format("%s[0...%d]", getName(), length() - 1);
   }

}