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

Class BasicIndexer

java.lang.Object

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

All Implemented Interfaces:

IIndexer

Direct Known Subclasses:

ReassignmentIndexer

public class BasicIndexer
extends Object
implements IIndexer

Nested Class Summary

Nested classes/interfaces inherited from interface gov.nist.secauto.oscal.lib.profile.resolver.support.IIndexer

IIndexer.SelectionStatus

Field Summary

Fields inherited from interface gov.nist.secauto.oscal.lib.profile.resolver.support.IIndexer

HAS_PROP_KEEP_METAPATH, KEEP_ENTITY_PREDICATE

Constructor Summary

Constructors

Constructor	Description
BasicIndexer()
BasicIndexer(IIndexer other)

Method Summary

Modifier and Type	Method	Description
IEntityItem	addControl(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
IEntityItem	addGroup(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
protected IEntityItem	addItem(gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractEntityItem.Builder builder)
protected IEntityItem	addItem(IEntityItem item)
IEntityItem	addLocation(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
IEntityItem	addParameter(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
IEntityItem	addPart(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
IEntityItem	addParty(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
IEntityItem	addResource(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
IEntityItem	addRole(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)
void	append(IIndexer other)
Map<IEntityItem.ItemType,Map<String,IEntityItem>>	getEntities()	Get a copy of the entity map.
Collection<IEntityItem>	getEntitiesByItemType(IEntityItem.ItemType itemType)
IEntityItem	getEntity(IEntityItem.ItemType itemType, String identifier, boolean normalize)	Lookup an item of the given itemType having the given identifier.
IIndexer.SelectionStatus	getSelectionStatus(gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem item)
Map<gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem,IIndexer.SelectionStatus>	getSelectionStatusMap()
boolean	isSelected(IEntityItem entity)
protected gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractEntityItem.Builder	newBuilder(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item, IEntityItem.ItemType itemType, String identifier)	Create a new builder with the provided info.
protected gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractEntityItem.Builder	newBuilder(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item, IEntityItem.ItemType itemType, UUID identifier)
String	normalizeIdentifier(String identifier)	Lower case UUID-based identifiers and leave others unmodified.
boolean	removeItem(IEntityItem entity)
void	resetSelectionStatus()
void	setSelectionStatus(gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem item, IIndexer.SelectionStatus selectionStatus)

Methods inherited from class java.lang.Object

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

Methods inherited from interface gov.nist.secauto.oscal.lib.profile.resolver.support.IIndexer

getEntity, getEntity

Constructor Detail

BasicIndexer

public BasicIndexer()

BasicIndexer

public BasicIndexer(IIndexer other)

Method Detail

append

public void append(@NonNull
                   IIndexer other)

Specified by:

append in interface IIndexer

setSelectionStatus

public void setSelectionStatus(@NonNull
                               gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem item,
                               @NonNull
                               IIndexer.SelectionStatus selectionStatus)

Specified by:

setSelectionStatus in interface IIndexer

getSelectionStatusMap

public Map<gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem,IIndexer.SelectionStatus> getSelectionStatusMap()

Specified by:

getSelectionStatusMap in interface IIndexer

getSelectionStatus

public IIndexer.SelectionStatus getSelectionStatus(@NonNull
                                                   gov.nist.secauto.metaschema.model.common.metapath.item.INodeItem item)

Specified by:

getSelectionStatus in interface IIndexer

resetSelectionStatus

public void resetSelectionStatus()

Specified by:

resetSelectionStatus in interface IIndexer

isSelected

public boolean isSelected(@NonNull
                          IEntityItem entity)

Specified by:

isSelected in interface IIndexer

getEntities

public Map<IEntityItem.ItemType,Map<String,IEntityItem>> getEntities()

Description copied from interface: IIndexer

Get a copy of the entity map.

Specified by:

getEntities in interface IIndexer

Returns:

the copy

getEntitiesByItemType

@NonNull
public Collection<IEntityItem> getEntitiesByItemType(@NonNull
                                                     IEntityItem.ItemType itemType)

Specified by:

getEntitiesByItemType in interface IIndexer

getEntity

public IEntityItem getEntity(@NonNull
                             IEntityItem.ItemType itemType,
                             @NonNull
                             String identifier,
                             boolean normalize)

Description copied from interface: IIndexer

Lookup an item of the given itemType having the given identifier.

Will normalize the case of a UUID-based the identifier when requested.

Specified by:

getEntity in interface IIndexer

Parameters:

itemType - the type of item to search for

identifier - the identifier to lookup

normalize - true if the identifier case should be normalized or false otherwise

Returns:

the matching item or null if no match was found

addItem

protected IEntityItem addItem(@NonNull
                              IEntityItem item)

addItem

@NonNull
protected IEntityItem addItem(@NonNull
                              gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractEntityItem.Builder builder)

removeItem

public boolean removeItem(@NonNull
                          IEntityItem entity)

Specified by:

removeItem in interface IIndexer

addRole

public IEntityItem addRole(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addRole in interface IIndexer

addLocation

public IEntityItem addLocation(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addLocation in interface IIndexer

addParty

public IEntityItem addParty(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addParty in interface IIndexer

addGroup

public IEntityItem addGroup(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addGroup in interface IIndexer

addControl

public IEntityItem addControl(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addControl in interface IIndexer

addParameter

public IEntityItem addParameter(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addParameter in interface IIndexer

addPart

public IEntityItem addPart(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addPart in interface IIndexer

addResource

public IEntityItem addResource(gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item)

Specified by:

addResource in interface IIndexer

newBuilder

@NonNull
protected final gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractEntityItem.Builder newBuilder(@NonNull
                                                                                                          gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item,
                                                                                                          @NonNull
                                                                                                          IEntityItem.ItemType itemType,
                                                                                                          @NonNull
                                                                                                          UUID identifier)

newBuilder

@NonNull
protected gov.nist.secauto.oscal.lib.profile.resolver.support.AbstractEntityItem.Builder newBuilder(@NonNull
                                                                                                    gov.nist.secauto.metaschema.model.common.metapath.item.IRequiredValueModelNodeItem item,
                                                                                                    @NonNull
                                                                                                    IEntityItem.ItemType itemType,
                                                                                                    @NonNull
                                                                                                    String identifier)

Create a new builder with the provided info.

This method can be overloaded to support applying additional data to the returned builder.

When working with identifiers that are case insensitve, it is important to ensure that the identifiers are normalized to lower case.

Parameters:

item - the Metapath node to associate with the entity

itemType - the type of entity

identifier - the entity's identifier

Returns:

the entity builder

normalizeIdentifier

@NonNull
public String normalizeIdentifier(@NonNull
                                  String identifier)

Lower case UUID-based identifiers and leave others unmodified.

Parameters:

identifier - the identifier

Returns:

the resulting normalized identifier