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.IRequiredValueModelNodeItem;
30  import gov.nist.secauto.metaschema.model.common.metapath.item.IRootAssemblyNodeItem;
31  import gov.nist.secauto.metaschema.model.common.util.ObjectUtils;
32  
33  import java.util.EnumSet;
34  import java.util.Set;
35  
36  import edu.umd.cs.findbugs.annotations.NonNull;
37  
38  public abstract class AbstractIndexingVisitor<T, R>
39      extends AbstractCatalogEntityVisitor<T, R> {
40  
41    public AbstractIndexingVisitor() {
42      this(ObjectUtils.notNull(EnumSet.allOf(IEntityItem.ItemType.class)));
43    }
44  
45    public AbstractIndexingVisitor(@NonNull Set<IEntityItem.ItemType> itemTypesToIndex) {
46      super(itemTypesToIndex);
47    }
48  
49    @NonNull
50    protected abstract IIndexer getIndexer(T state);
51  
52    @Override
53    public R visitGroup(IRequiredValueModelNodeItem item, R childResult, T state) {
54      getIndexer(state).addGroup(item);
55      return childResult;
56    }
57  
58    @Override
59    public R visitControl(IRequiredValueModelNodeItem item, R childResult, T state) {
60      getIndexer(state).addControl(item);
61      return childResult;
62    }
63  
64    @Override
65    protected R visitParameter(@NonNull IRequiredValueModelNodeItem parameterItem,
66        @NonNull IRequiredValueModelNodeItem catalogOrGroupOrControl, T state) {
67      getIndexer(state).addParameter(parameterItem);
68      return newDefaultResult(state);
69    }
70  
71    @Override
72    protected void visitPart(@NonNull IRequiredValueModelNodeItem partItem,
73        @NonNull IRequiredValueModelNodeItem catalogOrGroupOrControl, T state) {
74      getIndexer(state).addPart(partItem);
75    }
76  
77    @Override
78    protected void visitRole(IRequiredValueModelNodeItem roleItem, IRequiredValueModelNodeItem metadataItem, T state) {
79      getIndexer(state).addRole(roleItem);
80    }
81  
82    @Override
83    protected void visitLocation(IRequiredValueModelNodeItem locationItem, IRequiredValueModelNodeItem metadataItem,
84        T state) {
85      getIndexer(state).addLocation(locationItem);
86    }
87  
88    @Override
89    protected void visitParty(IRequiredValueModelNodeItem partyItem, IRequiredValueModelNodeItem metadataItem, T state) {
90      getIndexer(state).addParty(partyItem);
91    }
92  
93    @Override
94    protected void visitResource(IRequiredValueModelNodeItem resourceItem, IRootAssemblyNodeItem rootItem, T state) {
95      getIndexer(state).addResource(resourceItem);
96    }
97  }