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.oscal.lib.profile.resolver.support;
028
029import gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem;
030import gov.nist.secauto.metaschema.model.common.metapath.item.IRootAssemblyNodeItem;
031import gov.nist.secauto.oscal.lib.profile.resolver.support.IEntityItem.ItemType;
032
033import java.util.Set;
034
035import edu.umd.cs.findbugs.annotations.NonNull;
036
037/**
038 * A visitor that walks a catalog visiting controls and parameters.
039 */
040public class ControlIndexingVisitor
041    extends AbstractIndexingVisitor<IIndexer, Void> {
042
043  public ControlIndexingVisitor(@NonNull Set<ItemType> itemTypesToIndex) {
044    super(itemTypesToIndex);
045  }
046
047  @SuppressWarnings("null")
048  @Override
049  protected IIndexer getIndexer(IIndexer state) {
050    return state;
051  }
052
053  @Override
054  protected Void newDefaultResult(IIndexer state) {
055    return null;
056  }
057
058  @Override
059  protected Void aggregateResults(Void first, Void second, IIndexer state) {
060    return null;
061  }
062
063  public void visitProfile(@NonNull IDocumentNodeItem profileDocument, @NonNull IIndexer index) {
064    IRootAssemblyNodeItem root = profileDocument.getRootAssemblyNodeItem();
065    visitMetadata(root, index);
066    visitBackMatter(root, index);
067  }
068}