Package gov.nist.secauto.oscal.lib.profile.resolver.support

Class AbstractIndexingVisitor<T,R>

java.lang.Object
gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractCatalogVisitor<T,R>
gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractCatalogEntityVisitor<T,R>
gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractIndexingVisitor<T,R>
All Implemented Interfaces:
ICatalogVisitor<T,R>
Direct Known Subclasses:
ControlIndexingVisitor, ControlSelectionVisitor
public abstract class AbstractIndexingVisitor<T,R> extends AbstractCatalogEntityVisitor<T,R>

  • Field Summary

    Fields inherited from class gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractCatalogEntityVisitor

    CHILD_PART_METAPATH

  • Constructor Summary

    Constructors
    Constructor
    Description
    AbstractIndexingVisitor()
     
    AbstractIndexingVisitor(Set<IEntityItem.ItemType> itemTypesToIndex)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract IIndexer
    getIndexer(T state)
     
    R
    visitControl(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem item, R childResult, T state)
    Called when visiting a control.
    R
    visitGroup(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem item, R childResult, T state)
    Called when visiting a group.
    protected void
    visitLocation(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem locationItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem metadataItem, T state)
    Called when visiting a location in the "metadata" section of an OSCAL document.
    protected R
    visitParameter(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem parameterItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem catalogOrGroupOrControl, T state)
    Called when visiting a parameter.
    protected void
    visitPart(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem partItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem catalogOrGroupOrControl, T state)
    Called when visiting a part.
    protected void
    visitParty(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem partyItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem metadataItem, T state)
    Called when visiting a party in the "metadata" section of an OSCAL document.
    protected void
    visitResource(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem resourceItem, gov.nist.secauto.metaschema.core.metapath.item.node.IRootAssemblyNodeItem rootItem, T state)
    Called when visiting a resource in the "back-matter" section of an OSCAL document.
    protected void
    visitRole(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem roleItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem metadataItem, T state)
    Called when visiting a role in the "metadata" section of an OSCAL document.

    Methods inherited from class gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractCatalogEntityVisitor

    getItemTypesToVisit, isVisitedItemType, visitBackMatter, visitCatalog, visitControlContainer, visitControlInternal, visitGroupContainer, visitGroupInternal, visitMetadata, visitParts

    Methods inherited from class gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractCatalogVisitor

    aggregateResults, newDefaultResult, visitControlItem, visitGroupItem

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

  • Method Details

    • getIndexer

      @NonNull protected abstract IIndexer getIndexer(T state)

    • visitGroup

      public R visitGroup(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem item, R childResult, T state)
      Description copied from interface: ICatalogVisitor
      Called when visiting a group.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Parameters:
      item - the Metapath item for the group
      childResult - the result of evaluating the group's children
      state - the calling context information
      Returns:
      a meaningful result of the given type

    • visitControl

      public R visitControl(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem item, R childResult, T state)
      Description copied from interface: ICatalogVisitor
      Called when visiting a control.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Parameters:
      item - the Metapath item for the control
      childResult - the result of evaluating the control's children
      state - the calling context information
      Returns:
      a meaningful result of the given type

    • visitParameter

      protected R visitParameter(@NonNull gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem parameterItem, @NonNull gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem catalogOrGroupOrControl, T state)
      Description copied from class: AbstractCatalogEntityVisitor
      Called when visiting a parameter.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Overrides:
      visitParameter in class AbstractCatalogEntityVisitor<T,R>
      Parameters:
      parameterItem - the Metapath item for the parameter
      catalogOrGroupOrControl - the parameter's parent Metapath item
      state - the calling context information
      Returns:
      a meaningful result of the given type

    • visitPart

      protected void visitPart(@NonNull gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem partItem, @NonNull gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem catalogOrGroupOrControl, T state)
      Description copied from class: AbstractCatalogEntityVisitor
      Called when visiting a part.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Overrides:
      visitPart in class AbstractCatalogEntityVisitor<T,R>
      Parameters:
      partItem - the Metapath item for the part
      catalogOrGroupOrControl - the part's parent Metapath item
      state - the calling context information

    • visitRole

      protected void visitRole(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem roleItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem metadataItem, T state)
      Description copied from class: AbstractCatalogEntityVisitor
      Called when visiting a role in the "metadata" section of an OSCAL document.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Overrides:
      visitRole in class AbstractCatalogEntityVisitor<T,R>
      Parameters:
      roleItem - the role Module node item which is a child of the "metadata" node
      metadataItem - the "metadata" Module node item containing the role
      state - the calling context information

    • visitLocation

      protected void visitLocation(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem locationItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem metadataItem, T state)
      Description copied from class: AbstractCatalogEntityVisitor
      Called when visiting a location in the "metadata" section of an OSCAL document.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Overrides:
      visitLocation in class AbstractCatalogEntityVisitor<T,R>
      Parameters:
      locationItem - the location Module node item which is a child of the "metadata" node
      metadataItem - the "metadata" Module node item containing the location
      state - the calling context information

    • visitParty

      protected void visitParty(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem partyItem, gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem metadataItem, T state)
      Description copied from class: AbstractCatalogEntityVisitor
      Called when visiting a party in the "metadata" section of an OSCAL document.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Overrides:
      visitParty in class AbstractCatalogEntityVisitor<T,R>
      Parameters:
      partyItem - the party Module node item which is a child of the "metadata" node
      metadataItem - the "metadata" Module node item containing the party
      state - the calling context information

    • visitResource

      protected void visitResource(gov.nist.secauto.metaschema.core.metapath.item.node.IAssemblyNodeItem resourceItem, gov.nist.secauto.metaschema.core.metapath.item.node.IRootAssemblyNodeItem rootItem, T state)
      Description copied from class: AbstractCatalogEntityVisitor
      Called when visiting a resource in the "back-matter" section of an OSCAL document.

      Can be overridden by classes extending this interface to support processing of the visited object.

      Overrides:
      visitResource in class AbstractCatalogEntityVisitor<T,R>
      Parameters:
      resourceItem - the resource Module node item which is a child of the "metadata" node
      rootItem - the resource Module node item containing the party
      state - the calling context information