eu.cqse.check.framework.core.phase

Interface IGlobalExtractionPhase<T extends IExtractedValue<D>,D extends java.io.Serializable>

public interface IGlobalExtractionPhase<T extends IExtractedValue<D>,D extends java.io.Serializable>

A global extraction phase allows to provide global information to a custom check. The phase is executed before the first run of the check.

Method Summary

Modifier and Type	Method and Description
T	createValue(java.lang.String uniformPath, java.lang.String value, D additionalInformation) Factory method for creating a value from the given parts.
java.util.List<T>	extract(ITokenElementContext fileContext) Extracts the values from a single file described by the context.
java.util.EnumSet<ELanguage>	getLanguages() The languages for which the phase is applicable.
java.util.EnumSet<ECheckParameter>	getRequiredContextParameters() The context parameters required by this check phase.
default boolean	needsAccessUniformPathByValue() If this returns true, an inverted index that allows access by extracted value will be constructed as well.

Method Detail

extract

java.util.List<T> extract(ITokenElementContext fileContext)
                   throws CheckException

Extracts the values from a single file described by the context.

Throws:

CheckException

createValue

T createValue(java.lang.String uniformPath,
              java.lang.String value,
              D additionalInformation)

Factory method for creating a value from the given parts.

needsAccessUniformPathByValue

default boolean needsAccessUniformPathByValue()

If this returns true, an inverted index that allows access by extracted value will be constructed as well.

getLanguages

java.util.EnumSet<ELanguage> getLanguages()

The languages for which the phase is applicable.

getRequiredContextParameters

java.util.EnumSet<ECheckParameter> getRequiredContextParameters()

The context parameters required by this check phase. This is used to determine which context elements need to be initialized, not to filter elements. That means if you specify ECheckParameter.ABSTRACT_SYNTAX_TREE here and getLanguages() returns a language for which we don't have a shallow parser (e.g., ELanguage.XML), this will result in errors.