org.drools.compiler.builder.impl

Class KnowledgeBuilderImpl

java.lang.Object

org.drools.compiler.builder.impl.KnowledgeBuilderImpl

All Implemented Interfaces:

DroolsAssemblerContext, InternalKnowledgeBuilder, org.kie.internal.builder.AssemblerContext, org.kie.internal.builder.KnowledgeBuilder, org.kie.internal.builder.ProcessBuilder, org.kie.internal.builder.RuleBuilder

public class KnowledgeBuilderImpl
extends Object
implements InternalKnowledgeBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	KnowledgeBuilderImpl.AssetFilter
static class	KnowledgeBuilderImpl.ForkJoinPoolHolder
static class	KnowledgeBuilderImpl.MissingPackageNameException
static class	KnowledgeBuilderImpl.PackageMergeException

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

InternalKnowledgeBuilder.Empty, InternalKnowledgeBuilder.ResourceRemovalResult

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
KnowledgeBuilderImpl() Use this when package is starting from scratch.
KnowledgeBuilderImpl(org.drools.core.impl.InternalKnowledgeBase kBase)
KnowledgeBuilderImpl(org.drools.core.impl.InternalKnowledgeBase kBase, KnowledgeBuilderConfigurationImpl configuration)
KnowledgeBuilderImpl(org.drools.core.definitions.InternalKnowledgePackage pkg) This will allow you to merge rules into this pre existing package.
KnowledgeBuilderImpl(org.drools.core.definitions.InternalKnowledgePackage pkg, KnowledgeBuilderConfigurationImpl configuration)
KnowledgeBuilderImpl(KnowledgeBuilderConfigurationImpl configuration) Pass a specific configuration for the PackageBuilder PackageBuilderConfiguration is not thread safe and it also contains state.

Method Summary

Modifier and Type	Method and Description
void	add(org.kie.api.io.Resource resource, org.kie.api.io.ResourceType type)
void	add(org.kie.api.io.Resource resource, org.kie.api.io.ResourceType type, org.kie.api.io.ResourceConfiguration configuration)
void	addBuilderResult(org.kie.internal.builder.KnowledgeBuilderResult result)
void	addDsl(org.kie.api.io.Resource resource)
void	addGlobal(String name, Class<?> type)
void	addKnowledgeResource(org.kie.api.io.Resource resource, org.kie.api.io.ResourceType type, org.kie.api.io.ResourceConfiguration configuration)
void	addPackage(org.drools.core.definitions.InternalKnowledgePackage newPkg)
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	addPackageFromDecisionTable(org.kie.api.io.Resource resource, org.kie.api.io.ResourceConfiguration configuration)
void	addPackageFromDrl(Reader reader) Load a rule package from DRL source.
void	addPackageFromDrl(Reader source, Reader dsl) Load a rule package from DRL source using the supplied DSL configuration.
void	addPackageFromDrl(Reader reader, org.kie.api.io.Resource sourceResource) Load a rule package from DRL source and associate all loaded artifacts with the given resource.
void	addPackageFromDrl(org.kie.api.io.Resource resource)
void	addPackageFromDslr(org.kie.api.io.Resource resource)
void	addPackageFromGuidedDecisionTable(org.kie.api.io.Resource resource)
void	addPackageFromGuidedScoreCard(org.kie.api.io.Resource resource)
void	addPackageFromScoreCard(org.kie.api.io.Resource resource, org.kie.api.io.ResourceConfiguration configuration)
void	addPackageFromTemplate(org.kie.api.io.Resource resource)
void	addPackageFromXml(Reader reader) Load a rule package from XML source.
void	addPackageFromXml(org.kie.api.io.Resource resource)
void	addProcessFromXml(Reader processSource) Deprecated.
void	addProcessFromXml(org.kie.api.io.Resource resource) Deprecated.
void	addRuleFlow(Reader processSource) Add a ruleflow (.rfm) asset to this package.
org.kie.internal.builder.CompositeKnowledgeBuilder	batch()
protected void	buildEntryPoints(Collection<CompositePackageDescr> packages)
protected void	buildOtherDeclarations(Collection<CompositePackageDescr> packages)
void	buildPackages(Collection<CompositePackageDescr> packages)
void	buildPackagesWithoutRules(Collection<CompositePackageDescr> packages)
protected void	buildRules(Collection<CompositePackageDescr> packages)
protected void	buildTypeDeclarations(Collection<CompositePackageDescr> packages)
void	compileAll()
protected void	compileKnowledgePackages(PackageDescr packageDescr, PackageRegistry pkgRegistry)
protected void	compileRete(PackageDescr packageDescr)
<T extends org.kie.api.internal.io.ResourceTypePackage<?>> T	computeIfAbsent(org.kie.api.io.ResourceType resourceType, String namespace, Function<? super org.kie.api.io.ResourceType,T> mappingFunction)
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
org.drools.core.rule.TypeDeclaration	getAndRegisterTypeDeclaration(Class<?> cls, String packageName)
KnowledgeBuilderConfigurationImpl	getBuilderConfiguration() Return the PackageBuilderConfiguration for this PackageBuilder session
<T> T	getCachedOrCreate(String key, Supplier<T> creator)
String	getDefaultDialect()
DefaultExpander	getDslExpander() Returns an expander for DSLs (only if there is a DSL configured for this package).
PackageBuilderErrors	getErrors()
Map<String,Class<?>>	getGlobals()
org.drools.core.impl.InternalKnowledgeBase	getKnowledgeBase()
Collection<org.kie.api.definition.KiePackage>	getKnowledgePackages()
PackageRegistry	getOrCreatePackageRegistry(PackageDescr packageDescr)
org.drools.core.definitions.InternalKnowledgePackage	getPackage(String name)
List<PackageDescr>	getPackageDescrs(String packageName)
Collection<String>	getPackageNames()
Map<String,PackageRegistry>	getPackageRegistry()
PackageRegistry	getPackageRegistry(String name)
org.drools.core.definitions.InternalKnowledgePackage[]	getPackages()
ProcessBuilder	getProcessBuilder()
org.kie.api.builder.ReleaseId	getReleaseId()
org.kie.internal.builder.KnowledgeBuilderResults	getResults(org.kie.internal.builder.ResultSeverity... problemTypes)
ClassLoader	getRootClassLoader()
org.drools.core.rule.TypeDeclaration	getTypeDeclaration(Class<?> cls)
List<DroolsWarning>	getWarnings()
boolean	hasErrors() This will return true if there were errors in the package building and compiling phase
boolean	hasInfo()
boolean	hasResults(org.kie.internal.builder.ResultSeverity... problemTypes)
boolean	hasWarnings()
protected void	initPackageRegistries(Collection<CompositePackageDescr> packages)
org.kie.api.KieBase	newKieBase()
org.kie.api.KieBase	newKnowledgeBase(org.kie.api.KieBaseConfiguration conf)
protected void	normalizeAnnotations(AnnotatedBaseDescr annotationsContainer, org.drools.core.addon.TypeResolver typeResolver, boolean isStrict)
protected void	normalizeRuleAnnotations(Collection<CompositePackageDescr> packages)
void	normalizeRuleAnnotations(PackageDescr packageDescr, org.drools.core.addon.TypeResolver typeResolver)
protected void	normalizeTypeAnnotations(Collection<CompositePackageDescr> packages)
void	normalizeTypeDeclarationAnnotations(PackageDescr packageDescr, org.drools.core.addon.TypeResolver typeResolver)
protected void	processAccumulateFunctions(PackageRegistry pkgRegistry, PackageDescr packageDescr)
protected void	processFunctions(PackageRegistry pkgRegistry, PackageDescr packageDescr)
protected void	processGlobals(PackageRegistry pkgRegistry, PackageDescr packageDescr)
protected void	processKieBaseTypes()
protected void	processOtherDeclarations(PackageRegistry pkgRegistry, PackageDescr packageDescr)
protected void	processWindowDeclarations(PackageRegistry pkgRegistry, PackageDescr packageDescr)
void	registerBuildResource(org.kie.api.io.Resource resource, org.kie.api.io.ResourceType type)
void	registerBuildResources(List<org.kie.api.io.Resource> resources)
void	registerPackage(PackageDescr packageDescr)
void	reloadAll()
InternalKnowledgeBuilder.ResourceRemovalResult	removeObjectsGeneratedFromResource(org.kie.api.io.Resource resource)
void	reportError(org.kie.internal.builder.KnowledgeBuilderError error)
void	resetErrors() Reset the error list.
void	resetProblems()
void	resetWarnings()
void	rewireAllClassObjectTypes()
void	setAssetFilter(KnowledgeBuilderImpl.AssetFilter assetFilter)
void	setReleaseId(org.kie.api.builder.ReleaseId releaseId)
void	undo()
void	updateResults()
void	updateResults(List<org.kie.internal.builder.KnowledgeBuilderResult> results)
protected void	validateUniqueRuleNames(PackageDescr packageDescr)
protected void	wireAllRules()

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final transient org.slf4j.Logger logger

Constructor Detail

KnowledgeBuilderImpl

public KnowledgeBuilderImpl()

Use this when package is starting from scratch.

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(org.drools.core.definitions.InternalKnowledgePackage pkg)

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

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(org.drools.core.impl.InternalKnowledgeBase kBase)

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(KnowledgeBuilderConfigurationImpl 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(org.drools.core.definitions.InternalKnowledgePackage pkg,
                            KnowledgeBuilderConfigurationImpl configuration)

KnowledgeBuilderImpl

public KnowledgeBuilderImpl(org.drools.core.impl.InternalKnowledgeBase kBase,
                            KnowledgeBuilderConfigurationImpl configuration)

Method Detail

getReleaseId

public org.kie.api.builder.ReleaseId getReleaseId()

setReleaseId

public void setReleaseId(org.kie.api.builder.ReleaseId releaseId)

getKnowledgeBase

public org.drools.core.impl.InternalKnowledgeBase getKnowledgeBase()

Specified by:

getKnowledgeBase in interface DroolsAssemblerContext

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,
                              org.kie.api.io.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

addPackageFromDecisionTable

public void addPackageFromDecisionTable(org.kie.api.io.Resource resource,
                                        org.kie.api.io.ResourceConfiguration configuration)
                                 throws DroolsParserException,
                                        IOException

Throws:

DroolsParserException

IOException

addPackageFromGuidedDecisionTable

public void addPackageFromGuidedDecisionTable(org.kie.api.io.Resource resource)
                                       throws DroolsParserException,
                                              IOException

Throws:

DroolsParserException

IOException

createDumpDrlFile

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

addPackageFromScoreCard

public void addPackageFromScoreCard(org.kie.api.io.Resource resource,
                                    org.kie.api.io.ResourceConfiguration configuration)
                             throws DroolsParserException,
                                    IOException

Throws:

DroolsParserException

IOException

addPackageFromGuidedScoreCard

public void addPackageFromGuidedScoreCard(org.kie.api.io.Resource resource)
                                   throws DroolsParserException,
                                          IOException

Throws:

DroolsParserException

IOException

addPackageFromTemplate

public void addPackageFromTemplate(org.kie.api.io.Resource resource)
                            throws DroolsParserException,
                                   IOException

Throws:

DroolsParserException

IOException

addPackageFromDrl

public void addPackageFromDrl(org.kie.api.io.Resource resource)
                       throws DroolsParserException,
                              IOException

Throws:

DroolsParserException

IOException

addPackageFromXml

public void addPackageFromXml(Reader reader)
                       throws DroolsParserException,
                              IOException

Load a rule package from XML source.

Parameters:

reader -

Throws:

DroolsParserException

IOException

addPackageFromXml

public void addPackageFromXml(org.kie.api.io.Resource resource)
                       throws DroolsParserException,
                              IOException

Throws:

DroolsParserException

IOException

addPackageFromDrl

public void addPackageFromDrl(Reader source,
                              Reader dsl)
                       throws DroolsParserException,
                              IOException

Load a rule package from DRL source using the supplied DSL configuration.

Parameters:

source - The source of the rules.

dsl - The source of the domain specific language configuration.

Throws:

DroolsParserException

IOException

addPackageFromDslr

public void addPackageFromDslr(org.kie.api.io.Resource resource)
                        throws DroolsParserException,
                               IOException

Throws:

DroolsParserException

IOException

addDsl

public void addDsl(org.kie.api.io.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(org.kie.api.io.Resource resource)

Deprecated.

getProcessBuilder

public ProcessBuilder getProcessBuilder()

addProcessFromXml

@Deprecated
public void addProcessFromXml(Reader processSource)

Deprecated.

addKnowledgeResource

public void addKnowledgeResource(org.kie.api.io.Resource resource,
                                 org.kie.api.io.ResourceType type,
                                 org.kie.api.io.ResourceConfiguration configuration)

addPackage

public 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

compileKnowledgePackages

protected void compileKnowledgePackages(PackageDescr packageDescr,
                                        PackageRegistry pkgRegistry)

wireAllRules

protected void wireAllRules()

processKieBaseTypes

protected void processKieBaseTypes()

compileRete

protected void compileRete(PackageDescr packageDescr)

addBuilderResult

public void addBuilderResult(org.kie.internal.builder.KnowledgeBuilderResult result)

computeIfAbsent

public <T extends org.kie.api.internal.io.ResourceTypePackage<?>> T computeIfAbsent(org.kie.api.io.ResourceType resourceType,
                                                                                    String namespace,
                                                                                    Function<? super org.kie.api.io.ResourceType,T> mappingFunction)

Specified by:

computeIfAbsent in interface org.kie.internal.builder.AssemblerContext

getOrCreatePackageRegistry

public PackageRegistry getOrCreatePackageRegistry(PackageDescr packageDescr)

registerPackage

public void registerPackage(PackageDescr packageDescr)

updateResults

public void updateResults()

updateResults

public void updateResults(List<org.kie.internal.builder.KnowledgeBuilderResult> results)

compileAll

public void compileAll()

reloadAll

public void reloadAll()

addPackage

public void addPackage(org.drools.core.definitions.InternalKnowledgePackage newPkg)

validateUniqueRuleNames

protected void validateUniqueRuleNames(PackageDescr packageDescr)

processOtherDeclarations

protected void processOtherDeclarations(PackageRegistry pkgRegistry,
                                        PackageDescr packageDescr)

processGlobals

protected void processGlobals(PackageRegistry pkgRegistry,
                              PackageDescr packageDescr)

processAccumulateFunctions

protected void processAccumulateFunctions(PackageRegistry pkgRegistry,
                                          PackageDescr packageDescr)

processFunctions

protected void processFunctions(PackageRegistry pkgRegistry,
                                PackageDescr packageDescr)

getAndRegisterTypeDeclaration

public org.drools.core.rule.TypeDeclaration getAndRegisterTypeDeclaration(Class<?> cls,
                                                                          String packageName)

Specified by:

getAndRegisterTypeDeclaration in interface DroolsAssemblerContext

processWindowDeclarations

protected void processWindowDeclarations(PackageRegistry pkgRegistry,
                                         PackageDescr packageDescr)

getPackages

public org.drools.core.definitions.InternalKnowledgePackage[] getPackages()

getBuilderConfiguration

public KnowledgeBuilderConfigurationImpl getBuilderConfiguration()

Return the PackageBuilderConfiguration for this PackageBuilder session

Specified by:

getBuilderConfiguration in interface DroolsAssemblerContext

Returns:

The PackageBuilderConfiguration

getPackageRegistry

public PackageRegistry getPackageRegistry(String name)

Specified by:

getPackageRegistry in interface DroolsAssemblerContext

getPackage

public org.drools.core.definitions.InternalKnowledgePackage getPackage(String name)

Specified by:

getPackage in interface InternalKnowledgeBuilder

getPackageRegistry

public Map<String,PackageRegistry> getPackageRegistry()

getPackageNames

public Collection<String> getPackageNames()

getPackageDescrs

public List<PackageDescr> getPackageDescrs(String packageName)

Specified by:

getPackageDescrs in interface DroolsAssemblerContext

getDslExpander

public DefaultExpander getDslExpander()

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

getGlobals

public Map<String,Class<?>> getGlobals()

Specified by:

getGlobals in interface DroolsAssemblerContext

addGlobal

public void addGlobal(String name,
                      Class<?> type)

hasErrors

public boolean hasErrors()

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

Specified by:

hasErrors in interface org.kie.internal.builder.KnowledgeBuilder

getResults

public org.kie.internal.builder.KnowledgeBuilderResults getResults(org.kie.internal.builder.ResultSeverity... problemTypes)

Specified by:

getResults in interface org.kie.internal.builder.KnowledgeBuilder

hasResults

public boolean hasResults(org.kie.internal.builder.ResultSeverity... problemTypes)

Specified by:

hasResults in interface org.kie.internal.builder.KnowledgeBuilder

hasWarnings

public boolean hasWarnings()

hasInfo

public boolean hasInfo()

getWarnings

public List<DroolsWarning> getWarnings()

reportError

public void reportError(org.kie.internal.builder.KnowledgeBuilderError error)

Specified by:

reportError in interface org.kie.internal.builder.AssemblerContext

getErrors

public PackageBuilderErrors getErrors()

Specified by:

getErrors in interface DroolsAssemblerContext

Specified by:

getErrors in interface org.kie.internal.builder.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()

getDefaultDialect

public String getDefaultDialect()

getRootClassLoader

public ClassLoader getRootClassLoader()

Specified by:

getRootClassLoader in interface DroolsAssemblerContext

registerBuildResource

public void registerBuildResource(org.kie.api.io.Resource resource,
                                  org.kie.api.io.ResourceType type)

registerBuildResources

public void registerBuildResources(List<org.kie.api.io.Resource> resources)

undo

public void undo()

Specified by:

undo in interface org.kie.internal.builder.KnowledgeBuilder

removeObjectsGeneratedFromResource

public InternalKnowledgeBuilder.ResourceRemovalResult removeObjectsGeneratedFromResource(org.kie.api.io.Resource resource)

Specified by:

removeObjectsGeneratedFromResource in interface InternalKnowledgeBuilder

rewireAllClassObjectTypes

public void rewireAllClassObjectTypes()

Specified by:

rewireAllClassObjectTypes in interface InternalKnowledgeBuilder

setAssetFilter

public void setAssetFilter(KnowledgeBuilderImpl.AssetFilter assetFilter)

add

public void add(org.kie.api.io.Resource resource,
                org.kie.api.io.ResourceType type)

Specified by:

add in interface org.kie.internal.builder.KnowledgeBuilder

batch

public org.kie.internal.builder.CompositeKnowledgeBuilder batch()

Specified by:

batch in interface org.kie.internal.builder.KnowledgeBuilder

add

public void add(org.kie.api.io.Resource resource,
                org.kie.api.io.ResourceType type,
                org.kie.api.io.ResourceConfiguration configuration)

Specified by:

add in interface org.kie.internal.builder.KnowledgeBuilder

getKnowledgePackages

public Collection<org.kie.api.definition.KiePackage> getKnowledgePackages()

Specified by:

getKnowledgePackages in interface org.kie.internal.builder.KnowledgeBuilder

newKieBase

public org.kie.api.KieBase newKieBase()

Specified by:

newKieBase in interface org.kie.internal.builder.KnowledgeBuilder

newKnowledgeBase

public org.kie.api.KieBase newKnowledgeBase(org.kie.api.KieBaseConfiguration conf)

getTypeDeclaration

public org.drools.core.rule.TypeDeclaration getTypeDeclaration(Class<?> cls)

Specified by:

getTypeDeclaration in interface DroolsAssemblerContext

normalizeTypeDeclarationAnnotations

public void normalizeTypeDeclarationAnnotations(PackageDescr packageDescr,
                                                org.drools.core.addon.TypeResolver typeResolver)

normalizeRuleAnnotations

public void normalizeRuleAnnotations(PackageDescr packageDescr,
                                     org.drools.core.addon.TypeResolver typeResolver)

normalizeAnnotations

protected void normalizeAnnotations(AnnotatedBaseDescr annotationsContainer,
                                    org.drools.core.addon.TypeResolver typeResolver,
                                    boolean isStrict)

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)

initPackageRegistries

protected void initPackageRegistries(Collection<CompositePackageDescr> packages)

normalizeTypeAnnotations

protected void normalizeTypeAnnotations(Collection<CompositePackageDescr> packages)

normalizeRuleAnnotations

protected void normalizeRuleAnnotations(Collection<CompositePackageDescr> packages)

buildEntryPoints

protected void buildEntryPoints(Collection<CompositePackageDescr> packages)

buildTypeDeclarations

protected void buildTypeDeclarations(Collection<CompositePackageDescr> packages)

buildOtherDeclarations

protected void buildOtherDeclarations(Collection<CompositePackageDescr> packages)

buildRules

protected void buildRules(Collection<CompositePackageDescr> packages)