Package org.drools.core.rule

Class TypeDeclaration

java.lang.Object

org.drools.core.rule.TypeDeclaration

All Implemented Interfaces:

Externalizable, Serializable, Comparable<TypeDeclaration>, org.kie.api.definition.KieDefinition, org.kie.internal.definition.KnowledgeDefinition

public class TypeDeclaration
extends Object
implements org.kie.internal.definition.KnowledgeDefinition, Externalizable, Comparable<TypeDeclaration>

The type declaration class stores all type's metadata declared in source files.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TypeDeclaration.Format
static class	TypeDeclaration.Kind
static class	TypeDeclaration.Nature

Nested classes/interfaces inherited from interface org.kie.api.definition.KieDefinition

org.kie.api.definition.KieDefinition.KnowledgeType

Field Summary

Fields

Modifier and Type	Field	Description
static int	FORMAT_BIT
static int	KIND_BIT
static int	NATURE_BIT
static long	NEVER_EXPIRES
static int	ROLE_BIT
int	setMask
static int	TYPESAFE_BIT

Constructor Summary

Constructors

Constructor	Description
TypeDeclaration()
TypeDeclaration(String typeName)

Method Summary

Modifier and Type	Method	Description
int	compareTo(TypeDeclaration o)
static TypeDeclaration	createTypeDeclarationForBean(Class<?> cls)
static TypeDeclaration	createTypeDeclarationForBean(Class<?> cls, Annotated annotated, org.kie.internal.builder.conf.PropertySpecificOption propertySpecificOption)
static TypeDeclaration	createTypeDeclarationForBean(Class<?> cls, org.kie.internal.builder.conf.PropertySpecificOption propertySpecificOption)
boolean	equals(Object obj)
List<String>	getAccessibleProperties()
String	getDurationAttribute()
InternalReadAccessor	getDurationExtractor()
long	getExpirationOffset()
org.kie.api.definition.type.Expires.Policy	getExpirationPolicy()
TypeDeclaration.Format	getFormat()
String	getFullName()
String	getId()
TypeDeclaration.Kind	getKind()
org.kie.api.definition.KieDefinition.KnowledgeType	getKnowledgeType()
String	getNamespace()
TypeDeclaration.Nature	getNature()
ObjectType	getObjectType()
int	getOrder()
org.kie.api.io.Resource	getResource()
org.kie.api.definition.type.Role.Type	getRole()
int	getSetMask()
String	getTimestampAttribute()
InternalReadAccessor	getTimestampExtractor()
Class<?>	getTypeClass()
ClassDefinition	getTypeClassDef()
String	getTypeClassName()
String	getTypeName()
FactTemplate	getTypeTemplate()
int	hashCode()
boolean	isDefinition()
boolean	isDynamic()
boolean	isGeneratedFact()
boolean	isJavaBased()
boolean	isNovel()
boolean	isPropertyReactive()
boolean	isTypesafe()
boolean	isValid()
boolean	matches(Object clazz)	Returns true if the given parameter matches this type declaration
static void	processTypeAnnotations(TypeDeclaration type, Annotated annotated, org.kie.internal.builder.conf.PropertySpecificOption propertySpecificOption)
void	readExternal(ObjectInput in)
void	setDurationAttribute(String durationAttribute)
void	setDurationExtractor(InternalReadAccessor durationExtractor)
void	setDynamic(boolean dynamic)
void	setExpirationOffset(long expirationOffset)
void	setExpirationType(org.kie.api.definition.type.Expires.Policy expirationPolicy)
void	setFormat(TypeDeclaration.Format format)
void	setKind(TypeDeclaration.Kind kind)
void	setNature(TypeDeclaration.Nature nature)
void	setNovel(boolean novel)
void	setOrder(int order)
void	setPropertyReactive(boolean propertyReactive)
void	setResource(org.kie.api.io.Resource resource)
void	setRole(org.kie.api.definition.type.Role.Type role)
void	setTimestampAttribute(String timestampAttribute)
void	setTimestampExtractor(InternalReadAccessor timestampExtractor)
void	setTypeClass(Class<?> typeClass)
void	setTypeClassDef(ClassDefinition typeClassDef)
void	setTypeClassName(String typeClassName)
void	setTypesafe(boolean typesafe)
void	setTypeTemplate(FactTemplate typeTemplate)
void	setValid(boolean valid)
String	toString()
void	writeExternal(ObjectOutput out)

Methods inherited from class java.lang.Object

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

Field Detail

NEVER_EXPIRES

public static final long NEVER_EXPIRES

See Also:

Constant Field Values

ROLE_BIT

public static final int ROLE_BIT

See Also:

Constant Field Values

TYPESAFE_BIT

public static final int TYPESAFE_BIT

See Also:

Constant Field Values

FORMAT_BIT

public static final int FORMAT_BIT

See Also:

Constant Field Values

KIND_BIT

public static final int KIND_BIT

See Also:

Constant Field Values

NATURE_BIT

public static final int NATURE_BIT

See Also:

Constant Field Values

setMask

public int setMask

Constructor Detail

TypeDeclaration

public TypeDeclaration()

TypeDeclaration

public TypeDeclaration(String typeName)

Method Detail

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

getSetMask

public int getSetMask()

getTypeName

public String getTypeName()

Returns:

the type

getRole

public org.kie.api.definition.type.Role.Type getRole()

Returns:

the category

setRole

public void setRole(org.kie.api.definition.type.Role.Type role)

Parameters:

role - the category to set

getFormat

public TypeDeclaration.Format getFormat()

Returns:

the format

setFormat

public void setFormat(TypeDeclaration.Format format)

Parameters:

format - the format to set

getKind

public TypeDeclaration.Kind getKind()

Returns:

the kind

setKind

public void setKind(TypeDeclaration.Kind kind)

Parameters:

kind - the kind to set

getNature

public TypeDeclaration.Nature getNature()

setNature

public void setNature(TypeDeclaration.Nature nature)

getTimestampAttribute

public String getTimestampAttribute()

Returns:

the timestampAttribute

setTimestampAttribute

public void setTimestampAttribute(String timestampAttribute)

Parameters:

timestampAttribute - the timestampAttribute to set

getDurationAttribute

public String getDurationAttribute()

Returns:

the durationAttribute

setDurationAttribute

public void setDurationAttribute(String durationAttribute)

Parameters:

durationAttribute - the durationAttribute to set

isValid

public boolean isValid()

setValid

public void setValid(boolean valid)

getTypeClass

public Class<?> getTypeClass()

Returns:

the typeClass

setTypeClass

public void setTypeClass(Class<?> typeClass)

Parameters:

typeClass - the typeClass to set

isDefinition

public boolean isDefinition()

isGeneratedFact

public boolean isGeneratedFact()

getTypeTemplate

public FactTemplate getTypeTemplate()

Returns:

the typeTemplate

setTypeTemplate

public void setTypeTemplate(FactTemplate typeTemplate)

Parameters:

typeTemplate - the typeTemplate to set

matches

public boolean matches(Object clazz)

Returns true if the given parameter matches this type declaration

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getDurationExtractor

public InternalReadAccessor getDurationExtractor()

setDurationExtractor

public void setDurationExtractor(InternalReadAccessor durationExtractor)

getTypeClassDef

public ClassDefinition getTypeClassDef()

Returns:

the typeClassDef

setTypeClassDef

public void setTypeClassDef(ClassDefinition typeClassDef)

Parameters:

typeClassDef - the typeClassDef to set

getTimestampExtractor

public InternalReadAccessor getTimestampExtractor()

setTimestampExtractor

public void setTimestampExtractor(InternalReadAccessor timestampExtractor)

getResource

public org.kie.api.io.Resource getResource()

setResource

public void setResource(org.kie.api.io.Resource resource)

getObjectType

public ObjectType getObjectType()

getExpirationOffset

public long getExpirationOffset()

setExpirationOffset

public void setExpirationOffset(long expirationOffset)

getExpirationPolicy

public org.kie.api.definition.type.Expires.Policy getExpirationPolicy()

setExpirationType

public void setExpirationType(org.kie.api.definition.type.Expires.Policy expirationPolicy)

getTypeClassName

public String getTypeClassName()

setTypeClassName

public void setTypeClassName(String typeClassName)

isJavaBased

public boolean isJavaBased()

isDynamic

public boolean isDynamic()

setDynamic

public void setDynamic(boolean dynamic)

isTypesafe

public boolean isTypesafe()

setTypesafe

public void setTypesafe(boolean typesafe)

isPropertyReactive

public boolean isPropertyReactive()

setPropertyReactive

public void setPropertyReactive(boolean propertyReactive)

isNovel

public boolean isNovel()

setNovel

public void setNovel(boolean novel)

getAccessibleProperties

public List<String> getAccessibleProperties()

toString

public String toString()

Overrides:

toString in class Object

getKnowledgeType

public org.kie.api.definition.KieDefinition.KnowledgeType getKnowledgeType()

Specified by:

getKnowledgeType in interface org.kie.api.definition.KieDefinition

getNamespace

public String getNamespace()

Specified by:

getNamespace in interface org.kie.api.definition.KieDefinition

getFullName

public String getFullName()

getId

public String getId()

Specified by:

getId in interface org.kie.api.definition.KieDefinition

getOrder

public int getOrder()

setOrder

public void setOrder(int order)

compareTo

public int compareTo(TypeDeclaration o)

Specified by:

compareTo in interface Comparable<TypeDeclaration>

createTypeDeclarationForBean

public static TypeDeclaration createTypeDeclarationForBean(Class<?> cls)

createTypeDeclarationForBean

public static TypeDeclaration createTypeDeclarationForBean(Class<?> cls,
                                                           org.kie.internal.builder.conf.PropertySpecificOption propertySpecificOption)

createTypeDeclarationForBean

public static TypeDeclaration createTypeDeclarationForBean(Class<?> cls,
                                                           Annotated annotated,
                                                           org.kie.internal.builder.conf.PropertySpecificOption propertySpecificOption)

processTypeAnnotations

public static void processTypeAnnotations(TypeDeclaration type,
                                          Annotated annotated,
                                          org.kie.internal.builder.conf.PropertySpecificOption propertySpecificOption)