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

Class ControlSelectionVisitor

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<IControlSelectionState,Boolean>

gov.nist.secauto.oscal.lib.profile.resolver.selection.ControlSelectionVisitor

All Implemented Interfaces:

ICatalogVisitor<IControlSelectionState,Boolean>

public class ControlSelectionVisitor
extends AbstractIndexingVisitor<IControlSelectionState,Boolean>

Walks a Catalog indexing all nodes that can be referenced.

For each CatalogGroup, Control, and ControlPart, determine if that object is IIndexer.SelectionStatus.SELECTED or IIndexer.SelectionStatus.UNSELECTED.

A Control is IIndexer.SelectionStatus.SELECTED if it matches the configured IControlFilter, otherwise it is IIndexer.SelectionStatus.UNSELECTED.

A CatalogGroup is IIndexer.SelectionStatus.SELECTED if it contains a IIndexer.SelectionStatus.SELECTED descendant Control, otherwise it is IIndexer.SelectionStatus.UNSELECTED.

A ControlPart is IIndexer.SelectionStatus.SELECTED if its containing control is IIndexer.SelectionStatus.SELECTED.

All other indexed nodes will have the IIndexer.SelectionStatus.UNKNOWN, since these nodes require reference counting to determine if they are to be kept or not.

Field Summary

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

CHILD_PART_METAPATH

Constructor Summary

Constructors

Constructor	Description
ControlSelectionVisitor()

Method Summary

Modifier and Type	Method	Description
protected Boolean	aggregateResults(Boolean first, Boolean second, IControlSelectionState state)
protected IIndexer	getIndexer(IControlSelectionState state)
static ControlSelectionVisitor	instance()
protected Boolean	newDefaultResult(IControlSelectionState state)
void	visit(gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem catalogDocument, IControlSelectionState state)
Boolean	visitCatalog(gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem catalogDocument, IControlSelectionState state)
Boolean	visitControl(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem controlItem, Boolean childResult, IControlSelectionState state)	Called when visiting a control.
Boolean	visitGroup(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem groupItem, Boolean childSelected, IControlSelectionState state)	Called when visiting a group.
void	visitProfile(gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem catalogDocument, gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem profileDocument, IControlSelectionState state)

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

visitLocation, visitParameter, visitPart, visitParty, visitResource, visitRole

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

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

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

visitControlItem, visitGroupItem

Methods inherited from class java.lang.Object

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

Constructor Detail

ControlSelectionVisitor

public ControlSelectionVisitor()

Method Detail

instance

public static ControlSelectionVisitor instance()

getIndexer

protected IIndexer getIndexer(IControlSelectionState state)

Specified by:

getIndexer in class AbstractIndexingVisitor<IControlSelectionState,Boolean>

newDefaultResult

protected Boolean newDefaultResult(IControlSelectionState state)

Specified by:

newDefaultResult in class AbstractCatalogVisitor<IControlSelectionState,Boolean>

aggregateResults

protected Boolean aggregateResults(Boolean first,
                                   Boolean second,
                                   IControlSelectionState state)

Specified by:

aggregateResults in class AbstractCatalogVisitor<IControlSelectionState,Boolean>

visit

public void visit(@NonNull
                  gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem catalogDocument,
                  @NonNull
                  IControlSelectionState state)

visitProfile

public void visitProfile(@NonNull
                         gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem catalogDocument,
                         @NonNull
                         gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem profileDocument,
                         @NonNull
                         IControlSelectionState state)

visitCatalog

public Boolean visitCatalog(gov.nist.secauto.metaschema.model.common.metapath.item.IDocumentNodeItem catalogDocument,
                            IControlSelectionState state)

Overrides:

visitCatalog in class AbstractCatalogEntityVisitor<IControlSelectionState,Boolean>

visitGroup

public Boolean visitGroup(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem groupItem,
                          Boolean childSelected,
                          IControlSelectionState 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.

Specified by:

visitGroup in interface ICatalogVisitor<IControlSelectionState,Boolean>

Overrides:

visitGroup in class AbstractIndexingVisitor<IControlSelectionState,Boolean>

Parameters:

groupItem - the Metapath item for the group

childSelected - the result of evaluating the group's children

state - the calling context information

Returns:

a meaningful result of the given type

visitControl

public Boolean visitControl(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem controlItem,
                            Boolean childResult,
                            IControlSelectionState 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.

Specified by:

visitControl in interface ICatalogVisitor<IControlSelectionState,Boolean>

Overrides:

visitControl in class AbstractIndexingVisitor<IControlSelectionState,Boolean>

Parameters:

controlItem - 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