Package org.drools.base.definitions.impl

Class KnowledgePackageImpl

java.lang.Object

org.drools.base.definitions.impl.KnowledgePackageImpl

All Implemented Interfaces:

Externalizable, Serializable, InternalKnowledgePackage, KiePackage

public class KnowledgePackageImpl
extends Object
implements InternalKnowledgePackage, Externalizable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,AccumulateFunction>	accumulateFunctions
protected Map<String,Object>	cloningResources
protected DialectRuntimeRegistry	dialectRuntimeRegistry
protected Set<String>	entryPointsIds
protected Map<String,Function>	functions
protected Map<String,Type>	globals
protected Map<String,ImportDeclaration>	imports
protected String	name	Name of the pkg.
protected boolean	needStreamMode
protected Map<String,Prototype>	prototypes
protected ResourceTypePackageRegistry	resourceTypePackages
protected Map<String,RuleImpl>	rules	Set of all rule-names in this Package.
protected Set<String>	staticImports
protected Map<String,TypeDeclaration>	typeDeclarations
protected boolean	valid	This is to indicate the the package has no errors during the compilation/building phase
protected Map<String,WindowDeclaration>	windowDeclarations

Constructor Summary

Constructors

Constructor	Description
KnowledgePackageImpl()
KnowledgePackageImpl(String name)	Construct.

Method Summary

Modifier and Type	Method	Description
void	addAccumulateFunction(String name, AccumulateFunction function)
void	addCloningResource(String key, Object resource)
void	addEntryPointId(String id)
void	addFunction(Function function)
void	addGlobal(String identifier, Type type)
void	addImport(ImportDeclaration importDecl)
void	addProcess(Process process)	Add a rule flow to this package.
void	addPrototype(Prototype prototype)
void	addRule(RuleImpl rule)	Add a Rule to this Package.
void	addStaticImport(String functionImport)
void	addTypeDeclaration(TypeDeclaration typeDecl)
void	addWindowDeclaration(WindowDeclaration window)
void	checkValidity()	This will throw an exception if the package is not valid
void	clear()
KnowledgePackageImpl	deepCloneIfAlreadyInUse(ClassLoader classLoader)
boolean	equals(Object object)
Map<String,AccumulateFunction>	getAccumulateFunctions()
DialectRuntimeRegistry	getDialectRuntimeRegistry()
Set<String>	getEntryPointIds()
String	getErrorSummary()	This will return the error summary (if any) if the package is invalid.
TypeDeclaration	getExactTypeDeclaration(Class<?> clazz)
FactType	getFactType(String typeName)
Collection<FactType>	getFactTypes()
Function	getFunction(String name)
Collection<String>	getFunctionNames()
Map<String,Function>	getFunctions()
Map<String,Type>	getGlobals()
Collection<Global>	getGlobalVariables()
protected String[]	getImplicitImports()
Map<String,ImportDeclaration>	getImports()
String	getName()	Retrieve the name of this Package.
ClassLoader	getPackageClassLoader()
Collection<Process>	getProcesses()
Prototype	getPrototype(String name)
Collection<Query>	getQueries()
ResourceTypePackageRegistry	getResourceTypePackages()
RuleImpl	getRule(String name)	Retrieve a Rule by name.
Map<String,Process>	getRuleFlows()	Get the rule flows for this package.
Collection<Rule>	getRules()
List<RuleImpl>	getRulesGeneratedFromResource(Resource resource)
RuleUnitDescriptionLoader	getRuleUnitDescriptionLoader()
Set<String>	getStaticImports()
TypeDeclaration	getTypeDeclaration(Class<?> clazz)
TypeDeclaration	getTypeDeclaration(String type)
Map<String,TypeDeclaration>	getTypeDeclarations()
TypeResolver	getTypeResolver()
Map<String,WindowDeclaration>	getWindowDeclarations()
int	hashCode()
boolean	isValid()
void	mergeTraitRegistry(RuleBase knowledgeBase)
boolean	needsStreamMode()
void	readExternal(ObjectInput stream)	Handles the read serialization of the Package.
boolean	removeFromResourceTypePackageGeneratedFromResource(Resource resource)
void	removeFunction(String functionName)
void	removeFunctionImport(String functionImport)
List<Function>	removeFunctionsGeneratedFromResource(Resource resource)
void	removeGlobal(String identifier)
boolean	removeObjectsGeneratedFromResource(Resource resource)
List<Process>	removeProcessesGeneratedFromResource(Resource resource)
void	removeRule(RuleImpl rule)
void	removeRuleFlow(String id)	Rule flows can be removed by ID.
List<RuleImpl>	removeRulesGeneratedFromResource(Resource resource)
void	removeTypeDeclaration(String type)
protected void	removeTypeFromStore(TypeDeclaration type)
List<TypeDeclaration>	removeTypesGeneratedFromResource(Resource resource)
void	resetErrors()	Once this is called, the package will be marked as invalid
void	setClassLoader(ClassLoader classLoader)
void	setError(String summary)	Once this is called, the package will be marked as invalid
void	setNeedStreamMode()
String	toString()
void	wireTypeDeclarations()
void	writeExternal(ObjectOutput stream)	Handles the write serialization of the Package.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.drools.base.definitions.InternalKnowledgePackage

buildFieldAccessors, getFieldExtractor, getFieldType, getReader, getWiringResults, mergeStore, removeClass, setClassFieldAccessorCache, wireObjectType, wireStore

Field Details

name

protected String name

Name of the pkg.

rules

protected Map<String,RuleImpl> rules

Set of all rule-names in this Package.

imports

protected Map<String,ImportDeclaration> imports

functions

protected Map<String,Function> functions

accumulateFunctions

protected Map<String,AccumulateFunction> accumulateFunctions

staticImports

protected Set<String> staticImports

globals

protected Map<String,Type> globals

prototypes

protected Map<String,Prototype> prototypes

dialectRuntimeRegistry

protected DialectRuntimeRegistry dialectRuntimeRegistry

typeDeclarations

protected Map<String,TypeDeclaration> typeDeclarations

entryPointsIds

protected Set<String> entryPointsIds

windowDeclarations

protected Map<String,WindowDeclaration> windowDeclarations

resourceTypePackages

protected ResourceTypePackageRegistry resourceTypePackages

cloningResources

protected Map<String,Object> cloningResources

valid

protected boolean valid

This is to indicate the the package has no errors during the compilation/building phase

needStreamMode

protected boolean needStreamMode

Constructor Details

KnowledgePackageImpl

public KnowledgePackageImpl()

KnowledgePackageImpl

public KnowledgePackageImpl(String name)

Construct.

Parameters:

name - The name of this Package.

Method Details

getResourceTypePackages

public ResourceTypePackageRegistry getResourceTypePackages()

Specified by:

getResourceTypePackages in interface InternalKnowledgePackage

getRules

public Collection<Rule> getRules()

Specified by:

getRules in interface KiePackage

getFunction

public Function getFunction(String name)

getProcesses

public Collection<Process> getProcesses()

Specified by:

getProcesses in interface KiePackage

getFactTypes

public Collection<FactType> getFactTypes()

Specified by:

getFactTypes in interface KiePackage

getQueries

public Collection<Query> getQueries()

Specified by:

getQueries in interface KiePackage

getFunctionNames

public Collection<String> getFunctionNames()

Specified by:

getFunctionNames in interface KiePackage

getGlobalVariables

public Collection<Global> getGlobalVariables()

Specified by:

getGlobalVariables in interface KiePackage

writeExternal

public void writeExternal(ObjectOutput stream)
                   throws IOException

Handles the write serialization of the Package. Patterns in Rules may reference generated data which cannot be serialized by default methods. The Package uses PackageCompilationData to hold a reference to the generated bytecode. The generated bytecode must be restored before any Rules.

Specified by:

writeExternal in interface Externalizable

Parameters:

stream - out the stream to write the object to; should be an instance of DroolsObjectOutputStream or OutputStream

Throws:

IOException

readExternal

public void readExternal(ObjectInput stream)
                  throws IOException,
ClassNotFoundException

Handles the read serialization of the Package. Patterns in Rules may reference generated data which cannot be serialized by default methods. The Package uses PackageCompilationData to hold a reference to the generated bytecode; which must be restored before any Rules. A custom ObjectInputStream, able to resolve classes against the bytecode in the PackageCompilationData, is used to restore the Rules.

Specified by:

readExternal in interface Externalizable

Parameters:

stream - , the stream to read data from in order to restore the object; should be an instance of DroolsObjectInputStream or InputStream

Throws:

IOException

ClassNotFoundException

getName

public String getName()

Retrieve the name of this Package.

Specified by:

getName in interface KiePackage

Returns:

The name of this Package.

getPackageClassLoader

public ClassLoader getPackageClassLoader()

Specified by:

getPackageClassLoader in interface InternalKnowledgePackage

getDialectRuntimeRegistry

public DialectRuntimeRegistry getDialectRuntimeRegistry()

Specified by:

getDialectRuntimeRegistry in interface InternalKnowledgePackage

addImport

public void addImport(ImportDeclaration importDecl)

Specified by:

addImport in interface InternalKnowledgePackage

getImports

public Map<String,ImportDeclaration> getImports()

Specified by:

getImports in interface InternalKnowledgePackage

addTypeDeclaration

public void addTypeDeclaration(TypeDeclaration typeDecl)

Specified by:

addTypeDeclaration in interface InternalKnowledgePackage

removeTypeDeclaration

public void removeTypeDeclaration(String type)

Specified by:

removeTypeDeclaration in interface InternalKnowledgePackage

getTypeDeclarations

public Map<String,TypeDeclaration> getTypeDeclarations()

Specified by:

getTypeDeclarations in interface InternalKnowledgePackage

getTypeDeclaration

public TypeDeclaration getTypeDeclaration(Class<?> clazz)

Specified by:

getTypeDeclaration in interface InternalKnowledgePackage

getExactTypeDeclaration

public TypeDeclaration getExactTypeDeclaration(Class<?> clazz)

getTypeDeclaration

public TypeDeclaration getTypeDeclaration(String type)

Specified by:

getTypeDeclaration in interface InternalKnowledgePackage

addStaticImport

public void addStaticImport(String functionImport)

Specified by:

addStaticImport in interface InternalKnowledgePackage

addFunction

public void addFunction(Function function)

Specified by:

addFunction in interface InternalKnowledgePackage

getFunctions

public Map<String,Function> getFunctions()

Specified by:

getFunctions in interface InternalKnowledgePackage

addAccumulateFunction

public void addAccumulateFunction(String name,
 AccumulateFunction function)

Specified by:

addAccumulateFunction in interface InternalKnowledgePackage

getAccumulateFunctions

public Map<String,AccumulateFunction> getAccumulateFunctions()

Specified by:

getAccumulateFunctions in interface InternalKnowledgePackage

removeFunctionImport

public void removeFunctionImport(String functionImport)

getStaticImports

public Set<String> getStaticImports()

Specified by:

getStaticImports in interface InternalKnowledgePackage

addGlobal

public void addGlobal(String identifier,
 Type type)

Specified by:

addGlobal in interface InternalKnowledgePackage

removeGlobal

public void removeGlobal(String identifier)

Specified by:

removeGlobal in interface InternalKnowledgePackage

getGlobals

public Map<String,Type> getGlobals()

Specified by:

getGlobals in interface InternalKnowledgePackage

removeFunction

public void removeFunction(String functionName)

Specified by:

removeFunction in interface InternalKnowledgePackage

getPrototype

public Prototype getPrototype(String name)

Specified by:

getPrototype in interface InternalKnowledgePackage

addPrototype

public void addPrototype(Prototype prototype)

Specified by:

addPrototype in interface InternalKnowledgePackage

addRule

public void addRule(RuleImpl rule)

Add a Rule to this Package.

Specified by:

addRule in interface InternalKnowledgePackage

Parameters:

rule - The rule to add.

Throws:

DuplicateRuleNameException - If the Rule attempting to be added has the same name as another previously added Rule.

InvalidRuleException - If the Rule is not valid.

addProcess

public void addProcess(Process process)

Add a rule flow to this package.

Specified by:

addProcess in interface InternalKnowledgePackage

getRuleFlows

public Map<String,Process> getRuleFlows()

Get the rule flows for this package. The key is the ruleflow id. It will be Collections.EMPTY_MAP if none have been added.

Specified by:

getRuleFlows in interface InternalKnowledgePackage

removeRuleFlow

public void removeRuleFlow(String id)

Rule flows can be removed by ID.

Specified by:

removeRuleFlow in interface InternalKnowledgePackage

removeRule

public void removeRule(RuleImpl rule)

Specified by:

removeRule in interface InternalKnowledgePackage

getRule

public RuleImpl getRule(String name)

Retrieve a Rule by name.

Specified by:

getRule in interface InternalKnowledgePackage

Parameters:

name - The name of the Rule to retrieve.

Returns:

The named Rule, or null if not such Rule has been added to this Package.

toString

public String toString()

Overrides:

toString in class Object

setError

public void setError(String summary)

Once this is called, the package will be marked as invalid

Specified by:

setError in interface InternalKnowledgePackage

resetErrors

public void resetErrors()

Once this is called, the package will be marked as invalid

Specified by:

resetErrors in interface InternalKnowledgePackage

isValid

public boolean isValid()

Specified by:

isValid in interface InternalKnowledgePackage

Returns:

true (default) if there are no build/structural problems.

checkValidity

public void checkValidity()

This will throw an exception if the package is not valid

Specified by:

checkValidity in interface InternalKnowledgePackage

getErrorSummary

public String getErrorSummary()

This will return the error summary (if any) if the package is invalid.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clear

public void clear()

Specified by:

clear in interface InternalKnowledgePackage

getFactType

public FactType getFactType(String typeName)

Specified by:

getFactType in interface InternalKnowledgePackage

wireTypeDeclarations

public void wireTypeDeclarations()

Specified by:

wireTypeDeclarations in interface InternalKnowledgePackage

getEntryPointIds

public Set<String> getEntryPointIds()

Specified by:

getEntryPointIds in interface InternalKnowledgePackage

addEntryPointId

public void addEntryPointId(String id)

Specified by:

addEntryPointId in interface InternalKnowledgePackage

getTypeResolver

public TypeResolver getTypeResolver()

Specified by:

getTypeResolver in interface InternalKnowledgePackage

setClassLoader

public void setClassLoader(ClassLoader classLoader)

Specified by:

setClassLoader in interface InternalKnowledgePackage

getImplicitImports

protected String[] getImplicitImports()

getRuleUnitDescriptionLoader

public RuleUnitDescriptionLoader getRuleUnitDescriptionLoader()

Specified by:

getRuleUnitDescriptionLoader in interface InternalKnowledgePackage

addWindowDeclaration

public void addWindowDeclaration(WindowDeclaration window)

Specified by:

addWindowDeclaration in interface InternalKnowledgePackage

getWindowDeclarations

public Map<String,WindowDeclaration> getWindowDeclarations()

Specified by:

getWindowDeclarations in interface InternalKnowledgePackage

removeObjectsGeneratedFromResource

public boolean removeObjectsGeneratedFromResource(Resource resource)

Specified by:

removeObjectsGeneratedFromResource in interface InternalKnowledgePackage

removeFromResourceTypePackageGeneratedFromResource

public boolean removeFromResourceTypePackageGeneratedFromResource(Resource resource)

Specified by:

removeFromResourceTypePackageGeneratedFromResource in interface InternalKnowledgePackage

removeTypesGeneratedFromResource

public List<TypeDeclaration> removeTypesGeneratedFromResource(Resource resource)

Specified by:

removeTypesGeneratedFromResource in interface InternalKnowledgePackage

removeTypeFromStore

protected void removeTypeFromStore(TypeDeclaration type)

removeRulesGeneratedFromResource

public List<RuleImpl> removeRulesGeneratedFromResource(Resource resource)

Specified by:

removeRulesGeneratedFromResource in interface InternalKnowledgePackage

getRulesGeneratedFromResource

public List<RuleImpl> getRulesGeneratedFromResource(Resource resource)

Specified by:

getRulesGeneratedFromResource in interface InternalKnowledgePackage

removeFunctionsGeneratedFromResource

public List<Function> removeFunctionsGeneratedFromResource(Resource resource)

Specified by:

removeFunctionsGeneratedFromResource in interface InternalKnowledgePackage

removeProcessesGeneratedFromResource

public List<Process> removeProcessesGeneratedFromResource(Resource resource)

Specified by:

removeProcessesGeneratedFromResource in interface InternalKnowledgePackage

needsStreamMode

public boolean needsStreamMode()

setNeedStreamMode

public void setNeedStreamMode()

Specified by:

setNeedStreamMode in interface InternalKnowledgePackage

deepCloneIfAlreadyInUse

public KnowledgePackageImpl deepCloneIfAlreadyInUse(ClassLoader classLoader)

Specified by:

deepCloneIfAlreadyInUse in interface InternalKnowledgePackage

mergeTraitRegistry

public void mergeTraitRegistry(RuleBase knowledgeBase)

Specified by:

mergeTraitRegistry in interface InternalKnowledgePackage

addCloningResource

public void addCloningResource(String key,
 Object resource)

Specified by:

addCloningResource in interface InternalKnowledgePackage