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

Class PropertyReferencePolicy

java.lang.Object

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

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

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

All Implemented Interfaces:

ICustomReferencePolicy<Property>, IReferencePolicy<Property>

public class PropertyReferencePolicy
extends AbstractMultiItemTypeReferencePolicy<Property>

Field Summary

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

IGNORE_POLICY

Constructor Summary

Constructors

Constructor	Description
PropertyReferencePolicy(IIdentifierParser identifierParser, List<IEntityItem.ItemType> itemTypes)

Method Summary

Modifier and Type	Method	Description
static PropertyReferencePolicy	create(IIdentifierParser identifierParser, IEntityItem.ItemType itemType)
static PropertyReferencePolicy	create(IIdentifierParser identifierParser, List<IEntityItem.ItemType> itemTypes)
String	getReferenceText(Property property)	Retrieve the reference text from the reference object.
protected boolean	handleIndexMiss(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem, Property property, 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, Property property, IEntityItem item, ReferenceCountingVisitor.Context visitorContext)	Handle an index hit against an item related to an unselected control.
void	setReferenceText(Property property, 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, handleIdentifierNonMatch, handleIndexHit, handleReference, handleSelected

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyReferencePolicy

public PropertyReferencePolicy(@NonNull
                               IIdentifierParser identifierParser,
                               @NonNull
                               List<IEntityItem.ItemType> itemTypes)

Method Detail

create

@NonNull
public static PropertyReferencePolicy create(@NonNull
                                             IIdentifierParser identifierParser,
                                             @NonNull
                                             IEntityItem.ItemType itemType)

create

@NonNull
public static PropertyReferencePolicy create(@NonNull
                                             IIdentifierParser identifierParser,
                                             @NonNull
                                             List<IEntityItem.ItemType> itemTypes)

getReferenceText

public String getReferenceText(@NonNull
                               Property property)

Description copied from interface: ICustomReferencePolicy

Retrieve the reference text from the reference object.

Parameters:

property - the reference object

Returns:

the reference text or null if there is no text

setReferenceText

public void setReferenceText(@NonNull
                             Property property,
                             @NonNull
                             String newValue)

Description copied from interface: ICustomReferencePolicy

Update the reference text used in the reference object.

Parameters:

property - the reference object

newValue - the reference text replacement

handleUnselected

protected void handleUnselected(@NonNull
                                gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem contextItem,
                                @NonNull
                                Property property,
                                @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<Property>

Parameters:

contextItem - the node containing the identifier reference

property - 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
                                  Property property,
                                  @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<Property>

Parameters:

contextItem - the node containing the identifier reference

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