View Javadoc
1   /*
2    * Portions of this software was developed by employees of the National Institute
3    * of Standards and Technology (NIST), an agency of the Federal Government and is
4    * being made available as a public service. Pursuant to title 17 United States
5    * Code Section 105, works of NIST employees are not subject to copyright
6    * protection in the United States. This software may be subject to foreign
7    * copyright. Permission in the United States and in foreign countries, to the
8    * extent that NIST may hold copyright, to use, copy, modify, create derivative
9    * works, and distribute this software and its documentation without fee is hereby
10   * granted on a non-exclusive basis, provided that this notice and disclaimer
11   * of warranty appears in all copies.
12   *
13   * THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
14   * EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
15   * THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
16   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
17   * INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
18   * SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE.  IN NO EVENT
19   * SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
20   * INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM,
21   * OR IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
22   * CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
23   * PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
24   * OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.
25   */
26  
27  package gov.nist.secauto.oscal.lib.profile.resolver.support;
28  
29  import gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem;
30  import gov.nist.secauto.metaschema.model.common.metapath.item.IRootAssemblyNodeItem;
31  import gov.nist.secauto.oscal.lib.profile.resolver.support.IEntityItem.ItemType;
32  
33  import java.util.Set;
34  
35  import edu.umd.cs.findbugs.annotations.NonNull;
36  
37  /**
38   * A visitor that walks a catalog visiting controls and parameters.
39   */
40  public class ControlIndexingVisitor
41      extends AbstractIndexingVisitor<IIndexer, Void> {
42  
43    public ControlIndexingVisitor(@NonNull Set<ItemType> itemTypesToIndex) {
44      super(itemTypesToIndex);
45    }
46  
47    @SuppressWarnings("null")
48    @Override
49    protected IIndexer getIndexer(IIndexer state) {
50      return state;
51    }
52  
53    @Override
54    protected Void newDefaultResult(IIndexer state) {
55      return null;
56    }
57  
58    @Override
59    protected Void aggregateResults(Void first, Void second, IIndexer state) {
60      return null;
61    }
62  
63    public void visitProfile(@NonNull IDocumentNodeItem profileDocument, @NonNull IIndexer index) {
64      IRootAssemblyNodeItem root = profileDocument.getRootAssemblyNodeItem();
65      visitMetadata(root, index);
66      visitBackMatter(root, index);
67    }
68  }