Package gov.nist.secauto.decima.core.assessment.util

Class AssessmentSequence<DOC extends Document>

java.lang.Object

gov.nist.secauto.decima.core.assessment.util.AssessmentSequence<DOC>

Type Parameters:

DOC - the type of document that is the target of the assessment

All Implemented Interfaces:

Assessment<DOC>

public class AssessmentSequence<DOC extends Document>
extends Object
implements Assessment<DOC>

This class provides support for a list of assessments that get evaluated in a series.

Constructor Summary

Constructors

Constructor	Description
AssessmentSequence(List<? extends Assessment<DOC>> assessments)

Method Summary

Modifier and Type	Method	Description
void	execute(DOC targetDocument, AssessmentResultBuilder builder)	Executes the assessment, which then generates input into a AssessmentResults using the provided AssessmentResultBuilder.
List<Assessment<DOC>>	getAssessments()
String	getAssessmentType()	Returns a stable identifier indicating the type of assessment being performed.
List<Assessment<DOC>>	getExecutableAssessments(DOC targetDocument)
String	getName(boolean includeDetail)	Retrieves a human-readable label for the assessment.

Methods inherited from class java.lang.Object

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

Constructor Detail

AssessmentSequence

public AssessmentSequence(List<? extends Assessment<DOC>> assessments)

Method Detail

getAssessmentType

public String getAssessmentType()

Description copied from interface: Assessment

Returns a stable identifier indicating the type of assessment being performed.

Specified by:

getAssessmentType in interface Assessment<DOC extends Document>

Returns:

an identifier

getAssessments

public List<Assessment<DOC>> getAssessments()

getExecutableAssessments

public List<Assessment<DOC>> getExecutableAssessments(DOC targetDocument)
                                               throws AssessmentException

Specified by:

getExecutableAssessments in interface Assessment<DOC extends Document>

Throws:

AssessmentException

execute

public void execute(DOC targetDocument,
                    AssessmentResultBuilder builder)
             throws AssessmentException

Description copied from interface: Assessment

Executes the assessment, which then generates input into a AssessmentResults using the provided AssessmentResultBuilder.

Specified by:

execute in interface Assessment<DOC extends Document>

Parameters:

targetDocument - the XML document to assess

builder - the AssessmentResultBuilder used to eventually generate a AssessmentResults once all assessments have been performed

Throws:

AssessmentException - if an error occurs while performing the assessment

getName

public String getName(boolean includeDetail)

Description copied from interface: Assessment

Retrieves a human-readable label for the assessment.

Specified by:

getName in interface Assessment<DOC extends Document>

Parameters:

includeDetail - if true, include identifying details

Returns:

a human-readable label for the assessment.