Package org.drools.base.rule

Class Declaration

java.lang.Object

org.drools.base.rule.Declaration

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, AcceptsReadAccessor, TupleValueExtractor

public class Declaration
extends java.lang.Object
implements java.io.Externalizable, AcceptsReadAccessor, TupleValueExtractor

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Declaration()
Declaration(java.lang.String identifier, ReadAccessor extractor, Pattern pattern)	Construct.
Declaration(java.lang.String identifier, ReadAccessor extractor, Pattern pattern, boolean internalFact)
Declaration(java.lang.String identifier, Pattern pattern)	Construct.

Method Summary

Modifier and Type	Method	Description
Declaration	clone()
Declaration	cloneWithPattern(Pattern pattern)
boolean	equals(java.lang.Object object)
java.lang.String	getBindingName()
boolean	getBooleanValue(ValueResolver valueResolver, java.lang.Object object)
java.lang.String	getBoxedTypeName()
byte	getByteValue(ValueResolver valueResolver, java.lang.Object object)
char	getCharValue(ValueResolver valueResolver, java.lang.Object object)
java.lang.Class<?>	getDeclarationClass()
double	getDoubleValue(ValueResolver valueResolver, java.lang.Object object)
ReadAccessor	getExtractor()	Returns the Extractor expression
float	getFloatValue(ValueResolver valueResolver, java.lang.Object object)
int	getHashCode(ValueResolver valueResolver, java.lang.Object object)
java.lang.String	getIdentifier()	Retrieve the variable's identifier.
int	getIntValue(ValueResolver valueResolver, java.lang.Object object)
long	getLongValue(ValueResolver valueResolver, java.lang.Object object)
java.lang.reflect.Method	getNativeReadMethod()
java.lang.String	getNativeReadMethodName()
int	getObjectIndex()
Pattern	getPattern()	Returns the index of the pattern
short	getShortValue(ValueResolver valueResolver, java.lang.Object object)
int	getTupleIndex()
java.lang.String	getTypeName()
java.lang.Object	getValue(ValueResolver valueResolver, java.lang.Object object)
java.lang.Object	getValue(ValueResolver valueResolver, BaseTuple tuple)
java.lang.Object	getValue(ValueResolver valueResolver, org.kie.api.runtime.rule.FactHandle fh)
ValueType	getValueType()	Retrieve the ValueType.
int	getxPathOffset()
int	hashCode()
boolean	isFromXpathChunk()
boolean	isGlobal()
boolean	isInternalFact()
boolean	isPatternDeclaration()	Returns true if this declaration is a pattern declaration
void	readExternal(java.io.ObjectInput in)
void	setBindingName(java.lang.String bindingName)
void	setDeclarationClass(java.lang.Class<?> declarationClass)
void	setPattern(Pattern pattern)
void	setReadAccessor(ReadAccessor readAccessor)
void	setxPathOffset(int xPathOffset)
java.lang.String	toString()
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.drools.base.rule.accessor.TupleValueExtractor

getValue

Constructor Detail

Declaration

public Declaration()

Declaration

public Declaration(java.lang.String identifier,
                   Pattern pattern)

Construct.

Parameters:

identifier - The name of the variable.

pattern - The pattern this variable is declared in

Declaration

public Declaration(java.lang.String identifier,
                   ReadAccessor extractor,
                   Pattern pattern)

Construct.

Parameters:

identifier - The name of the variable.

extractor - The extractor for this variable

pattern - The pattern this variable is declared in

Declaration

public Declaration(java.lang.String identifier,
                   ReadAccessor extractor,
                   Pattern pattern,
                   boolean internalFact)

Parameters:

identifier - The name of the variable.

identifier - The name of the variable.

extractor - The extractor for this variable

internalFact - True if this is an internal fact created by the engine, like a collection result of a collect CE

Method Detail

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

getIdentifier

public java.lang.String getIdentifier()

Retrieve the variable's identifier.

Returns:

The variable's identifier.

getBindingName

public java.lang.String getBindingName()

setBindingName

public void setBindingName(java.lang.String bindingName)

getValueType

public ValueType getValueType()

Retrieve the ValueType.

Specified by:

getValueType in interface TupleValueExtractor

Returns:

The ValueType.

getPattern

public Pattern getPattern()

Returns the index of the pattern

Returns:

the pattern

setPattern

public void setPattern(Pattern pattern)

getObjectIndex

public int getObjectIndex()

getTupleIndex

public int getTupleIndex()

setxPathOffset

public void setxPathOffset(int xPathOffset)

getxPathOffset

public int getxPathOffset()

isFromXpathChunk

public boolean isFromXpathChunk()

isPatternDeclaration

public boolean isPatternDeclaration()

Returns true if this declaration is a pattern declaration

setReadAccessor

public void setReadAccessor(ReadAccessor readAccessor)

Specified by:

setReadAccessor in interface AcceptsReadAccessor

getExtractor

public ReadAccessor getExtractor()

Returns the Extractor expression

getDeclarationClass

public java.lang.Class<?> getDeclarationClass()

setDeclarationClass

public void setDeclarationClass(java.lang.Class<?> declarationClass)

getValue

public java.lang.Object getValue(ValueResolver valueResolver,
                                 BaseTuple tuple)

Specified by:

getValue in interface TupleValueExtractor

getValue

public java.lang.Object getValue(ValueResolver valueResolver,
                                 org.kie.api.runtime.rule.FactHandle fh)

getValue

public java.lang.Object getValue(ValueResolver valueResolver,
                                 java.lang.Object object)

getCharValue

public char getCharValue(ValueResolver valueResolver,
                         java.lang.Object object)

getIntValue

public int getIntValue(ValueResolver valueResolver,
                       java.lang.Object object)

getByteValue

public byte getByteValue(ValueResolver valueResolver,
                         java.lang.Object object)

getShortValue

public short getShortValue(ValueResolver valueResolver,
                           java.lang.Object object)

getLongValue

public long getLongValue(ValueResolver valueResolver,
                         java.lang.Object object)

getFloatValue

public float getFloatValue(ValueResolver valueResolver,
                           java.lang.Object object)

getDoubleValue

public double getDoubleValue(ValueResolver valueResolver,
                             java.lang.Object object)

getBooleanValue

public boolean getBooleanValue(ValueResolver valueResolver,
                               java.lang.Object object)

getHashCode

public int getHashCode(ValueResolver valueResolver,
                       java.lang.Object object)

isGlobal

public boolean isGlobal()

getNativeReadMethod

public java.lang.reflect.Method getNativeReadMethod()

getNativeReadMethodName

public java.lang.String getNativeReadMethodName()

getTypeName

public java.lang.String getTypeName()

getBoxedTypeName

public java.lang.String getBoxedTypeName()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

isInternalFact

public boolean isInternalFact()

clone

public Declaration clone()

Specified by:

clone in interface TupleValueExtractor

Overrides:

clone in class java.lang.Object

cloneWithPattern

public Declaration cloneWithPattern(Pattern pattern)