Package org.drools.compiler.builder.impl

Class KnowledgeBuilderImpl

java.lang.Object

org.drools.compiler.builder.impl.KnowledgeBuilderImpl

All Implemented Interfaces:

DroolsAssemblerContext, BuilderConfigurationProvider, BuildResultCollector, GlobalVariableContext, InternalKnowledgeBaseProvider, RootClassLoaderProvider, TypeDeclarationContext, TypeDeclarationManager, InternalKnowledgeBuilder, PackageRegistryManager, AssemblerContext, KnowledgeBuilder, ProcessBuilder, RuleBuilder

public class KnowledgeBuilderImpl
extends Object
implements InternalKnowledgeBuilder, TypeDeclarationContext, BuildResultCollector, GlobalVariableContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KnowledgeBuilderImpl.ForkJoinPoolHolder

Nested classes/interfaces inherited from interface org.drools.compiler.builder.InternalKnowledgeBuilder

InternalKnowledgeBuilder.Empty, InternalKnowledgeBuilder.ResourceRemovalResult

Field Summary

Fields

Modifier and Type	Field	Description
protected static final org.slf4j.Logger	logger

Constructor Summary

Constructors

Constructor	Description
KnowledgeBuilderImpl()	Use this when package is starting from scratch.
KnowledgeBuilderImpl(InternalKnowledgePackage pkg)	This will allow you to merge rules into this pre existing package.
KnowledgeBuilderImpl(InternalKnowledgePackage pkg, KnowledgeBuilderConfiguration configuration)
KnowledgeBuilderImpl(InternalKnowledgeBase kBase)
KnowledgeBuilderImpl(InternalKnowledgeBase kBase, KnowledgeBuilderConfiguration configuration)
KnowledgeBuilderImpl(KnowledgeBuilderConfiguration configuration)	Pass a specific configuration for the PackageBuilder

Method Summary

Modifier and Type	Method	Description
void	add(Resource resource, ResourceType type)
void	add(Resource resource, ResourceType type, ResourceConfiguration configuration)
void	addBuilderResult(KnowledgeBuilderResult result)
void	addDsl(Resource resource)
void	addGlobal(String name, Type type)
void	addKnowledgeResource(Resource resource, ResourceType type, ResourceConfiguration configuration)
void	addPackage(InternalKnowledgePackage newPkg)
final void	addPackage(PackageDescr packageDescr)	Adds a package from a Descr/AST also triggering its compilation and the generation of the corresponding rete/phreak network
void	addPackageFromDrl(Reader reader)	Load a rule package from DRL source.
void	addPackageFromDrl(Reader reader, Resource sourceResource)	Load a rule package from DRL source and associate all loaded artifacts with the given resource.
protected void	addPackageWithResource(PackageDescr packageDescr, Resource resource)
void	addProcessFromXml(Reader processSource)	Deprecated.
void	addProcessFromXml(Resource resource)	Deprecated.
void	addRuleFlow(Reader processSource)	Add a ruleflow (.rfm) asset to this package.
CompositeKnowledgeBuilder	batch()
final void	buildPackages(Collection<CompositePackageDescr> packages)
void	buildPackagesWithoutRules(Collection<CompositePackageDescr> packages)
void	compileAll()
<T extends ResourceTypePackage<?>> T	computeIfAbsent(ResourceType resourceType, String namespace, Function<? super ResourceType,T> mappingFunction)
protected BuildContext	createBuildContext()
static File	createDumpDrlFile(File dumpDir, String fileName, String extension)
protected void	doFirstBuildStep(Collection<CompositePackageDescr> packages)	Performs the actual building of rules, but may be empty in subclasses
protected void	doSecondBuildStep(Collection<CompositePackageDescr> packages)	Used by subclasses that need to perform the build after the assemblers
boolean	filterAccepts(ResourceChange.Type type, String namespace, String name)
TypeDeclaration	getAndRegisterTypeDeclaration(Class<?> cls, String packageName)
protected AssetFilter	getAssetFilter()
BuildContext	getBuildContext()
KnowledgeBuilderConfigurationImpl	getBuilderConfiguration()	Return the PackageBuilderConfiguration for this PackageBuilder session
protected BuildResultCollector	getBuildResultCollector()
<T> T	getCachedOrCreate(String key, Supplier<T> creator)
DefaultExpander	getDslExpander()	Returns an expander for DSLs (only if there is a DSL configured for this package).
PackageBuilderErrors	getErrors()
Map<String,Type>	getGlobals()
protected GlobalVariableContext	getGlobalVariableContext()
InternalKnowledgeBase	getKnowledgeBase()
Collection<KiePackage>	getKnowledgePackages()
PackageRegistry	getOrCreatePackageRegistry(PackageDescr packageDescr)
InternalKnowledgePackage	getPackage(String name)
List<PackageDescr>	getPackageDescrs(String packageName)
Collection<String>	getPackageNames()
Map<String,PackageRegistry>	getPackageRegistry()
PackageRegistry	getPackageRegistry(String name)
protected PackageRegistryManager	getPackageRegistryManager()
InternalKnowledgePackage[]	getPackages()
ProcessBuilder	getProcessBuilder()
ReleaseId	getReleaseId()
KnowledgeBuilderResults	getResults(ResultSeverity... problemTypes)	Return the knowledge builder results for the listed severities.
ClassLoader	getRootClassLoader()
TypeDeclarationBuilder	getTypeBuilder()
TypeDeclaration	getTypeDeclaration(Class<?> cls)
TypeDeclaration	getTypeDeclaration(ObjectType objectType)
List<DroolsWarning>	getWarnings()
boolean	hasErrors()	This will return true if there were errors in the package building and compiling phase
boolean	hasInfo()
boolean	hasResults(ResultSeverity... problemTypes)
boolean	hasWarnings()
KieBase	newKieBase()
KieBase	newKnowledgeBase(KieBaseConfiguration conf)
protected void	processKieBaseTypes()
void	registerBuildResource(Resource resource, ResourceType type)
void	registerBuildResources(List<Resource> resources)
void	registerPackage(PackageDescr packageDescr)
void	reloadAll()
InternalKnowledgeBuilder.ResourceRemovalResult	removeObjectsGeneratedFromResource(Resource resource)
void	reportError(KnowledgeBuilderError error)
void	resetErrors()	Reset the error list.
void	resetProblems()
void	resetWarnings()
void	rewireAllClassObjectTypes()
void	setAssetFilter(AssetFilter assetFilter)
void	setBuildContext(BuildContext buildContext)
void	setReleaseId(ReleaseId releaseId)
void	undo()
void	updateResults()
void	updateResults(List<KnowledgeBuilderResult> results)
protected void	wireAllRules()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.compiler.builder.impl.BuildResultCollector

add, addAll, getAllResults

Field Details

logger

protected static final transient org.slf4j.Logger logger

Constructor Details

KnowledgeBuilderImpl

public KnowledgeBuilderImpl()

Use this when package is starting from scratch.

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(InternalKnowledgePackage pkg)

This will allow you to merge rules into this pre existing package.

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(InternalKnowledgeBase kBase)

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(InternalKnowledgeBase kBase,
 KnowledgeBuilderConfiguration configuration)

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(KnowledgeBuilderConfiguration configuration)

Pass a specific configuration for the PackageBuilder

PackageBuilderConfiguration is not thread safe and it also contains state. Once it is created and used in one or more PackageBuilders it should be considered immutable. Do not modify its properties while it is being used by a PackageBuilder.

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(InternalKnowledgePackage pkg,
 KnowledgeBuilderConfiguration configuration)

Method Details

getReleaseId

public ReleaseId getReleaseId()

setReleaseId

public void setReleaseId(ReleaseId releaseId)

getBuildContext

public BuildContext getBuildContext()

createBuildContext

protected BuildContext createBuildContext()

setBuildContext

public void setBuildContext(BuildContext buildContext)

getKnowledgeBase

public InternalKnowledgeBase getKnowledgeBase()

Specified by:

getKnowledgeBase in interface InternalKnowledgeBaseProvider

getTypeBuilder

public TypeDeclarationBuilder getTypeBuilder()

Specified by:

getTypeBuilder in interface TypeDeclarationContext

addPackageFromDrl

public void addPackageFromDrl(Reader reader)
                       throws DroolsParserException,
IOException

Load a rule package from DRL source.

Throws:

DroolsParserException

IOException

addPackageFromDrl

public void addPackageFromDrl(Reader reader,
 Resource sourceResource)
                       throws DroolsParserException,
IOException

Load a rule package from DRL source and associate all loaded artifacts with the given resource.

Parameters:

reader -

sourceResource - the source resource for the read artifacts

Throws:

DroolsParserException

IOException

createDumpDrlFile

public static File createDumpDrlFile(File dumpDir,
 String fileName,
 String extension)

addDsl

public void addDsl(Resource resource)
            throws IOException

Throws:

IOException

addRuleFlow

public void addRuleFlow(Reader processSource)

Add a ruleflow (.rfm) asset to this package.

addProcessFromXml

@Deprecated
public void addProcessFromXml(Resource resource)

Deprecated.

getProcessBuilder

public ProcessBuilder getProcessBuilder()

addProcessFromXml

@Deprecated
public void addProcessFromXml(Reader processSource)

Deprecated.

addKnowledgeResource

public void addKnowledgeResource(Resource resource,
 ResourceType type,
 ResourceConfiguration configuration)

addPackage

public final void addPackage(PackageDescr packageDescr)

Adds a package from a Descr/AST also triggering its compilation and the generation of the corresponding rete/phreak network

Specified by:

addPackage in interface InternalKnowledgeBuilder

addPackageWithResource

protected void addPackageWithResource(PackageDescr packageDescr,
 Resource resource)

wireAllRules

protected void wireAllRules()

processKieBaseTypes

protected void processKieBaseTypes()

addBuilderResult

public void addBuilderResult(KnowledgeBuilderResult result)

Specified by:

addBuilderResult in interface BuildResultCollector

getBuildResultCollector

protected BuildResultCollector getBuildResultCollector()

computeIfAbsent

public <T extends ResourceTypePackage<?>> T computeIfAbsent(ResourceType resourceType,
 String namespace,
 Function<? super ResourceType,T> mappingFunction)

Specified by:

computeIfAbsent in interface AssemblerContext

getOrCreatePackageRegistry

public PackageRegistry getOrCreatePackageRegistry(PackageDescr packageDescr)

Specified by:

getOrCreatePackageRegistry in interface PackageRegistryManager

registerPackage

public void registerPackage(PackageDescr packageDescr)

getPackageRegistryManager

protected PackageRegistryManager getPackageRegistryManager()

filterAccepts

public boolean filterAccepts(ResourceChange.Type type,
 String namespace,
 String name)

Specified by:

filterAccepts in interface TypeDeclarationContext

updateResults

public void updateResults()

updateResults

public void updateResults(List<KnowledgeBuilderResult> results)

compileAll

public void compileAll()

reloadAll

public void reloadAll()

addPackage

public void addPackage(InternalKnowledgePackage newPkg)

getAndRegisterTypeDeclaration

public TypeDeclaration getAndRegisterTypeDeclaration(Class<?> cls,
 String packageName)

Specified by:

getAndRegisterTypeDeclaration in interface DroolsAssemblerContext

Specified by:

getAndRegisterTypeDeclaration in interface TypeDeclarationManager

getPackages

public InternalKnowledgePackage[] getPackages()

getBuilderConfiguration

public KnowledgeBuilderConfigurationImpl getBuilderConfiguration()

Return the PackageBuilderConfiguration for this PackageBuilder session

Specified by:

getBuilderConfiguration in interface BuilderConfigurationProvider

Returns:

The PackageBuilderConfiguration

getPackageRegistry

public PackageRegistry getPackageRegistry(String name)

Specified by:

getPackageRegistry in interface DroolsAssemblerContext

Specified by:

getPackageRegistry in interface PackageRegistryManager

getPackage

public InternalKnowledgePackage getPackage(String name)

Specified by:

getPackage in interface InternalKnowledgeBuilder

getPackageRegistry

public Map<String,PackageRegistry> getPackageRegistry()

Specified by:

getPackageRegistry in interface PackageRegistryManager

getPackageNames

public Collection<String> getPackageNames()

Specified by:

getPackageNames in interface PackageRegistryManager

getPackageDescrs

public List<PackageDescr> getPackageDescrs(String packageName)

Specified by:

getPackageDescrs in interface DroolsAssemblerContext

Specified by:

getPackageDescrs in interface TypeDeclarationContext

getDslExpander

public DefaultExpander getDslExpander()

Returns an expander for DSLs (only if there is a DSL configured for this package).

getGlobals

public Map<String,Type> getGlobals()

Specified by:

getGlobals in interface DroolsAssemblerContext

Specified by:

getGlobals in interface GlobalVariableContext

addGlobal

public void addGlobal(String name,
 Type type)

Specified by:

addGlobal in interface GlobalVariableContext

getGlobalVariableContext

protected GlobalVariableContext getGlobalVariableContext()

hasErrors

public boolean hasErrors()

This will return true if there were errors in the package building and compiling phase

Specified by:

hasErrors in interface BuildResultCollector

Specified by:

hasErrors in interface KnowledgeBuilder

getResults

public KnowledgeBuilderResults getResults(ResultSeverity... problemTypes)

Description copied from interface: BuildResultCollector

Return the knowledge builder results for the listed severities.

Specified by:

getResults in interface BuildResultCollector

Specified by:

getResults in interface KnowledgeBuilder

hasResults

public boolean hasResults(ResultSeverity... problemTypes)

Specified by:

hasResults in interface BuildResultCollector

Specified by:

hasResults in interface KnowledgeBuilder

hasWarnings

public boolean hasWarnings()

hasInfo

public boolean hasInfo()

getWarnings

public List<DroolsWarning> getWarnings()

reportError

public void reportError(KnowledgeBuilderError error)

Specified by:

reportError in interface AssemblerContext

getErrors

public PackageBuilderErrors getErrors()

Specified by:

getErrors in interface DroolsAssemblerContext

Specified by:

getErrors in interface KnowledgeBuilder

Returns:

A list of Error objects that resulted from building and compiling the package.

resetErrors

public void resetErrors()

Reset the error list. This is useful when incrementally building packages. Care should be used when building this, if you clear this when there were errors on items that a rule depends on (eg functions), then you will get spurious errors which will not be that helpful.

resetWarnings

public void resetWarnings()

resetProblems

public void resetProblems()

getRootClassLoader

public ClassLoader getRootClassLoader()

Specified by:

getRootClassLoader in interface RootClassLoaderProvider

registerBuildResource

public void registerBuildResource(Resource resource,
 ResourceType type)

registerBuildResources

public void registerBuildResources(List<Resource> resources)

undo

public void undo()

Specified by:

undo in interface KnowledgeBuilder

removeObjectsGeneratedFromResource

public InternalKnowledgeBuilder.ResourceRemovalResult removeObjectsGeneratedFromResource(Resource resource)

Specified by:

removeObjectsGeneratedFromResource in interface InternalKnowledgeBuilder

rewireAllClassObjectTypes

public void rewireAllClassObjectTypes()

Specified by:

rewireAllClassObjectTypes in interface InternalKnowledgeBuilder

setAssetFilter

public void setAssetFilter(AssetFilter assetFilter)

getAssetFilter

protected AssetFilter getAssetFilter()

add

public void add(Resource resource,
 ResourceType type)

Specified by:

add in interface KnowledgeBuilder

batch

public CompositeKnowledgeBuilder batch()

Specified by:

batch in interface KnowledgeBuilder

add

public void add(Resource resource,
 ResourceType type,
 ResourceConfiguration configuration)

Specified by:

add in interface KnowledgeBuilder

getKnowledgePackages

public Collection<KiePackage> getKnowledgePackages()

Specified by:

getKnowledgePackages in interface KnowledgeBuilder

newKieBase

public KieBase newKieBase()

Specified by:

newKieBase in interface KnowledgeBuilder

newKnowledgeBase

public KieBase newKnowledgeBase(KieBaseConfiguration conf)

getTypeDeclaration

public TypeDeclaration getTypeDeclaration(Class<?> cls)

Specified by:

getTypeDeclaration in interface DroolsAssemblerContext

Specified by:

getTypeDeclaration in interface TypeDeclarationManager

getTypeDeclaration

public TypeDeclaration getTypeDeclaration(ObjectType objectType)

Specified by:

getTypeDeclaration in interface DroolsAssemblerContext

Specified by:

getTypeDeclaration in interface TypeDeclarationManager

getCachedOrCreate

public <T> T getCachedOrCreate(String key,
 Supplier<T> creator)

buildPackages

public final void buildPackages(Collection<CompositePackageDescr> packages)

doFirstBuildStep

protected void doFirstBuildStep(Collection<CompositePackageDescr> packages)

Performs the actual building of rules, but may be empty in subclasses

doSecondBuildStep

protected void doSecondBuildStep(Collection<CompositePackageDescr> packages)

Used by subclasses that need to perform the build after the assemblers

buildPackagesWithoutRules

public void buildPackagesWithoutRules(Collection<CompositePackageDescr> packages)