001/*
002 * Portions of this software was developed by employees of the National Institute
003 * of Standards and Technology (NIST), an agency of the Federal Government and is
004 * being made available as a public service. Pursuant to title 17 United States
005 * Code Section 105, works of NIST employees are not subject to copyright
006 * protection in the United States. This software may be subject to foreign
007 * copyright. Permission in the United States and in foreign countries, to the
008 * extent that NIST may hold copyright, to use, copy, modify, create derivative
009 * works, and distribute this software and its documentation without fee is hereby
010 * granted on a non-exclusive basis, provided that this notice and disclaimer
011 * of warranty appears in all copies.
012 *
013 * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
014 * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
015 * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
016 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
017 * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
018 * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
019 * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
020 * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
021 * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
022 * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
023 * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
024 * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
025 */
026
027package gov.nist.secauto.metaschema.core.model.constraint;
028
029import gov.nist.secauto.metaschema.core.metapath.item.node.INodeItem;
030import gov.nist.secauto.metaschema.core.util.CollectionUtil;
031
032import java.util.ArrayList;
033import java.util.List;
034import java.util.Map;
035import java.util.concurrent.ConcurrentHashMap;
036
037import edu.umd.cs.findbugs.annotations.NonNull;
038
039public class DefaultIndex implements IIndex {
040  @NonNull
041  private final List<IKeyField> keyFields;
042  @NonNull
043  private final Map<List<String>, INodeItem> keyToItemMap = new ConcurrentHashMap<>();
044
045  /**
046   * Construct a new index.
047   *
048   * @param keyFields
049   *          the key field components to use to generate keys by default
050   */
051  protected DefaultIndex(@NonNull List<? extends IKeyField> keyFields) {
052    this.keyFields = CollectionUtil.unmodifiableList(new ArrayList<>(keyFields));
053  }
054
055  @Override
056  public List<IKeyField> getKeyFields() {
057    return keyFields;
058  }
059
060  @Override
061  public INodeItem put(@NonNull INodeItem item, @NonNull List<String> key) {
062    INodeItem oldItem = null;
063    if (!IIndex.isAllNulls(key)) {
064      // only add keys with some information (values)
065      oldItem = keyToItemMap.put(key, item);
066    }
067    return oldItem;
068  }
069
070  @Override
071  public INodeItem get(List<String> key) {
072    if (getKeyFields().size() != key.size()) {
073      throw new IllegalArgumentException("Provided key is not the same size as the index requires.");
074    }
075    return keyToItemMap.get(key);
076  }
077}