io.github.agentsoz.jill.util.AObjectCatalog Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jill Show documentation
Jill cognitive agents (Core)
The newest version!
package io.github.agentsoz.jill.util;

/*
 * #%L
 * Jill Cognitive Agents Platform
 * %%
 * Copyright (C) 2014 - 2019 by its authors. See AUTHORS file.
 * %%
 * This program is free software: you can redistribute it and/or modify it under the terms of the
 * GNU Lesser General Public License as published by the Free Software Foundation, either version 3
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public License along with this program.
 * If not, see .
 * #L%
 */

import io.github.agentsoz.jill.config.GlobalConstant;
import io.github.agentsoz.jill.struct.AObject;

/**
 * AObjectCatalog class.
 *
 * @author dsingh
 * @version $Id: $Id
 */
public class AObjectCatalog extends AObject {

  private int nextid = GlobalConstant.NULLID + 1;
  private final int increment;
  private AObject[] objects;

  /**
   * Constructs a object catalog.
   *
   * @param name s nsme for the catalog
   * @param size the initial size of the catalog
   * @param inc the size by which the catalog should grow when it reaches capacity
   */
  public AObjectCatalog(String name, int size, int inc) {
    super(name);
    increment = inc;
    objects = new AObject[size];
  }

  /**
   * Gets the object at the given index of the catalog.
   *
   * @param index the index of the object
   * @return the object at that index
   */
  public AObject get(int index) {
    if (index >= 0 && index < objects.length) {
      return objects[index];
    }
    return null;
  }

  /**
   * Find an object by name. Can be very expensive for large catalogs, since a name comparison is
   * performed in sequence on the objects in the catalog, until a match is found. Search is case
   * sensitive.
   *
   * @param name the name to find
   * @return an AObject with a matching name, or null if not found
   */
  public AObject find(String name) {
    for (int i = 0; i < nextid; i++) {
      if (objects[i].getName().equals(name)) {
        return objects[i];
      }
    }
    return null;
  }

  /**
   * Pushes a new object to the top of the catalog.
   *
   * @param obj the object to add
   */
  public void push(AObject obj) {
    if (obj == null || obj.getId() != GlobalConstant.NULLID) {
      return;
    }
    // Grow if we are at capacity
    if (nextid == objects.length) {
      grow();
    }
    obj.setId(nextid);
    objects[nextid++] = obj;
  }

  /**
   * Pops (removes) the object at the top of the catalog.
   *
   * @return the object at the top, or null if the catalog is empty
   */
  public AObject pop() {
    if (nextid > GlobalConstant.NULLID) {
      nextid--;
      AObject obj = objects[nextid];
      objects[nextid] = null;
      return obj;
    }
    return null;
  }

  /**
   * size.
   *
   * @return a int.
   */
  public int size() {
    return nextid;
  }

  /**
   * Grows the Catalog by a factor of {@link #increment}.
   */
  private void grow() {
    AObject[] temp = new AObject[objects.length + increment];
    System.arraycopy(objects, 0, temp, 0, objects.length);
    objects = temp;
  }
}