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

Class AbstractAssessment<DOC extends Document>

java.lang.Object

gov.nist.secauto.decima.core.assessment.AbstractAssessment<DOC>

Type Parameters:

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

All Implemented Interfaces:

Assessment<DOC>

Direct Known Subclasses:

AbstractLogicAssessment, SchemaAssessment, SchematronAssessment

public abstract class AbstractAssessment<DOC extends Document>
extends Object
implements Assessment<DOC>

Provides basic functions common to all Assessment implementations. A concrete implementations of this class must provide implementations of the executeInternal(Document, AssessmentResultBuilder) and getNameDetails() methods to provide evaluation logic and descriptive label information respectively. Implementations of this class are expected to be thread safe when the executeInternal(Document, AssessmentResultBuilder) method is invoked from different calling contexts.

Constructor Summary

Constructors

Constructor	Description
AbstractAssessment()

Method Summary

Modifier and Type	Method	Description
void	execute(DOC document, AssessmentResultBuilder builder)	If a result directory has been provided by calling setResultDirectory(File), this method ensures that that directory exists before calling executeInternal(Document, AssessmentResultBuilder).
protected abstract void	executeInternal(DOC document, AssessmentResultBuilder builder)	Implementations of this method will conduct an assessment over the provided target document, writing any results to the provided AssessmentResultBuilder.
List<Assessment<DOC>>	getExecutableAssessments(DOC document)
int	getId()
String	getName(boolean includeDetail)	Retrieves a human-readable label for the assessment.
protected abstract String	getNameDetails()	Retrieves basic naming details used to build a human-readable label for the assessment.
protected static int	getNextId()
File	getResultDirectory()	Retrieves the result directory set using the setResultDirectory(File) method.
void	setResultDirectory(File resultDirectory)	Sets an output directory to write assessment artifacts to.

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.decima.core.assessment.Assessment

getAssessmentType

Constructor Detail

AbstractAssessment

public AbstractAssessment()

Method Detail

getNextId

protected static int getNextId()

getId

public int getId()

getResultDirectory

public File getResultDirectory()

Retrieves the result directory set using the setResultDirectory(File) method.

Returns:

the set result directory or null otherwise

setResultDirectory

public void setResultDirectory(File resultDirectory)

Sets an output directory to write assessment artifacts to. An assessment is not required to create (and write) assessment artifacts. If there is a need to write artifacts and a directory is provided, the assessment must write these artifacts under the provided directory. Calls to File.createTempFile(String, String, File) (or an equivalent method) may be used if the last argument is passed using the provided directory. If no directory is provided using this method, then the assessment may create temporary files instead by calling File.createTempFile(String, String) or an equivalent method.

Parameters:

resultDirectory - if not null, the directory to write assessment artifacts to

getExecutableAssessments

public final List<Assessment<DOC>> getExecutableAssessments(DOC document)

Specified by:

getExecutableAssessments in interface Assessment<DOC extends Document>

execute

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

If a result directory has been provided by calling setResultDirectory(File), this method ensures that that directory exists before calling executeInternal(Document, AssessmentResultBuilder).

Specified by:

execute in interface Assessment<DOC extends Document>

Parameters:

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

executeInternal

protected abstract void executeInternal(DOC document,
                                        AssessmentResultBuilder builder)
                                 throws AssessmentException

Implementations of this method will conduct an assessment over the provided target document, writing any results to the provided AssessmentResultBuilder.

Parameters:

document - the target 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.

getNameDetails

protected abstract String getNameDetails()

Retrieves basic naming details used to build a human-readable label for the assessment.

Returns:

the details or null if none exist