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

Class LinkReferencePolicy

java.lang.Object

gov.nist.secauto.oscal.lib.profile.resolver.policy.AbstractCustomReferencePolicy<TYPE>

gov.nist.secauto.oscal.lib.profile.resolver.policy.AbstractMultiItemTypeReferencePolicy<Link>

gov.nist.secauto.oscal.lib.profile.resolver.policy.LinkReferencePolicy

All Implemented Interfaces:

ICustomReferencePolicy<Link>, IReferencePolicy<Link>

public class LinkReferencePolicy
extends AbstractMultiItemTypeReferencePolicy<Link>

Field Summary

Fields inherited from interface gov.nist.secauto.oscal.lib.profile.resolver.policy.IReferencePolicy

IGNORE_POLICY

Constructor Summary

Constructors

Constructor	Description
LinkReferencePolicy(List<IEntityItem.ItemType> itemTypes)

Method Summary

Modifier and Type	Method	Description
static LinkReferencePolicy	create(IEntityItem.ItemType itemType)
static LinkReferencePolicy	create(List<IEntityItem.ItemType> itemTypes)
String	getReferenceText(Link link)	Retrieve the reference text from the reference object.
protected boolean	handleIdentifierNonMatch(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem, Link reference, ReferenceCountingVisitor.Context visitorContext)	Handle the case where the identifier was not a syntax match for an expected identifier.
protected boolean	handleIndexMiss(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem, Link link, List<IEntityItem.ItemType> itemTypes, String identifier, ReferenceCountingVisitor.Context visitorContext)	Handle an index miss for a reference.
protected void	handleUnselected(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem, Link link, IEntityItem item, ReferenceCountingVisitor.Context visitorContext)	Handle an index hit against an item related to an unselected control.
void	setReferenceText(Link link, String newValue)	Update the reference text used in the reference object.

Methods inherited from class gov.nist.secauto.oscal.lib.profile.resolver.policy.AbstractMultiItemTypeReferencePolicy

getEntityItemTypes

Methods inherited from class gov.nist.secauto.oscal.lib.profile.resolver.policy.AbstractCustomReferencePolicy

getIdentifierParser, handleIdentifier, handleIndexHit, handleReference, handleSelected

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkReferencePolicy

public LinkReferencePolicy(@NonNull
                           List<IEntityItem.ItemType> itemTypes)

Method Detail

create

@NonNull
public static LinkReferencePolicy create(@NonNull
                                         IEntityItem.ItemType itemType)

create

@NonNull
public static LinkReferencePolicy create(@NonNull
                                         List<IEntityItem.ItemType> itemTypes)

getReferenceText

public String getReferenceText(@NonNull
                               Link link)

Description copied from interface: ICustomReferencePolicy

Retrieve the reference text from the reference object.

Parameters:

link - the reference object

Returns:

the reference text or null if there is no text

setReferenceText

public void setReferenceText(@NonNull
                             Link link,
                             @NonNull
                             String newValue)

Description copied from interface: ICustomReferencePolicy

Update the reference text used in the reference object.

Parameters:

link - the reference object

newValue - the reference text replacement

handleUnselected

protected void handleUnselected(@NonNull
                                gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem,
                                @NonNull
                                Link link,
                                @NonNull
                                IEntityItem item,
                                @NonNull
                                ReferenceCountingVisitor.Context visitorContext)

Description copied from class: AbstractCustomReferencePolicy

Handle an index hit against an item related to an unselected control.

Subclasses can override this method to perform extra processing.

Overrides:

handleUnselected in class AbstractCustomReferencePolicy<Link>

Parameters:

contextItem - the node containing the identifier reference

link - the identifier reference object generating the hit

item - the referenced item

visitorContext - the reference visitor, which can be used for further processing

handleIndexMiss

protected boolean handleIndexMiss(@NonNull
                                  gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem,
                                  @NonNull
                                  Link link,
                                  @NonNull
                                  List<IEntityItem.ItemType> itemTypes,
                                  @NonNull
                                  String identifier,
                                  @NonNull
                                  ReferenceCountingVisitor.Context visitorContext)

Description copied from class: AbstractCustomReferencePolicy

Handle an index miss for a reference. This occurs when the referenced item was not found in the index.

Subclasses can override this method to perform extra processing.

Overrides:

handleIndexMiss in class AbstractCustomReferencePolicy<Link>

Parameters:

contextItem - the node containing the identifier reference

link - the identifier reference object generating the hit

itemTypes - the possible item types for this reference

identifier - the parsed identifier

visitorContext - the reference visitor state, which can be used for further processing

Returns:

true if the reference is handled by this method or false otherwise

handleIdentifierNonMatch

protected boolean handleIdentifierNonMatch(@NonNull
                                           gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem,
                                           @NonNull
                                           Link reference,
                                           @NonNull
                                           ReferenceCountingVisitor.Context visitorContext)

Description copied from class: AbstractCustomReferencePolicy

Handle the case where the identifier was not a syntax match for an expected identifier. This can occur when the reference is malformed, using an unrecognized syntax.

Subclasses can override this method to perform extra processing.

Overrides:

handleIdentifierNonMatch in class AbstractCustomReferencePolicy<Link>

Parameters:

contextItem - the node containing the identifier reference

reference - the identifier reference object generating the hit

visitorContext - the reference visitor state, which can be used for further processing

Returns:

true if the reference is handled by this method or false otherwise