com.tibco.xp.runtime

Class Concept

java.lang.Object

com.tibco.xp.runtime.Entity

com.tibco.xp.runtime.Concept

All Implemented Interfaces:

java.io.Serializable

@Managed
public abstract class Concept
extends Entity

Concept base class

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Concept.LookupType Lookup operation type - unique, or not.

Field Summary

Fields inherited from class com.tibco.xp.runtime.Entity

INVALID_TYPE_IDENTIFIER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Concept() Java constructor
protected	Concept(long id) Rule or Rule Function constructor

Method Summary

Modifier and Type	Method and Description
void	assertConcept() Assert a concept and start a run-to-completion cycle.
void	assertConceptWithoutRunToCompletion() Assert a concept, but do not start a run-to-completion cycle.
protected static java.lang.Integer	cardinality(java.lang.Class<?> klass, java.lang.String keyName, java.util.HashMap<java.lang.String,java.lang.Object> keyFields) Determine the cardinality of the specified query
protected long	getParent() Get the parent identifier for a contained type
protected static java.lang.Object	lookupQuery(java.lang.Class<?> klass, java.lang.String keyName, java.lang.String lockMode, Concept.LookupType lookupType, java.lang.String direction, java.util.HashMap<java.lang.String,java.lang.Object> keyFields) Execute a query.
static LockMode	mapLockMode(java.lang.String lockMode) Map the lock mode value
protected static KeyOrderedBy	mapOrderBy(java.lang.String direction) Map the order-by direction
static com.tibco.cep.runtime.model.element.Concept	refresh(com.tibco.cep.runtime.model.element.Concept original) Refresh the concept
static void	refreshArray(com.tibco.cep.runtime.model.element.Concept[] concepts) Refresh an array of concepts
protected void	setParent(long parent) Set the parent identifier for a contained type
protected boolean[]	toPrimitiveArray(java.lang.Boolean[] a) Map auto-box array to primitive array
protected java.util.Date[]	toPrimitiveArray(java.util.Date[] a) Map auto-box array to primitive array
protected double[]	toPrimitiveArray(java.lang.Double[] a) Map auto-box array to primitive array
protected int[]	toPrimitiveArray(java.lang.Integer[] a) Map auto-box array to primitive array
protected long[]	toPrimitiveArray(java.lang.Long[] a) Map auto-box array to primitive array
protected java.lang.String[]	toPrimitiveArray(java.lang.String[] a) Map auto-box array to primitive array
java.lang.String	toString()
static void	update(com.tibco.cep.runtime.model.element.Concept concept) Update a concept in shared memory
static void	updateArray(com.tibco.cep.runtime.model.element.Concept[] concepts) Update an array of concepts

Methods inherited from class com.tibco.xp.runtime.Entity

assertEntity, checkActive, getExtId, getHandle, getHandle, getId, load, mapArray, mapHandle, mapHandleArray, register

Methods inherited from class java.lang.Object

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

Constructor Detail

Concept

protected Concept()

Java constructor

Concept

protected Concept(long id)

Rule or Rule Function constructor

Parameters:

id - Unique identifier

Method Detail

assertConcept

public final void assertConcept()
                         throws ObjectNotUniqueError,
                                ResourceUnavailableException

Assert a concept and start a run-to-completion cycle.

This starts a new run-to-completion (RTC) cycle. A new transaction is started if one is not already active. The RTC cycle is complete when this method returns. RETE working memory is cleared at the end of the RTC cycle.

If the concept was previously loaded into working memory this method quietly does nothing.

Throws:

ObjectNotUniqueError - Duplicate external identifier

ResourceUnavailableException - Rules engine not running

assertConceptWithoutRunToCompletion

public final void assertConceptWithoutRunToCompletion()
                                               throws ObjectNotUniqueError,
                                                      ResourceUnavailableException

Assert a concept, but do not start a run-to-completion cycle.

Assert a concept into the RETE, but do not start a run-to-completion cycle.

If the concept was previously loaded into working memory this method quietly does nothing.

Throws:

ObjectNotUniqueError - Duplicate external identifier

ResourceUnavailableException - Rules engine not running

toString

public java.lang.String toString()

Overrides:

toString in class Entity

lookupQuery

protected static java.lang.Object lookupQuery(java.lang.Class<?> klass,
                                              java.lang.String keyName,
                                              java.lang.String lockMode,
                                              Concept.LookupType lookupType,
                                              java.lang.String direction,
                                              java.util.HashMap<java.lang.String,java.lang.Object> keyFields)

Execute a query.

Unique queries return a concept or, null if not found. The concept is added to working memory in the current RTC.

Non-unique or ordered queries return an iterator. Concepts returned in the iterator or not added to working memory in the current RTC until they are accessed via the returned iterator.

Parameters:

klass - Concept class.

keyName - Key name.

lockMode - The lock mode to use when performing the query.

lookupType - Specify whether this is a unique or non-unique query.

direction - Ordering for non-unique queries.

keyFields - Query key fields.

Returns:

A concept for a unique query or null, if not found. An iterator for a non-unique query.

cardinality

protected static java.lang.Integer cardinality(java.lang.Class<?> klass,
                                               java.lang.String keyName,
                                               java.util.HashMap<java.lang.String,java.lang.Object> keyFields)

Determine the cardinality of the specified query

Parameters:

klass - Concept class

keyName - Key name

keyFields - Key fields

Returns:

The cardinality for the specified key and values.

mapLockMode

public static LockMode mapLockMode(java.lang.String lockMode)

Map the lock mode value

Parameters:

lockMode - User provided lock mode value

Returns:

Mapped lock mode

A user provided lockMode value of read is mapped to a READLOCK.

A user provided lockMode value of write is mapped to WRITELOCK

All other values are mapped to NOLOCK.

mapOrderBy

protected static KeyOrderedBy mapOrderBy(java.lang.String direction)

Map the order-by direction

Parameters:

direction - User provided order-by direction

Returns:

Mapped order-by direction

A user provided direction value of descending is mapped to a DESCENDING.

All other values are mapped to ASCENDING.

refresh

public static com.tibco.cep.runtime.model.element.Concept refresh(com.tibco.cep.runtime.model.element.Concept original)

Refresh the concept

Concept values are refreshed from shared memory.

Parameters:

original - Concept to refresh.

Returns:

Refreshed concept. May be null.

refreshArray

public static void refreshArray(com.tibco.cep.runtime.model.element.Concept[] concepts)

Refresh an array of concepts

All concepts in the array are refreshed from shared memory

Parameters:

concepts - Concept array to refresh

update

public static void update(com.tibco.cep.runtime.model.element.Concept concept)

Update a concept in shared memory

Flush concepts to shared memory

Parameters:

concept - Concept to flush to shared memory.

updateArray

public static void updateArray(com.tibco.cep.runtime.model.element.Concept[] concepts)

Update an array of concepts

All concepts in the array are updated in shared memory if they have been modified in the current RTC.

Parameters:

concepts - Concept array to update

setParent

protected final void setParent(long parent)

Set the parent identifier for a contained type

Parameters:

parent - Parent identifier

getParent

protected final long getParent()

Get the parent identifier for a contained type

Returns:

Parent identifier;

toPrimitiveArray

protected final long[] toPrimitiveArray(java.lang.Long[] a)

Map auto-box array to primitive array

Parameters:

a - Array to map

Returns:

Mapped array

toPrimitiveArray

protected final int[] toPrimitiveArray(java.lang.Integer[] a)

Map auto-box array to primitive array

Parameters:

a - Array to map

Returns:

Mapped array

toPrimitiveArray

protected final boolean[] toPrimitiveArray(java.lang.Boolean[] a)

Map auto-box array to primitive array

Parameters:

a - Array to map

Returns:

Mapped array

toPrimitiveArray

protected final double[] toPrimitiveArray(java.lang.Double[] a)

Map auto-box array to primitive array

Parameters:

a - Array to map

Returns:

Mapped array

toPrimitiveArray

protected final java.lang.String[] toPrimitiveArray(java.lang.String[] a)

Map auto-box array to primitive array

Parameters:

a - Array to map

Returns:

Mapped array

toPrimitiveArray

protected final java.util.Date[] toPrimitiveArray(java.util.Date[] a)

Map auto-box array to primitive array

Parameters:

a - Array to map

Returns:

Mapped array